API接口

一、 国际语音消息

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

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

参数名	参数类型	是否必传	说明
appId	String	是	请在官网登录后获取 ，详情请看,功能介绍->接口详情
appKey	String	是	请在官网登录后获取 ，详情请看,功能介绍->接口详情
mobile	String	是	被叫号码，模版无变量多个则以英文半角分号“;”分割；模板带变量，多个号码以英文分号“;”分割，号码和变量以英文逗号“,”隔开， 多个变量以竖线“|”隔开，如 86130XXXXXXXX,123|456;86186XXXXXXXX,321|654; 注意:号码需要自带国家码前缀，否者会被视为无效号码，单次最大1000个号码
countryCode	String	是	国家码，国家的简称，例如，中国:CN
templateId	String	是	语音模版Id，官网控制台创建后产生，且已审核通过
billUrl	String	否	话单推送回调地址 （最大长度250）
transData	String	否	透传数据(话单推送回调时返回 最大长度50)
displayNum	String	否	主叫号码，由运营提供，未提供的则不需要传
smsHangupStatus	String	否	挂机短信开启标识 0：关闭，1：开启，默认：关闭
smsTemplateId	String	否	挂机短信模板id
smsSendType	String	否	挂机短信发送方式：0:接通后发送，1:全部群发，2:未接通发送，3:按接通时长发送，默认:0
smsSendLimit	String	否	当挂机短信方式为3时必填，单位秒，输入时间规则为大于等于x后发送挂机短信（整数输入大于等于1）
sendType	String	否	任务发送类型 1-定时任务2-即时任务,不传为即时任务
taskStartTime	String	否	任务开始时间，最长8天，yyyyMMddHHmmss，eg:20200902170000
taskEndTime	String	否	任务结束时间，yyyyMMddHHmmss，eg:20200902235959
taskName	String	否	任务名称
maxRecallCount	String	否	最大重拨次数，只能0-3，默认：1 重拨1次
recallInterval	String	否	重拨间隔时长（分钟），默认值60，重播最长时间跨度3天，最大重拨次数大于0时必传
noConnected	String	否	重拨策略：被叫无法接通,true:重拨;false:不重拨,默认值:true
noAnswer	String	否	重拨策略：被叫无人接听,true:重拨;false:不重拨,默认值:true
ttsVoice	String	否	播放语种， 例如，美国：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",
    
}

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

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

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

二、 语音消息模板创建

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

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

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
templateName	String	是	模板名称，当contentType为2时需 传入英文的语音文件名，以.mp3/.wav结尾。
countryCode	String	是	国家码，国家的简称，例如，中国:CN
contentType	String	否	文本类型：1、文字模板 2、语音文件 不传的情况下默认为1，即文字模板，此时templateName以及templateContent必传 传2时 templateName以及file必传
templateContent	String	否	模板内容 （内容与模板变量组合长度小于200）
file	File	否	模板语音内容文件(支持mp3、wav)

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

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

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

三、 语音消息模板查询

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

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

参数名	参数类型	是否必传	参数说明
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、语音消息
templateId	String	否	模板id

参数名	数据类型	参数说明
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	模板内容
data>>list>>contentUrl	string	录音地址
data>>list>>countryNameZh	string	中文国家名
data>>list>>countryCode	string	国家码

复制成功
{
    "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"
}

四、 消息状态报告推送

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

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

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

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

五、 查询话单

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

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

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
page	String	是	页码
size	String	是	分页大小（最大100）
countryCode	String	是	国家码
mobile	String	否	被叫号码
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 ）

参数名	数据类型	参数说明
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>>recallCount	string	当前呼叫轮数（重播次数序号）
data>>list>>countryCode	string	国家码
data>>list>>smsStatus	string	挂机短信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败
data>>list>>invokeTime	string	语音调用时间
data>>list>>smsSendTime	string	挂机短信发送时间 13位时间戳
data>>list>>id	string	话单唯一id
data>>list>>smsSendStatus	string	短信发送状态
data>>list>>taskId	string	任务id

复制成功
{
    "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"
}

六、 查询主叫

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

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

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key

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

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

七、 查询挂机短信模板

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

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

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
page	String	是	页码
size	String	是	分页大小（最大1000）
countryCode	String	是	国家码
startDate	String	是	开始调用时间（yyyy-MM-dd HH:mm:ss）
endDate	String	否	结束调用时间（yyyy-MM-dd HH:mm:ss）

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>total	int	查询总数
data>>pageSize	int	每页个数
data>>pageNum	int	页码
data>>list	List	模板数据
data>>list>>apiAccount	string	短信api
data>>list>>apiPwd	string	短信密钥
data>>list>>templateName	string	模板名称
data>>list>>countryCode	string	国家码
data>>list>>accNo	string	帐号
data>>list>>content	string	模板内容
data>>list>>remark	string	审核备注
data>>list>>id	string	id
data>>list>>createTime	string	创建时间
data>>list>>updateTime	string	更新时间

复制成功
{
	"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	法语（卢森堡）