开发文档

一、 智能语音机器人API

1.1 版本说明

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

1.2 协议说明

名称	说明
接口名称	智能语音机器人
URL	https://api.253.com/open/smartCall/start
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

1.3 请求参数

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

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id ，详情请看,功能介绍->接口详情
appKey	String	是	应用 key ，详情请看,功能介绍->接口详情
taskName	String	是	任务名称
mobilesJson	String	是	电话号码和参数（[{"phoneNumber":"176xxxxxxxx","variables":{"name":"张三","contactId":"C001","bank":"北京银行"}},{"phoneNumber":"176xxxxxxxx"}]） （批量号码上限10000个）
sceneId	String	是	场景 id
executeType	String	否	任务执行方式（0 立即执行，1 定时执行）默认为 0
executeStartTime	String	否	定时任务执行开始时间（只有executeType=1 的时候才需要设置）
executeEndTime	String	否	定时任务执行结束时间（只有executeType=1 的时候才需要设置）
recallCount	String	否	重拨次数（上限3次） 默认重拨1次
recallInterval	String	否	重拨间隔时长（分钟）（上限时间360分钟） 默认间隔60分钟
ringingDuration	String	否	振铃时长（秒）后挂断
emptyNumberIgnore	String	否	空号不外呼
inArrearsIgnore	String	否	欠费不外呼
outOfServiceIgnore	String	否	停机不外呼
flashSmsExtras	String	否	闪信推送的配置参数JSON 格式，具体参数联系运营获取
transData	String	否	透传数据(话单推送回调时返回) （长度上限50）
billUrl	String	否	话单推送回调地址 （长度上限250）

复制成功
{
	"appId": "xxx",
	"appKey": "xxx",
	"taskName": "测试任务1",
	"mobilesJson": "[{"phoneNumber":"176****22","variables":{"name":"张三","contactId":"C001","bank":"北京银行"}},{"phoneNumber":"176*****44","variables":{"name":"王五","bank":"上海银行"}}]",
	"sceneId": "xxx",
	"executeType": "1",
	"executeStartTime": "2023-07-21 09:00:00",
	"executeEndTime": "2023-07-21 18:00:00",
	"recallCount": "1",
	"recallInterval": "1",
	"ringingDuration": "10",
	"emptyNumberIgnore": "true",
	"inArrearsIgnore": "true",
	"outOfServiceIgnore": "true",
	"transData": "123***213",
    "billUrl": "http://****/voice/test/test3"
}

1.4 返回参数

参数名	数据类型	参数说明
code	String	响应code码。200000：成功，其他失败。详见code码
message	String	响应code码解释
data	String	任务ID

1.5 返回数据示例（成功）

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

1.6 返回数据示例（失败）

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

二、 消息状态报告推送

2.1 版本说明

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

2.2 推送格式说明

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

2.2 请求参数

application/json

参数名	参数类型	是否必传	参数说明
callId	String	是	调用ID号，每次调用生成唯一的ID号
mobile	String	是	被叫号码
retryCount	String	是	重试次数
count	String	是	计费数（按配置逻辑算出的消耗单位数）
tagHits	String	是	意向标签（字符串格式JSONArray）
transData	String	是	透传数据
tagHits	String	是	意向数据
data	List	是	通话详情
data>>callDesc	String	是	通话结束原因状态码 详见code码
data>>callDescMsg	String	是	通话结束原因状态码描述
data>>callStatus	String	是	呼叫结果 0-成功 1-失败
data>>startTime	String	是	语音接听时间，毫秒级时间戳
data>>callTime	String	是	通话时长(s)

2.2 请求示例

复制成功
{
	"callId": "AIYYJQR931******64224",
	"mobile": "12345678901",
	"retryCount": "2",
	"count": "5",
    "tagHits": "[{"tagGroup":"用户意图","tagName":"有意向"},{"tagGroup":"标签","tagName":"询问价格"}]",
	"transData": "xxxxxxxxxxxxxx",
	"data": [{
		"callDesc": "1024",
		"callDescMsg": "被叫欠费",
		"callStatus": "1",
		"startTime": "1688717322679",
		"callTime": "0"
	}, {
		"callDesc": "1000",
		"callDescMsg": "语音播放成功",
		"callStatus": "0",
		"startTime": "1688717322999",
		"callTime": "29"
	}]
}

2.2 建议返回结果（成功）

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

三、 查询话术模板

3.1 版本说明

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

3.2 协议说明

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

3.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
page	String	是	页码
size	String	是	分页大小（最大1000）

3.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>>scriptId	string	场景ID
data>>list>>scriptName	string	场景名称
data>>list>>isDrafted	Boolean	是否草稿装
data>>list>>updateTime	Long	更新时间
data>>list>>status	string	话术模板不可以用的状态： DRAFTED 草稿态 PUBLISH_IN_PROGRESS 正在发布 EXAMINE_IN_PROGRESS 待审核 话术模板可用的状态： PUBLISHED 已发布 PUBLISHED_AND_EXAMINE_IN_PROGRESS 已发布待审核状态 PUBLISH_FAILED：已发布待审核状态

3.5 返回数据示例（成功）

复制成功
{
	"message": "请求成功",
	"data": {
		"total": 13,
		"pageSize": 10,
		"list": [{
			"scriptId": "9fc49648-1df8-******",
			"scriptName": "测试示例场景",
			"isDrafted": true,
			"updateTime": 1690363728000,
			"status": "DRAFTED"
		}],
		"pageNum": 1
	},
	"code": "200000"
}

四、 查询通话列表

3.1 版本说明

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

3.2 协议说明

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

3.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
page	String	是	页码
size	String	是	分页大小（最大1000）
callId	String	否	任务id
taskName	String	否	任务名称
scriptId	String	否	场景id
callStatus	String	否	通话状态
startTime	String	否	任务创建时间（yyyy-MM-dd HH:mm:ss 开始）
endTime	String	否	任务创建时间（yyyy-MM-dd HH:mm:ss 结束）

3.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>>count	string	计费数（按配置逻辑算出的消耗单位数）
data>>list>>transData	string	透传数据
data>>list>>callId	String	任务id
data>>list>>taskName	String	任务名称
data>>list>>mobile	string	被叫号码
data>>list>>callStatus	string	呼叫结果 0-成功 1-失败
data>>list>>callDesc	string	通话结束原因状态码
data>>list>>callDescMsg	string	通话结束原因状态码描述
data>>list>>startTime	string	语音接听时间，毫秒级时间戳
data>>list>>callTime	string	通话时长(秒)
data>>list>>scriptName	string	场景名称
data>>list>>scriptId	string	场景id

3.5 返回数据示例（成功）

复制成功
{
	"message": "请求成功",
	"data": {
		"total": 4295,
		"pageSize": 10,
		"list": [{
			"count": 1,
			"transData": "xxxxx",
			"callId": "xxxxxxxxxxxxxxxx",
			"taskName": "测试用的任务示例-zcx26",
			"mobile": "139xxxx1234",
			"callStatus": "1",
			"callDesc": "1000",
			"callDescMsg": "语音播放成功",
			"startTime": "1697613776327",
			"callTime": "1",
			"scriptName": "场景示例-zcx26",
			"scriptId": "xxxxxxxx"
		}],
		"pageNum": 0
	},
	"code": "200000"
}

五、 查询作业详情

3.1 版本说明

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

3.2 协议说明

名称	说明
接口名称	查询作业详情
URL	https://api.253.com/data/api/smartCall/queryJob
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

3.3 请求参数

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id
appKey	String	是	应用key
callId	String	是	任务id
mobile	String	是	任务中的被叫号码

3.4 返回参数

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
data>>list	List	场景数据
data>>list>>callId	string	任务id
data>>list>>taskName	string	任务名称
data>>list>>mobile	String	被叫号码
data>>list>>callStatus	String	呼叫结果 0-成功 1-失败
data>>list>>callDesc	string	通话结束原因状态码
data>>list>>callDescMsg	string	通话结束原因状态码描述
data>>list>>startTime	string	语音接听时间，毫秒级时间戳
data>>list>>scriptName	string	场景名称
data>>list>>scriptId	string	场景id
data>>list>>planCallTime	string	计划呼出时间
data>>list>>realCallTime	string	实际呼出时间
data>>list>>ringingDuration	string	振铃时长
data>>list>>callTime	string	通话时长(秒)
data>>list>>label	string	业务参数（含透传数据和对话意图数据） 示例："[{"tagGroup":"意图 ","tagName ":"未明确意愿"}]"
data>>list>>soundUrl	string	录音文件地址
data>>list>>dialogueList	string	对话文本列表
data>>list>>dialogueList>>speakText	string	对话文本
data>>list>>dialogueList>>speakTime	string	对话时间
data>>list>>dialogueList>>speaker	string	对话是谁说的，Robot 机器人 ，Contact 联系人

3.5 返回数据示例（成功）

复制成功
{
	"message": "请求成功",
	"data": {
		"list": [{
			"callId": "xxxxxxxxxxxxxxxx",
			"taskName": "测试用的任务示例-zcx26",
			"mobile": "139xxxx1234",
			"callStatus": "0",
			"callDesc": "1000",
			"callDescMsg": "语音播放成功",
			"startTime": "1697613776327",
			"callTime": "1",
			"scriptName": "场景示例-zcx26",
			"scriptId": "xxxxxxxx",
			"planCallTime": "1697613776327",
			"realCallTime": "1697613776327",
			"ringingDuration": "1697613776327",
			"label": "[{"tagGroup ":"意图 ","tagName ":"未明确意愿 "}]",
			"soundUrl": "http//www.baidu.com",
			"dialogueList": [{
				"speaker": "Contact",
				"speakTime": 1688721611000,
				"speakText": "123test"
			}, {
				"speaker": "Robot",
				"speakTime": 1688721612000,
				"speakText": "123test123"
			}]
		}]
	},
	"code": "200000"
}