logo
logo
请输入关键词搜索产品或者文档

热门搜索

中国

中国站

创蓝云智

国际站

Innopaas

首页国内语音消息API接口

API接口

更新时间：2026-07-08T16:01:49

一、 国内语音消息

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

1.1 协议说明

名称说明
协议HTTPS POST
编码格式UTF8
返回类型application/json
URLhttps://api.253.com/open/notify/batch-voice-notify

1.2 请求参数

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

参数名参数类型是否必传说明
appIdString是请在官网登录后获取 ，详情请看,功能介绍->接口详情
appKeyString是请在官网登录后获取 ，详情请看,功能介绍->接口详情
mobileString是被叫号码，模版无变量多个则以英文半角分号“;”分割；模板带变量，多个号码以英文分号“;”分割，号码和变量以英文逗号“,”隔开， 多个变量以竖线“|”隔开，如 130XXXXXXXX,123|456;186XXXXXXXX,321|654 （批量号码上限10000个）。如果带短信变量，则用“#”隔开,多个短信变量以竖线“|”隔开，如，130XXXXXXXX#123|456;186XXXXXXXX#321|654，如果语音变量和短信变量都有，则：130XXXXXXXX,123|456#321|654;150XXXXXXXX,123|456#321|654
templateIdString是文字模版 Id，官网控制台创建后产生，且已审核通过
billUrlString否话单推送回调地址 （最大长度250）
transDataString否透传数据(话单推送回调时返回 最大长度50)
displayNumString否主叫号码，由运营提供，未提供的则不需要传
isNotifyFileIdString否模版类型，0:TTS模版，1:录音文件模版，默认为0
smsHangupStatusString否挂机短信开启标识 0：关闭，1：开启，默认：关闭
smsTemplateIdString否挂机短信模板id
smsSendTypeString否挂机短信发送方式：0:接通后发送，1:全部群发，2:未接通发送，3:按接通时长发送，默认:0
smsSendLimitString否当挂机短信方式为3时必填，单位秒，输入时间规则为大于等于x后发送挂机短信（整数输入大于等于1）
sendTypeString否任务发送类型 1-定时任务2-即时任务,不传为即时任务
taskStartTimeString否任务开始时间，yyyyMMddHHmmss，eg:20200902170000
taskEndTimeString否任务结束时间，yyyyMMddHHmmss，eg:20200902235959
taskNameString否任务名称
maxRecallCountString否最大重拨次数，只能0或1，0不重拨，默认：1 重拨1次
recallIntervalString否重拨间隔时长（分钟），只能1-2880，默认值60，最大重拨次数大于0时必传(注意：recallInterval的“llI”分别是小写的LL和大写的i
noConnectedString否重拨策略：被叫无法接通,true:重拨;false:不重拨,默认值:true
noAnswerString否重拨策略：被叫无人接听,true:重拨;false:不重拨,默认值:true
fmsStatusString否闪信状态：0：关闭，1：开启
fmsTemplateIdString否闪信模版Id

1.4 返回参数

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

1.5 返回数据示例（成功）

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

1.6 返回数据示例（失败）

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

二、 国内语音消息模板创建

2.1 版本说明

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

2.2 协议说明

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

2.3 请求参数

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

参数名参数类型是否必传参数说明
appIdString是应用id
appKeyString是应用key
templateNameString是模板名称，当contentType为2时需 传入英文的语音文件名，以.mp3/.wav结尾。
templateContentString否模板内容 （内容与模板变量组合长度小于300 变量模板用“{n}”作为占位符 变量n大于等于0 小于等于9 例如：“你好，我是{1}，今天下午{2}时将上门取快递”）
templateTypeString是模板类型：1、国内语音消息 8 视频外呼
contentTypeString否文本类型：1、文字模板 2、语音文件 不传的情况下默认为1，即文字模板，此时templateName以及templateContent必传 传2时 templateName以及fileCode必传
fileCodeString否模板语音内容文件(支持mp3、wav)的BSAE64编码

2.4 返回参数

参数名数据类型参数说明
codestring响应code码。200000：成功，其他失败。详见code码
messagestring响应code码解释
dataObject返回对象
templateIdstring模板id

2.5 返回数据示例（成功）

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

2.6 返回数据示例（失败）

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

三、 语音消息模板查询

3.1 版本说明

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

3.2 协议说明

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

3.3 请求参数

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

参数名参数类型是否必传参数说明
appIdString是应用id
appKeyString是应用key
startDateString否开始时间 (eg:2021-12-06)
endDateString否结束时间 (eg:2021-12-07)
pageString是当前页
sizeString是当前页面条数 （上限1000条）
templateTypeString否模板类型：1、国内语音消息 ，8、视频外呼
templateIdString否查询模板id

3.4 返回参数

参数名数据类型参数说明
codestring响应code码。200000：成功，其他失败。详见code码
messagestring响应code码解释
dataObject返回对象
data>>pageNumint当前页码
data>>pageSizeint每页个数
data>>sizeint当前页个数
data>>startRowint由第几条开始
data>>endRowint到第几条结束
data>>pagesint总页数
data>>prePageint上一页
data>>nextPageint下一页
data>>isFirstPageboolean是否为首页
data>>isLastPageboolean是否为尾页
data>>hasPreviousPageboolean是否有上一页
data>>hasNextPageboolean是否有下一页
data>>navigatePagesint每页显示的页码个数
data>>navigatepageNumsArray导航页码数
data>>navigateFirstPageint首页
data>>navigateLastPageint尾页
data>>totalint总条数
data>>listList数据集合
data>>list>>templateTypestring模板类型：1-普通模板 8-视频外呼
data>>list>>templateRemarkstring模板审核意见
data>>list>>templateNamestring模板名称
data>>list>>updateTimestring更新时间
data>>list>>templateIdstring模板id
data>>list>>templateCodestring模板审核状态码（0-审核中 1-通过审核 2-审核失败）
data>>list>>templateStatestring模板审核状态描述
data>>list>>contentstring模板内容

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": "2021-11-30 22:01",
                                "templateId": "412*****32",
                                "templateCode":"2",
                                "templateState": "审核通过",
                                "content": "今天是{1}年{2}月{3}日。"
                        },
                        {
                                "templateType": "2",
                                "templateRemark": "",
                                "templateName": "测试模板",
                                "updateTime": "2021-11-02 00:07",
                                "templateId": "21*****396",
                                "templateCode":"2",
                                "templateState": "审核通过",
                                "content": "您的快递已送达，请接收。"
                        }
                ]
        },
        "code": "200000"
}

四、 消息状态报告推送

4.1 版本说明

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

4.2 推送格式说明

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

4.3 请求参数

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

参数名参数类型是否必传参数说明
callIdString是调用ID号，每次调用生成唯一的ID号
callDescString是通话结束原因状态码 详见code码
callDescMsgString是通话结束原因状态码描述
callStatusString是呼叫结果 0-成功 1-失败
mobileString是被叫号码
startTimeString是开始呼叫时间，毫秒级时间戳
callTimeString是通话时长(s)
transDataString是透传数据
hangupCauseString是线路挂断原因
invokeTimeString是线路调用时间，毫秒级时间戳
ringTimeString是振铃时间，毫秒级时间戳
answerTimeString是接听时间，毫秒级时间戳
byeTimeString是挂断时间，毫秒级时间戳

4.4 建议返回结果（成功）

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

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

五、 查询话单

5.1 版本说明

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

5.2 协议说明

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

5.3 请求参数

参数名参数类型是否必传参数说明
appIdString是应用id
appKeyString是应用key
pageString是页码
sizeString是分页大小（最大100）
mobileString否被叫号码
messageTypeString是查询的话单类型 1 语音验证码 2 国内语音消息 8 视频外呼
templateIdString否模板id
taskIdString否任务id（批量接口查询使用 批量API接口返回的callid）
batchNoString否批次号（单条接口查询使用 单条API接口返回的callid）
startDateString是开始调用时间（yyyy-MM-dd HH:mm:ss）(支持查最近90天)
endDateString否结束调用时间（yyyy-MM-dd HH:mm:ss）

5.4 返回参数

参数名数据类型参数说明
codestring响应code码。200000：成功，其他失败。详见code码
messagestring响应code码解释
dataObject返回对象
data>>totalint查询总数
data>>pageSizeint每页个数
data>>pageNumint页码
data>>listList话单数据
data>>list>>callIdstring回调的callid
data>>list>>callDescstring错误码
data>>list>>callDescMsgstring错误描述
data>>list>>mobilestring被叫号码
data>>list>>templateIdstring模板id
data>>list>>callStatestring呼叫状态 0成功 1失败 2未知（空值表示本次通话在进行中
data>>list>>smsStatusstring挂机短信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败
data>>list>>smsSendTimestring挂机短信发送时间 13位时间戳
data>>list>>fmsStatusstring闪信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败
data>>list>>recallCountstring当前号码第几次呼叫，1：第一次呼叫，2：第二次呼叫
data>>list>>hangupCauseString线路挂断原因

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": "1",
                "fmsStatus": "1",
                "fmsSendStatus": "DELIVRD",
                "hangupCause":"NORMAL_TEMPORARY_FAILURE/recv_refuse"
            },
            {
                "callId": "YYTZ1128********63553",
                "callDesc": "0",
                "mobile": "159*****182",
                "templateId": "1113********40",
                "callState": "1",
                "recallCount": "0",
                "callDescMsg": "未规定",
                "smsStatus": "0",
                "invokeTime": "1689****0877",
                "fmsStatus": "0",
                "fmsSendStatus": "",
                "hangupCause":"NORMAL_TEMPORARY_FAILURE/recv_refuse"
            }
        ],
        "pageNum": 2
    },
    "code": "200000"
}

六、 查询主叫

6.1 版本说明

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

6.2 协议说明

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

6.3 请求参数

参数名参数类型是否必传参数说明
appIdString是应用id
appKeyString是应用key
messageTypeString是查询的主叫类型 2 国内语音消息

6.4 返回参数

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

6.5 返回数据示例（成功）

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

七、 查询挂机短信模板

7.1 版本说明

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

7.2 协议说明

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

7.3 请求参数

参数名参数类型是否必传参数说明
appIdString是应用id
appKeyString是应用key
pageString是页码
sizeString是分页大小（最大1000）
smsTemplateIdString否挂机短信模板id
smsTemplateStateString否挂机短信模板审核状态 0-审核中 1-通过审核 2-审核失败
smsTemplateActionString否挂机短信标签
smsTemplateTypeString否模板类型（默认全部 1 挂机短信，2 视频短信， 3 闪信）
startDateString是开始调用时间（yyyy-MM-dd HH:mm:ss）
endDateString否结束调用时间（yyyy-MM-dd HH:mm:ss）

7.4 返回参数

参数名数据类型参数说明
codestring响应code码。200000：成功，其他失败。详见code码
messagestring响应code码解释
dataObject返回对象
data>>totalint查询总数
data>>pageSizeint每页个数
data>>pageNumint页码
data>>listList模板数据
data>>list>>smsTemplateStatestring模板审核状态 0-审核中 1-通过审核 2-审核失败
data>>list>>createTimestring模板创建时间 13位时间戳
data>>list>>smsTemplateNamestring模板名称
data>>list>>smsTemplateIdstring模板ID
data>>list>>auditRemarkstring审核评论
data>>list>>smsTemplateContentstring模板内容
data>>list>>signstring模板签名
data>>list>>smsTypestring1 挂机短信 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"
}
没有更多了
没有上一篇
没有下一篇
文档目录
收缩
24小时热线 400-9669-253
云通信推荐
国内短信
国际短信
视频短信
语音消息
短信LOGO认证
API&SDK推荐
一键登录
活体检测SDK
行为验证码
图片OCR
智能短链
生态资源
开发者中心
创蓝社区
积分商城
关于我们
关于我们
加入我们
智慧党建
公司动态
logo

中国总部：上海市松江区广富林东路199号4栋

24小时热线：400-9669-253
微信

创蓝公众号

企业微信

联系商务

上海 | 新加坡 | 北京 | 迪拜 | 深圳 | 雅加达 | 成都 | 胡志明 | 南京 | 墨西哥城 | 香港 | 长沙 | 拉各斯等城市
上海创蓝云智信息科技股份有限公司版权所有Copyright © 2026 ALL RIGHTS RESERVED
增值电信业务经营许可证：B2-20144076沪ICP备15046301号-16创蓝云智沪公网安备 31011702001190号、31011702008034号创蓝云智