创建外呼任务
可通过接口进行外呼任务创建,创建外呼任务后,需要调用“外呼任务添加号码”接口进行号码的添加
备注:同一话术机器人只需通过接口创建一个外呼任务,然后使用“外呼任务添加号码”接口向该任务添加外呼号码。
请求地址
https://{baseURL}/api/v1/aicall/task/save?appkey=[appkey]&nonce=[nonce]×tamp=[timestamp]&signature=[signature]
请求方式:
POST
请求参数:
属性 | 类型 | 约束 | 描述 | 举例说明 |
---|---|---|---|---|
robot_id | string | 必填 | 机器人ID, 可通过页面获取 | 机器人ID |
name | string | 必填 | 任务名称 | 最大32个字符 |
task_erupt | integer | 选填 | 任务并发数,如果不填,则默认是机器人全并发数 | |
start_time | integer | 必填 | 任务开始日期 | 时间格式,精确到秒:1706149457开始日期 必须在创建任务当日或以后。 |
stop_time | integer | 必填 | 任务结束日期 | 时间格式,精确到秒:1706284800。结束日期 必须在开始日期当日或以后。 |
work_hour_detail | object | 必填 | 机器人工作时间,若有多个可传递多个object,需注意结束时间需要大于开始时间 | |
disnumber | string | 必填 | 外显号码 | |
work_hour_detail.begin | string | 必填 | 外呼时间段开始 | 示例值:11:05:00 |
work_hour_detail.end | string | 必填 | 外呼时间段结束 | 示例值:14:00:00 |
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 |
请求示例
POST /api/v1/aicall/task/save?appkey=[appkey]&nonce=[nonce]×tamp=[timestamp]&signature=[signature]
Accept:application/json;
Content-Type: application/json;charset=utf-8;
{
"name": "测试队列外呼626001",
"start_time": 1706149457,
"stop_time": 1752231553,
"work_hour_detail": [
{
"begin": "00:00:00",
"end": "23:00:00"
}
],
"disnumber": "1234567890",
"task_erupt":1,
"robot_id": "BOT9x15e7l4p6xra",
"recall_rule": {
"cond_ids": [
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"interval_kind": 1,
"cur_day_max_count": 3,
"cur_day_kind": 1,
"cur_day_interval": 5
}
}
响应包体:
属性 | 类型 | 说明 |
---|---|---|
code | integer | 请求状态码,此时为0 |
msg | string | 请求状态码描述,此时为空 |
data | object | 结果集 |
响应示例:
{
"code": 0,
"data": {
"task_id": "xxxxxxxxx"
},
"msg": ""
}
文档更新时间: 2025-06-27 15:44 作者:admin