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

中国站

创蓝云智

国际站

Innopaas

API接口

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

一、 国际语音消息

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

1.1 协议说明

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

1.2 请求参数

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

参数名参数类型是否必传说明
appIdString请在官网登录后获取 ,详情请看,功能介绍->接口详情
appKeyString请在官网登录后获取 ,详情请看,功能介绍->接口详情
mobileString被叫号码,模版无变量多个则以英文半角分号“;”分割;模板带变量,多个号码以英文分号“;”分割,号码和变量以英文逗号“,”隔开, 多个变量以竖线“|”隔开,如 86130XXXXXXXX,123|456;86186XXXXXXXX,321|654; 注意:号码需要自带国家码前缀,否者会被视为无效号码,单次最大1000个号码
countryCodeString国家码,国家的简称,例如,中国:CN
templateIdString语音模版Id,官网控制台创建后产生,且已审核通过
billUrlString话单推送回调地址 (最大长度250)
transDataString透传数据(话单推送回调时返回 最大长度50)
displayNumString主叫号码,由运营提供,未提供的则不需要传
smsHangupStatusString挂机短信开启标识 0:关闭,1:开启,默认:关闭
smsTemplateIdString挂机短信模板id
smsSendTypeString挂机短信发送方式:0:接通后发送,1:全部群发,2:未接通发送,3:按接通时长发送,默认:0
smsSendLimitString当挂机短信方式为3时必填,单位秒,输入时间规则为大于等于x后发送挂机短信(整数输入大于等于1)
sendTypeString任务发送类型 1-定时任务2-即时任务,不传为即时任务
taskStartTimeString任务开始时间,最长8天,yyyyMMddHHmmss,eg:20200902170000
taskEndTimeString任务结束时间,yyyyMMddHHmmss,eg:20200902235959
taskNameString任务名称
maxRecallCountString最大重拨次数,只能0-3,默认:1 重拨1次
recallIntervalString重拨间隔时长(分钟),默认值60,重播最长时间跨度3天,最大重拨次数大于0时必传
noConnectedString重拨策略:被叫无法接通,true:重拨;false:不重拨,默认值:true
noAnswerString重拨策略:被叫无人接听,true:重拨;false:不重拨,默认值:true
ttsVoiceString播放语种, 例如,美国:en-US,如果不传,则按国家对应的语言播放,参考附录:播放语种 (如果是录音模版,则不需要传此参数)

请求示例:

复制成功
{
	"appId": "*****",
	"appKey": "*****,
	"mobile": "86176***5202,张同学|111;86186***5203,王同学|222",
    "countryCode":"CN",
	"templateId": "123",
	"allowedCallTime": "",
	"billUrl": "http://****/voice/test/test3",
	"transData": "12****44",
	"smsHangupStatus": "1",
	"smsTemplateId": "4123***1",
    "smsSendType": "0",
    "smsSendLimit": "0",
	"displayNum": "",
	"sendType": "1",
	"taskStartTime": "20230909151800",
	"taskEndTime": "20230909231800",
	"taskName": "示例任务测试",
	"maxRecallCount": "3",
	"recallInterval": "3",
	"noConnected": "true",
	"noAnswer": "true",
   "ttsVoice": "en-US",
    
}

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 版本说明

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

2.2 协议说明

名称说明
接口名称国际语音消息模板创建
URLhttps://api.tig253.com/data/api/voiceMsg/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结尾。
countryCodeString国家码,国家的简称,例如,中国:CN
contentTypeString文本类型:1、文字模板 2、语音文件 不传的情况下默认为1,即文字模板,此时templateName以及templateContent必传 传2时 templateName以及file必传
templateContentString模板内容 (内容与模板变量组合长度小于200)
fileFile模板语音内容文件(支持mp3、wav)

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 版本说明

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

3.2 协议说明

名称说明
接口名称语音消息模板创建
URLhttps://api.tig253.com/data/api/voiceMsg/queryTemplateList
协议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、语音消息
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模板类型
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模板内容
data>>list>>contentUrlstring录音地址
data>>list>>countryNameZhstring中文国家名
data>>list>>countryCodestring国家码

3.5 返回数据示例(成功)

复制成功
{
    "message":"请求成功",
    "data":{
        "pageNum":1,
        "pageSize":10,
        "size":10,
        "startRow":1,
        "endRow":10,
        "pages":4,
        "prePage":0,
        "nextPage":2,
        "isFirstPage":true,
        "isLastPage":false,
        "hasPreviousPage":false,
        "hasNextPage":true,
        "navigatePages":8,
        "navigatepageNums":[
            1,
            2,
            3,
            4
        ],
        "navigateFirstPage":1,
        "navigateLastPage":4,
        "total":32,
        "list":[
            {
                "templateType":"1",
                "templateRemark":"漂亮",
                "updateTime":"2024-01-09 22:42",
                "countryNameZh":"荷兰",
                "templateCode":1,
                "templateState":"审核通过",
                "templateId":"6512681653197982143",
                "content":"Hallo.mp3 (220KB)",
                "contentUrl":"http://.mp3",
                "contentUrl":"http://xxxx.wav",
                "countryCode":"NL",
                "contentType":"2"
            },
            {
                "templateType":"1",
                "templateRemark":"",
                "updateTime":"2024-01-09 15:28",
                "countryNameZh":"美国",
                "templateCode":1,
                "templateState":"审核通过",
                "templateId":"1378577762545899173",
                "content":"英国荷兰2.wav (1576KB)",
                "contentUrl":"http://xxxx.wav",
                "templateName":"英文wav",
                "countryCode":"US",
                "contentType":"2"
            }
        ]
    },
    "code":"200000"
}

四、 消息状态报告推送

4.1 版本说明

日期版本修订内容摘要
2024-01-12v1.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透传数据
invokeTimeString线路调用时间,毫秒级时间戳
ringTimeString振铃时间,毫秒级时间戳
answerTimeString接听时间,毫秒级时间戳
byeTimeString挂断时间,毫秒级时间戳

4.4 建议返回结果(成功)

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

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

五、 查询话单

5.1 版本说明

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

5.2 协议说明

名称说明
接口名称查询话单
URLhttps://api.tig253.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)
countryCodeString国家码
mobileString被叫号码
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>>recallCountstring当前呼叫轮数(重播次数序号)
data>>list>>countryCodestring国家码
data>>list>>smsStatusstring挂机短信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败
data>>list>>invokeTimestring语音调用时间
data>>list>>smsSendTimestring挂机短信发送时间 13位时间戳
data>>list>>idstring话单唯一id
data>>list>>smsSendStatusstring短信发送状态
data>>list>>taskIdstring任务id

5.5 返回数据示例(成功)

复制成功
{
    "message":"请求成功",
    "data":{
        "total":101,
        "pageSize":10,
        "list":[
            {
                "callId":"GJYYXX7XXXXX",
                "callDesc":"999",
                "mobile":"86138XXXXX",
                "templateId":"7863XXXXX",
                "callState":"2",
                "recallCount":"1",
                "callDescMsg":"未知",
                "countryCode":"CN",
                "smsStatus":"0",
                "invokeTime":"170XXXXX",
                "smsSendTime":"",
                "id":"786375XXXXX",
                "smsSendStatus":"",
                "taskId":"GJYYXXXXXXX",
            },
            {
                "callId":"GJYYXX786XXXXX",
                "callDesc":"999",
                "mobile":"8615000XXXXX",
                "templateId":"7863757XXXXX",
                "callState":"2",
                "recallCount":"1",
                "callDescMsg":"未知",
                "countryCode":"CN",
                "smsStatus":"0",
                "invokeTime":"17038XXXXX",
                "smsSendTime":"",
                "id":"78637572XXXXX",
                "smsSendStatus":"",
                "taskId":"GJYYXXXXX"
            }
        ],
        "pageNum":1
    },
    "code":"200000"
}

六、 查询主叫

6.1 版本说明

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

6.2 协议说明

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

6.3 请求参数

参数名参数类型是否必传参数说明
appIdString应用id
appKeyString应用key

6.4 返回参数

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

6.5 返回数据示例(成功)

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

七、 查询挂机短信模板

7.1 版本说明

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

7.2 协议说明

名称说明
接口名称查询挂机短信模板
URLhttps://api.tig253.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)
countryCodeString国家码
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>>apiAccountstring短信api
data>>list>>apiPwdstring短信密钥
data>>list>>templateNamestring模板名称
data>>list>>countryCodestring国家码
data>>list>>accNostring帐号
data>>list>>contentstring模板内容
data>>list>>remarkstring审核备注
data>>list>>idstringid
data>>list>>createTimestring创建时间
data>>list>>updateTimestring更新时间

7.5 返回数据示例(成功)

复制成功
{
	"message": "请求成功",
	"data": {
		"total": 2,
		"pageSize": 10,
		"list": [
			{
				"apiPwd": "apiPwd",
				"createTime": "2023-12-15 18:36:02",
				"templateName": "test",
				"countryCode": "CN",
				"accNo": xxxxx,
				"apiAccount": "apiAccount",
				"updateTime": "2023-12-15 18:36:02",
				"remark": "remark",
				"id": 118528918XXXXXXX,
				"content": "Content"
			},
			{
				"apiPwd": "456",
				"createTime": "2023-12-15 18:36:02",
				"templateName": "test",
				"countryCode": "CN",
				"accNo": xxxxx,
				"apiAccount": "123",
				"updateTime": "2023-12-15 18:36:02",
				"remark": "备注",
				"id": 118528467XXXXXXX,
				"content": "测试短信模板"
			}
		],
		"pageNum": 1
	},
	"code": "200000"
}

附录:

1、 国家码列表

国家中文名国家码
加拿大CA
美国US
哈萨克KZ
俄罗斯联邦RU
阿布哈兹ABH
南奥赛梯SO
埃及EG
法国FR
法国大都会FX
西班牙ES
意大利IT
梵蒂冈(罗马教廷)VA
瑞士CH
英国UK
泽西岛BJ
德国DE
秘鲁PE
墨西哥MX
智利CL
哥伦比亚CO
马来西亚MY
澳大利亚AU
科科斯群岛CC
圣延岛CX
印度尼西亚ID
菲律宾共和国PH
新加坡SG
泰国TH
日本JP
韩国KR
越南VN
土耳其TR
印度IN
巴基斯坦PK
缅甸MM
伊朗(伊斯兰共和国)IR
摩洛哥MA
阿尔及利亚DZ
突尼斯TN
利比亚LY
尼日利亚NG
肯尼亚KE
厄立特里亚国ER
葡萄牙PT
塞浦路斯CY
东帝汶TP
文莱达鲁萨兰国BN
香港(中国)HK
澳门(中国)MO
柬埔寨KH
老挝LAO
孟加拉国BD
台湾(中国)TW
黎巴嫩LB
约旦JO
伊拉克IQ
科威特KW
沙特阿拉伯SA
也门YE
阿曼OM
巴勒斯坦PS
阿拉伯联合酋长国AE
以色列IL
巴林BH
卡塔尔QA
古巴CU
阿根廷AR
委内瑞拉VE
新西兰NZ
赤道几内亚GQ
危地马拉GT
萨尔瓦多SV
洪都拉斯HN
哥斯达黎加CR
巴拿马PA
玻利维亚BO
厄瓜多尔EC
巴拉圭PY
乌拉圭UY
多米尼加共和国DO
爱尔兰IE

2、 播放语种

语种语言(国家)
en-CA英语(加拿大)
en-US英语(美国)
ru-RU俄语(俄罗斯)
ar-EG阿拉伯语(埃及)
zu-ZA祖鲁语(南非)
el-GR希腊语(希腊)
nl-NL荷兰语(荷兰)
nl-BE荷兰语(比利时)
fr-FR法语(法国)
es-ES西班牙语(西班牙)
hu-HU匈牙利语(匈牙利)
it-IT意大利语(意大利)
ro-RO罗马尼亚语(罗马尼亚)
de-CH德语(瑞士)
de-AT德语(奥地利)
en-GB英语(英国)
da-DK丹麦语(丹麦)
sv-SE瑞典语(瑞典)
nb-NO书面挪威语(挪威)
pl-PL波兰语(波兰)
de-DE德语(德国)
es-PE西班牙语(秘鲁)
es-MX西班牙语(墨西哥)
es-CU西班牙语(古巴)
es-AR西班牙语(阿根廷)
pt-BR葡萄牙语(巴西)
es-CL西班牙语(智利)
es-CO西班牙语(哥伦比亚)
es-VE西班牙语(委内瑞拉)
ms-MY马来语(马来西亚)
en-AU英语(澳大利亚)
id-ID印度尼西亚语(印度尼西亚)
fil-PH菲律宾语(菲律宾)
en-NZ英语(新西兰)
en-SG英语(新加坡)
th-TH泰语(泰国)
kk-KZ哈萨克语(哈萨克斯坦)
ja-JP日语(日本)
ko-KR韩语(韩国)
vi-VN越南语(越南)
zh-CN中文(普通话,简体)
tr-TR土耳其语(土耳其)
hi-IN印地语(印度)
ur-PK乌尔都语(巴基斯坦)
ps-AF普什图语(阿富汗)
si-LK僧伽罗语(斯里兰卡)
my-MM缅甸语(缅甸)
fa-IR波斯语(伊朗)
ar-MA阿拉伯语(摩洛哥)
ar-DZ阿拉伯语(阿尔及利亚)
ar-TN阿拉伯语(突尼斯)
ar-LY阿拉伯语(利比亚)
en-NG英语(尼日利亚)
es-GQ西班牙语(赤道几内亚)
am-ET阿姆哈拉语(埃塞俄比亚)
so-SO索马里语(索马里)
sw-KE斯瓦希里语(肯尼亚)
sw-TZ斯瓦希里语(坦桑尼亚)
pt-PT葡萄牙语(葡萄牙)
is-IS冰岛语(冰岛)
sq-AL阿尔巴尼亚语(阿尔巴尼亚)
mt-MT马耳他语(马耳他)
fi-FI芬兰语(芬兰)
bg-BG保加利亚语(保加利亚)
lt-LT立陶宛语(立陶宛)
lv-LV拉脱维亚语(拉脱维亚)
et-EE爱沙尼亚语(爱沙尼亚)
hy-AM亚美尼亚语(亚美尼亚)
uk-UA乌克兰语(乌克兰)
sr-RS塞尔维亚语(西里尔文,塞尔维亚)
hr-HR克罗地亚语(克罗地亚)
sl-SI斯洛文尼亚语(斯洛文尼亚)
mk-MK马其顿语(北马其顿)
cs-CZ捷克语(捷克)
sk-SK斯洛伐克语(斯洛伐克)
es-GT西班牙语(危地马拉)
es-SV西班牙语(萨尔瓦多)
es-HN西班牙语(洪都拉斯)
es-NI西班牙(尼加拉瓜)
es-CR西班牙语(哥斯达黎加)
es-PA西班牙语(巴拿马)
es-BO西班牙语(玻利维亚)
es-EC西班牙语(厄瓜多尔)
es-PY西班牙语(巴拉圭)
es-UY西班牙语(乌拉圭)
yue-CN中文(粤语,简体)
km-KH高棉语(柬埔寨)
lo-LA老挝语(老挝)
bn-BD孟加拉语(孟加拉国)
zh-TW中文(台湾普通话,繁体)
ar-LB阿拉伯语(黎巴嫩)
ar-JO阿拉伯语(约旦)
ar-SY阿拉伯语(叙利亚)
ar-IQ阿拉伯语(伊拉克)
ar-KW阿拉伯语(科威特)
ar-SA阿拉伯语(沙特阿拉伯)
ar-YE阿拉伯语(也门)
ar-OM阿拉伯语(阿曼)
ar-AE阿拉伯语(阿拉伯联合酋长国)
he-IL希伯来语(以色列)
ar-BH阿拉伯语(巴林)
ar-QA阿拉伯语(卡塔尔)
mn-MN蒙古语(蒙古)
ne-NP尼泊尔语(尼泊尔)
az-AZ阿塞拜疆语(拉丁语,阿塞拜疆)
ka-GE格鲁吉亚语(格鲁吉亚)
uz-UZ乌兹别克语(拉丁语,乌兹别克斯坦)
es-DO西班牙语(多米尼加共和国)
en-IE英语(爱尔兰)
zh-HK粤语(中国香港)
zh-MO粤语(中国澳门)
fr-BE法语(卢森堡)
没有更多了
没有上一篇
没有下一篇
文档目录
收缩
24小时热线 400-9669-253