创建外呼任务-一次性任务
可通过接口进行外呼任务创建,将外呼号码全部添加,不支持调用外呼任务添加接口
备注:每个外呼任务只能一次性创建并提交号码,不支持后续追加号码。任务执行结束后,可通过配置外部任务状态回调接口,自动接收任务完成状态通知。
请求地址
https://{baseURL}/api/v1/aicall/task/save/with-number?appkey=[appkey]&nonce=[nonce]×tamp=[timestamp]&signature=[signature]
请求方式:
POST
请求参数:
| 属性 | 类型 | 约束 | 描述 | 举例说明 |
|---|---|---|---|---|
| name | string | 必填 | 任务名称 | 最大32个字符 |
| start_time | integer | 必填 | 任务开始日期 | 时间格式,精确到秒:1706149457开始日期 必须在创建任务当日或以后。 |
| stop_time | integer | 必填 | 任务结束日期 | 时间格式,精确到秒:1706284800。结束日期 必须在开始日期当日或以后。 |
| work_hour_detail | object | 必填 | 机器人工作时间,若有多个可传递多个object,需注意结束时间需要大于开始时间 | |
| work_hour_detail.begin | string | 必填 | 外呼时间段开始 | 示例值:11:05:00 |
| work_hour_detail.end | string | 必填 | 外呼时间段结束 | 示例值:14:00:00 |
| disnumber | string | 必填 | 外显号码 | |
| task_erupt | integer | 选填 | 任务并发数,如果不填,则默认是机器人全并发数 | |
| robot_id | string | 必填 | 机器人ID, 可通过页面获取 | 机器人ID |
| recall_rule | Object | 非必填 | 重呼规则 | 如果重呼规则填写了,重呼规则中的字段都为必填; 注:重呼规则在任务的时间范围内生效,超过后不再进行重呼 |
| recall_rule.cond_ids | Array | 必填 | 外显重呼条件 通话状态 1.正常挂机 2.无法接通 3.用户拒接 4.正在通话 5.用户正忙 6.关机 7.停机 8.空号 9.网络忙 10.无人接听 11.呼叫转移 12.呼出限制 13.其他号码 | 示例值:[1,2] |
| recall_rule.interval_kind | Integer | 必填 | 间隔策略 1-当日重呼; | 示例值:1 |
| recall_rule.cur_day_max_count | string | 必填 | 当日最大重呼次数 | 示例值:2 |
| recall_rule.cur_day_kind | Integer | 必填 | 当日重呼策略 1-间隔重呼 | 示例值:1 |
| recall_rule.cur_day_interval | Integer | 必填 | 当日重呼间隔(分钟) | 示例值:30 |
| numbers | Array | 必填 | 呼叫号码,参数依据任务定义的变量而定,phone为必填项。 | {"name":"xx","phone":"13012345678,1001","userdata":"123456","email":"email@mail.com","address":"x x省xx市xx县xx"}”,{"name":"xx","phone":"13012345679","userdata":"123123","email":"email2@mail.com","address":" xx省xx市xx县xx"}” |
请求示例
POST /api/v1/aicall/task/save?appkey=[appkey]&nonce=[nonce]×tamp=[timestamp]&signature=[signature]
Accept:application/json;
Content-Type: application/json;charset=utf-8;
{
"task_id": "",
"name": "测试队列外呼26-6-18-2",
"start_time": 1768406400,
"stop_time": 1799942400,
"work_hour_detail": [
{
"begin": "00:00:00",
"end": "23:00:00"
}
],
"disnumber": "1166",
"task_erupt": 1,
"robot_id": "BOTdm6u4vhfe19z1619",
"recall_rule": null,
"numbers": [
"{\"name\":\"275重复添加\",\"phone\":\"02985815270\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815271\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815272\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815273\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815274\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815275\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815276\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815277\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815278\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}",
"{\"name\":\"275重复添加\",\"phone\":\"02985815279\",\"userdata\":\"123123\",\"email\":\"\",\"address\":\" xx省xx市xx县xx\"}"
]
}
响应包体:
| 属性 | 类型 | 说明 |
|---|---|---|
| code | integer | 请求状态码,此时为0 |
| msg | string | 请求状态码描述,此时为空 |
| data | object | 结果集 |
| data.task_id | String | 任务id |
| data.total | Integer | 送号总数 |
| data.successNums | Integer | 送号成功数 |
| data.jsonInvalidNums | Integer | json格式错误,无法解析的个数 |
| data.variableError | Integer | 变量异常的号码。变量异常:号码为空、号码 格式异常、变量缺失、变量 不合法。 |
| data.blackNumber | Integer | 过滤黑名单号码 |
| data.overNumber | array | 超出上线号码 |
| data.repeatInfo | map | 符合条件的号码中,重复号 码的信息<号码,重复次数> |
| data.successInfo | map | 上传号码对应的callid |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"task_id": "2026061800004",
"total": 10,
"successNums": 10,
"jsonInvalidNums": 0,
"variableError": null,
"blackNumber": null,
"overNumber": null,
"repeatInfo": {
"02985815270": 1,
"02985815271": 1,
"02985815272": 1,
"02985815273": 1,
"02985815274": 1,
"02985815275": 1,
"02985815276": 1,
"02985815277": 1,
"02985815278": 1,
"02985815279": 1
},
"successInfo": {
"02985815270": "41709003-53b1-48fc-b065-4cf07f3db295",
"02985815271": "dc980776-c453-424c-8cab-3797b0006df7",
"02985815272": "2aaf6d26-af8f-4858-8408-ccef8dae76cd",
"02985815273": "199f3bb5-37ff-4fb8-9c1d-44a12a6aab66",
"02985815274": "1eeca891-dc11-4da3-a2a4-edfbd1e18b9d",
"02985815275": "f8a19846-0e01-44f0-99f6-1fb73eaad21c",
"02985815276": "7d704153-9e00-4178-a185-ad68d35a27da",
"02985815277": "d55ba6af-67e9-4747-94f5-5ddeb16a43e7",
"02985815278": "36aef3ba-1e60-4c36-a9f1-dddf1903ffa3",
"02985815279": "1b40a4df-9331-45d0-bec6-a5661634b21f"
}
}
}文档更新时间: 2026-06-23 14:13 作者:admin