创建任务
若您初次使用智能外呼系统开放平台接口,请在使用前阅读说明文档。
接口说明
- 接口类型:主动调用接口
- 接口作用:在智能外呼系统中创建一个机器人外呼任务。
请求方法
POST
https://icall.sobot.com/icall/platform/addTask
请求参数
参数名 |
类型 |
必填 |
说明 |
appId |
字符串 |
是 |
智齿分配 |
signature |
字符串 |
是 |
智齿分配 |
templateId |
字符串 |
是 |
模板id |
taskName |
字符串 |
是 |
任务名称 |
lineType |
整型 |
是 |
线路类型,1:固话,3:sim卡 |
telephone |
字符串 |
是 |
外显号码,多个用","分隔 |
startTime |
时间戳 |
否 |
自定义有效期开始时间,13位 |
endTime |
时间戳 |
否 |
自定义有效期结束时间,13位 |
robotNum |
整型 |
是 |
机器人数 |
timeType |
整型 |
是 |
有效期 1:自定义 ;2:永久 |
callTimeSlot |
字符串 |
是 |
拨打时间段,示例:10:00-19:00 |
taskStatus |
整型 |
是 |
任务状态传0即可 |
pushUrl |
字符串 |
否 |
结果推送地址 |
pushType |
整型 |
否 |
结果推送方式,1:转人工后推送 2:通话结束后推送 |
返回JSON
参数名 |
类型 |
说明 |
code |
字符串 |
执行结果码,1000代表成功 |
data |
对象 |
详见下文 |
返回data
参数名 |
类型 |
说明 |
taskId |
字符串 |
任务id |
请求示例:
{
"appId":"xxxxxxxxxx", //智齿提供的appid
"signature": "xxxxxxxxxxxxx", //智齿提供的signature
"templateId":"模板id", //拨打电话时使用的模板,需在系统中提前设置模板
"taskName": "任务名称", //本次任务的名称
"lineType":"线路类型", //本次任务拨打时用的线路类型1:固话,3:sim卡(需提前配置线路)
"telephone":"telephone" //本次任务拨打时需要显示的外显号码(需提前配置外显号)
"robotNum": "机器人数目", //本次任务拨打时机器人的数目(需提前配置)
"timeType":"有效期" //本次任务的有效期1:自定义 ;2:永久
"startTime": "13位时间戳", //本次任务有效期为自定义时的开始时间
"endTime":"13位时间戳", // 本次任务有效期为自定义时的结束时间
"callTimeSlot": "拨打时间段", //本次任务将在此时间段进行拨打
"taskStatus":"0",
"pushUrl":"结果推送接收地址", //
"pushType":"结果推送方式" //
}
返回示例:
{
"code": "1000",
"data": {
"taskId":"xxxx" //提交数据接口需要的任务id
}
}