切换主题
创建任务
该接口用于创建外呼任务。使用前需确保已在系统中完成以下准备工作:
- 已创建并发布好机器人
- 如需外呼功能,需预先配置线路
说明
- 创建任务后会返回任务ID
- 需要使用「客户导入」接口将客户添加到任务中
- 完成客户导入后,系统才能开始外呼
POSThttps://dashboard.avavox.com/open/api/task
请求头
Authorization string 必填
- 填写格式:
Authorization: Bearer <App Key> <App Key>为控制台「App Key 管理」页面生成的 Key。- 获取方式详见:《App Key 创建与管理》。
请求体参数
taskName string 必填
任务名称,长度 1–300 个字符
robotId string 必填
需要关联的机器人,可在机器人详情中获取,或通过机器人查询接口获取
clientBizId string 可选
调用方业务ID,用于关联您系统中的业务数据,后续可通过该字段查询任务,长度 ≤128 个字符
metadata object 可选
随路数据,以键值对形式传入,创建成功后会随任务原样返回,序列化后的 JSON 字符串长度 ≤4000 个字符
lineId string 可选
需要使用的线路,可通过线路查询接口获取,为空时,任务不能进行外呼
lineIds array 可选
需要使用的线路列表,可通过线路查询接口获取。
- 仅传
lineIds时,使用该列表作为任务线路配置 - 同时传
lineId和lineIds时,系统会将两者合并后作为最终线路配置 - 若存在重复线路 ID,系统会自动去重
backgroundAudio string 可选
背景音。
office_ambient:办公室环境音busy_call_center:繁忙的呼叫中心办公室telemarketing_office:电销办公室
concurrency number 可选
任务的最大并发呼叫数。不传则保持原配置。实际生效并发数为「任务配置的并发数」与「所用线路支持的最大并发数」两者中的较小值。
runtimeConfig object 可选
运行时配置项,用于控制任务的行为策略,包括重呼配置等。
点击展开字段说明
retryConfig object 可选
重呼配置,如果要禁用重呼配置,必须将 enabled 设置为 false 才会生效
点击展开字段说明
retryableStatuses array 可选
触发重呼的状态列表,可多选,枚举值如下:
unconnected:未接通no_one_answer:无人接听timeout:超时未接听user_refuse:用户拒接unreachable:无法接通insufficient_balance:用户欠费powered_off:关机service_suspended:停机invalid_number:空号call_fail:呼叫失败busy:占线
maxRetries number 可选
重呼次数,最大为5次
retryInterval number 可选
呼叫间隔,最小为1,单位:分钟
enabled boolean 可选
是否启用重呼配置,true-启用,false-不启用,默认为 true
callTimeType string 可选
拨打时间类型,默认为 immediate,枚举值如下:
immediate:立即拨打,创建任务并导入数据之后,立即开始拨打scheduled:根据选择的拨打时间段进行拨打
scheduledTime array 可选
定义任务的拨打时间。可定义多个时间段,各时间段之间不能交叉,仅当 callTimeType 为 scheduled 时生效。结构如下:
点击展开字段说明
dayOfWeeks array 必填
时间片段生效的日期,周一到周天分别对应 1 到 7
times array 必填
可以拨打的时间段。每个时间段不能交叉,结构如下:
点击展开字段说明
startTime string 必填
开始时间,时间格式为 HH:mm,精确到分钟
endTime string 必填
结束时间,时间格式为 HH:mm,精确到分钟
scheduledDateConfig object 可选
任务有效日期配置,用于限制任务可发起呼叫的日期范围。仅当 callTimeType 为 scheduled 时生效;为 immediate 或未传时,该配置不生效。
不传或传 null 时,默认长期有效。
有效日期与 scheduledTime 共同限制外呼:任务须处于有效日期范围内,且符合配置的星期和拨打时段,才可发起呼叫。开始日期前及结束日期后不发起新呼叫。
点击展开字段说明
type string 必填
传入 scheduledDateConfig 时必填,枚举值如下:
date_range:指定有效日期范围,须同时传入dateRangeunlimited:长期有效,不限制日期;忽略dateRange
dateRange object 可选
type 为 date_range 时必填,包含以下字段:
点击展开字段说明
startDate string 必填
开始日期,格式为 yyyy-MM-dd,包含当天
endDate string 必填
结束日期,格式为 yyyy-MM-dd,包含当天;不得早于 startDate
日期必须为合法的日历日期。
创建任务时,startDate 不得早于今天。
响应数据
code int
状态码,200 为成功,其他状态均为失败。
success boolean
是否成功,true 表示成功,false 表示失败。
message string
描述信息
data object
点击展开字段说明
taskId string
对应任务ID
请求示例
示例日期请替换为符合校验规则的实际日期。
指定有效日期
shell
curl -X POST --location 'https://dashboard.avavox.com/open/api/task' \
--header 'Authorization: Bearer $Key' \
--header 'Content-Type: application/json' \
--data '{
"taskName": "任务名称",
"robotId": "关联的机器人ID",
"clientBizId": "ORDER_20260722001",
"metadata": {
"orderId": "10001"
},
"lineId": "线路ID",
"lineIds": ["线路ID1"],
"backgroundAudio": "office_ambient",
"concurrency": 1,
"runtimeConfig": {
"retryConfig": {
"retryableStatuses": ["busy", "timeout"],
"maxRetries": 1,
"retryInterval": 1,
"enabled": true
}
},
"callTimeType": "scheduled",
"scheduledDateConfig": {
"type": "date_range",
"dateRange": {
"startDate": "2027-01-01",
"endDate": "2027-01-31"
}
},
"scheduledTime": [
{
"dayOfWeeks": [
1, 2, 3, 4, 5
],
"times": [
{
"startTime": "09:00",
"endTime": "12:00"
},
{
"startTime": "14:00",
"endTime": "18:00"
}
]
},
{
"dayOfWeeks": [
6, 7
],
"times": [
{
"startTime": "10:00",
"endTime": "12:00"
},
{
"startTime": "15:00",
"endTime": "17:00"
}
]
}
]
}'响应示例
json
{
"code": 200,
"message": "操作成功",
"success": true,
"data": {
"taskId": "xxx"
}
}