API接口

更新时间：2025-04-25 16:50:02

一、语音营销API

1.1 版本说明

日期	版本	修订内容摘要
2023-08-24	v1.0.0	更新接口文档

1.2 协议说明

名称	说明
接口名称	语音营销
URL	https://api.253.com/open/market/voice-marketing
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

1.3 请求参数

数据提交方式：x-www-form-urlencoded

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id，详情请看,功能介绍->接口详情
appKey	String	是	应用key，功能介绍->接口详情
mobile	String	是	被叫号码，模版无变量多个则以英文半角分号“;”分割；模板带变量，多个号码以英文分号“;”分割，号码和变量以英文逗号“,”隔开，多个变量以竖线“\|”隔开，如 130XXXXXXXX,123\|456;186XXXXXXXX,321\|654 （批量号码上限1000个）
templateId	String	是	文字模版Id，官网控制台创建后产生，且已审核通过
billUrl	String	否	话单推送回调地址（最大长度250）
transData	String	否	透传数据(话单推送回调时返回) （最大长度50）
displayNum	String	否	主叫号码，由运营提供，未提供的则不需要传
isNotifyFileId	String	否	模版类型，0:TTS模版，1:录音文件模版，默认为0
sendType	String	否	任务发送类型 1-定时任务2-即时任务,不传为即时任务
taskStartTime	String	否	任务开始时间，yyyyMMddHHmmss，eg:20200902170000
taskEndTime	String	否	任务结束时间，yyyyMMddHHmmss，eg:20200902235959
taskName	String	否	任务名称
maxRecallCount	String	否	最大重拨次数，只能0-3，默认值0
recallInterval	String	否	重拨间隔时长（分钟），只能1-360，默认值60，最大重拨次数大于0时必传
noConnected	String	否	重拨策略：被叫无法接通,true:重拨;false:不重拨,默认值:true
noAnswer	String	否	重拨策略：被叫无人接听,true:重拨;false:不重拨,默认值:true

请求示例：

复制成功
{
	"appId": "*****",
	"appKey": "*****,
	"mobile": "176***5202,张同学|111;186***5203,王同学|222"
	"templateId": "12***81",
	"allowedCallTime": "",
	"billUrl": "http://****/voice/test/test3",
	"transData": "23***6",
	"isNotifyFileId": "",
	"smsHangupStatus": "1",
	"smsTemplateId": "1***98",
	"displayNum": "",
	"sendType": "1",
	"taskStartTime": "2023******1800",
	"taskEndTime": "2023******800",
	"taskName": "接口示例",
	"maxRecallCount": "3",
	"recallInterval": "3",
	"noConnected": "true",
	"noAnswer": "true"
}

1.4 返回参数

参数名	数据类型	参数说明
code	String	响应code码。200000：成功，其他失败。详见code码
message	String	响应code码解释
data	Object	返回对象
callId	String	呼叫唯一标识Id

1.5 返回数据示例（成功）

复制成功
{
    "message": "请求成功",
    "data": {
        "callId": "YYYX931*****564224"
    },
    "code": "200000"
}

1.6 返回数据示例（失败）

复制成功
{
    "message": "系统异常",
    "code": "500000"
}

二、语音营销模板创建

2.1 版本说明

日期	版本	修订内容摘要
2023-08-24	v1.0.0	更新接口文档

2.2 协议说明

名称	说明
接口名称	语音营销模板创建
URL	https://api.253.com/data/dgtemplate/createTemplate
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

2.3 请求参数

数据提交方式：x-www-form-urlencoded

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
templateName	String	是	模板名称，当contentType为2时需传入英文的语音文件名，以.mp3/.wav结尾。
templateContent	String	否	模板内容（模板与变量合计长度不超过200）
templateType	String	是	模板类型：1、语音通知，2、语音营销
contentType	String	否	文本类型：1、文字模板 2、语音文件不传的情况下默认为1，即文字模板，此时templateName以及templateContent必传传2时 templateName以及fileCode必传
fileCode	String	否	模板语音内容文件(支持mp3、wav)的BSAE64编码

2.4 返回参数

参数名	数据类型	参数说明
code	String	响应code码。200000：成功，其他失败。详见code码
message	String	响应code码解释
data	Object	返回对象
templateId	string	模板id

2.5 返回数据示例（成功）

复制成功
{
    "message":"请求成功",
    "data":{
        "data":{
            "templateId":"4**237"
        }
    },
    "code":"200000"
}

2.6 返回数据示例（失败）

复制成功
{
    "message": "系统异常",
    "code": "500000"
}

三、语音营销模板查询

3.1 版本说明

日期	版本	修订内容摘要
2023-08-24	v1.0.0	更新接口文档

3.2 协议说明

名称	说明
接口名称	语音营销模板创建
URL	https://api.253.com/data/dgtemplate/getTemplateList
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

3.3 请求参数

数据提交方式：x-www-form-urlencoded

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
startDate	String	否	开始时间 (eg:2021-12-06)
endDate	String	否	结束时间 (eg:2021-12-07)
page	String	是	当前页
size	String	否	当前页面条数（上限1000条）
templateType	String	否	模板类型：1、语音通知，2、语音营销
templateId	String	否	查询模板id

3.4 返回参数

参数名	数据类型	参数说明
code	String	响应code码。200000：成功，其他失败。详见code码
message	String	响应code码解释
data	Object	返回对象
data>>pageNum	int	当前页码
data>>pageSize	int	每页个数
data>>size	int	当前页个数
data>>startRow	int	由第几条开始
data>>endRow	int	到第几条结束
data>>pages	int	总页数
data>>prePage	int	上一页
data>>nextPage	int	下一页
data>>isFirstPage	boolean	是否为首页
data>>isLastPage	boolean	是否为尾页
data>>hasPreviousPage	boolean	是否有上一页
data>>hasNextPage	boolean	是否有下一页
data>>navigatePages	int	每页显示的页码个数
data>>navigatepageNums	Array	导航页码数
data>>navigateFirstPage	int	首页
data>>navigateLastPage	int	尾页
data>>total	int	总条数
data>>list	List	数据集合
data>>list>>templateType	string	模板类型
data>>list>>templateRemark	string	模板审核意见
data>>list>>templateName	string	模板名称
data>>list>>updateTime	string	更新时间
data>>list>>templateId	string	模板id
data>>list>>templateCode	string	模板审核状态码（0-审核中 1-通过审核 2-审核失败）
data>>list>>templateState	string	模板审核状态描述
data>>list>>content	string	模板内容

3.5 返回数据示例（成功）

复制成功
{
        "message": "请求成功",
        "data": {
                "pageNum": 1,
                "pageSize": 10,
                "size": 2,
                "startRow": 1,
                "endRow": 2,
                "pages": 1,
                "prePage": 0,
                "nextPage": 0,
                "isFirstPage": true,
                "isLastPage": true,
                "hasPreviousPage": false,
                "hasNextPage": false,
                "navigatePages": 8,
                "navigatepageNums": [
                        1
                ],
                "navigateFirstPage": 1,
                "navigateLastPage": 1,
                "total": 2,
                "list": [
                        {
                                "templateType": "2",
                                "templateRemark": "",
                                "templateName": "测试模板年月日",
                                "updateTime": "20**-11-30 22:01",
                                "templateId": "43**32",
                                "templateCode":"2",
                                "templateState": "审核通过",
                                "content": "今天是{1}年{2}月{3}日。"
                        },
                        {
                                "templateType": "2",
                                "templateRemark": "",
                                "templateName": "测试模板",
                                "updateTime": "20**-11-02 00:07",
                                "templateId": "2***36",
                                "templateCode":"2",
                                "templateState": "审核通过",
                                "content": "您的快递已送达，请接收。"
                        }
                ]
        },
        "code": "200000"
}

四、消息状态报告推送

4.1 版本说明

日期	版本	修订内容摘要
2023-08-24	v1.0.0	更新接口文档

4.2 推送格式说明

名称	说明
接口名称	消息状态报告推送
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

4.3 请求参数

数据回推方式：x-www-form-urlencoded

参数名	参数类型	是否必传	参数说明
callId	String	是	调用ID号，每次调用生成唯一的ID号
callDesc	String	是	通话结束原因状态码详见code码
callDescMsg	String	是	通话结束原因状态码描述
callStatus	String	是	呼叫结果 0-成功 1-失败
mobile	String	是	被叫号码
startTime	String	是	语音接听时间，毫秒级时间戳
callTime	String	是	通话时长(s)
transData	String	是	透传数据

4.4 建议返回结果（成功）

复制成功
{
    "message": "请求成功",
    "code": "200000"，
    "success": true
}

PS：话单推送是以通话维度进行的，一般在打完后就会回立即推送，有重拨的号码，话单会在拨打结束后再次推送，若没有收到话单，最长6个小时以后会统一进行话单推送。

五、查询话单

5.1 版本说明

日期	版本	修订内容摘要
2023-10-10	v1.0.0	更新接口文档

5.2 协议说明

名称	说明
接口名称	查询话单
URL	https://api.253.com/data/api/voiceMsg/queryVoiceRecord
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

5.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
page	String	是	页码
size	String	是	分页大小（最大100）
mobile	String	否	被叫号码
messageType	String	是	查询的话单类型 1 语音验证码 2 语音通知 3 语音营销
templateId	String	否	模板id
taskId	String	否	任务id（批量接口查询使用批量API接口返回的callid）
batchNo	String	否	批次号（单条接口查询使用单条API接口返回的callid）
startDate	String	是	开始调用时间（yyyy-MM-dd HH:mm:ss）(支持查最近90天)
endDate	String	否	结束调用时间（yyyy-MM-dd HH:mm:ss）

5.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>total	int	查询总数
data>>pageSize	int	每页个数
data>>pageNum	int	页码
data>>list	List	话单数据
data>>list>>callId	string	回调的callid
data>>list>>callDesc	string	错误码
data>>list>>callDescMsg	string	错误描述
data>>list>>mobile	string	被叫号码
data>>list>>templateId	string	模板id
data>>list>>callState	string	呼叫状态 0成功 1失败 2未知（空值表示本次通话在进行中
data>>list>>smsStatus	string	挂机短信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败
data>>list>>smsSendTime	string	挂机短信发送时间 13位时间戳
data>>list>>fmsStatus	string	闪信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败
data>>list>>id	string	话单唯一id

5.5 返回数据示例（成功）

复制成功
{
    "message": "请求成功",
    "data": {
        "total": 12,
        "pageSize": 10,
        "list": [
            {
                "callId": "YYTZ1128********79040",
                "callDesc": "0",
                "mobile": "159*****82",
                "templateId": "11134*****042240",
                "callState": "1",
                "recallCount": "0",
                "callDescMsg": "未规定",
                "smsStatus": "0",
                "invokeTime": "1689040342414",
                "fmsStatus": "1",
                "fmsSendStatus": "DELIVRD",
                "id": "112826********3280"
            },
            {
                "callId": "YYTZ1128********63553",
                "callDesc": "0",
                "mobile": "159*****182",
                "templateId": "1113********40",
                "callState": "1",
                "recallCount": "0",
                "callDescMsg": "未规定",
                "smsStatus": "0",
                "invokeTime": "1689****0877",
                "fmsStatus": "0",
                "fmsSendStatus": "",
                "id": "11282*******48"
            }
        ],
        "pageNum": 2
    },
    "code": "200000"
}

六、查询主叫

6.1 版本说明

日期	版本	修订内容摘要
2023-10-10	v1.0.0	更新接口文档

6.2 协议说明

名称	说明
接口名称	查询主叫
URL	https://api.253.com/data/api/voiceMsg/queryCaller
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

6.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
messageType	String	是	查询的主叫类型 2 语音通知 3 语音营销

6.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>caller	List	主叫号码（数组）

6.5 返回数据示例（成功）

复制成功
{
    "message": "请求成功",
    "data": {
        "caller":["85****95"]
    },
    "code": "200000"
}

七、查询挂机短信模板

7.1 版本说明

日期	版本	修订内容摘要
2023-10-10	v1.0.0	更新接口文档

7.2 协议说明

名称	说明
接口名称	查询挂机短信模板
URL	https://api.253.com/data/api/voiceMsg/querySmsTemplate
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

7.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
page	String	是	页码
size	String	是	分页大小（最大1000）
smsTemplateId	String	否	挂机短信模板id
smsTemplateState	String	否	挂机短信模板审核状态 0-审核中 1-通过审核 2-审核失败
smsTemplateAction	String	否	挂机短信标签
smsTemplateType	String	否	模板类型（默认全部 1 挂机短信， 3 闪信）
startDate	String	是	开始调用时间（yyyy-MM-dd HH:mm:ss）
endDate	String	否	结束调用时间（yyyy-MM-dd HH:mm:ss）

7.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>total	int	查询总数
data>>pageSize	int	每页个数
data>>pageNum	int	页码
data>>list	List	模板数据
data>>list>>smsTemplateState	string	模板审核状态 0-审核中 1-通过审核 2-审核失败
data>>list>>createTime	string	模板创建时间 13位时间戳
data>>list>>smsTemplateName	string	模板名称
data>>list>>smsTemplateId	string	模板ID
data>>list>>auditRemark	string	审核评论
data>>list>>smsTemplateContent	string	模板内容
data>>list>>sign	string	模板签名
data>>list>>smsType	string	1 挂机短信 2 视频短信 3 闪信

7.5 返回数据示例（成功）

复制成功
{
    "message": "请求成功",
    "data": {
        "total": 1,
        "pageSize": 10,
        "list": [
            {
                "smsTemplateState": "1",
                "createTime": "1689094655000",
                "smsTemplateName": "111*****1",
                "smsTemplateId": "1128******6608",
                "auditRemark": "",
                "smsTemplateContent": "你好，这是一个测试的示例短信，退订回T",
                "sign":"测试签名"，
                "smsType":"1"
            }
        ],
        "pageNum": 1
    },
    "code": "200000"
}

没有更多了

没有上一篇

下一篇：国内语音消息

文档目录

收缩

产品中心

联系我们

热门搜索

中国站

国际站

API接口

一、语音营销API

二、语音营销模板创建

三、语音营销模板查询

四、消息状态报告推送

五、查询话单

六、查询主叫

七、查询挂机短信模板

热门搜索

中国站

国际站

API接口

一、 语音营销API

二、 语音营销模板创建

三、 语音营销模板查询

四、 消息状态报告推送

五、 查询话单

六、 查询主叫

七、 查询挂机短信模板

一、语音营销API

二、语音营销模板创建

三、语音营销模板查询

四、消息状态报告推送

五、查询话单

六、查询主叫

七、查询挂机短信模板