修改任务

该接口用于修改已存在的任务，包括修改任务名称、使用的机器人、并发数、线路以及背景音。

PUThttps://dashboard.avavox.com/open/api/task/{taskId}

请求头

Authorization string 必填

填写格式：Authorization: Bearer <App Key>
<App Key> 为控制台「App Key 管理」页面生成的 Key。
获取方式详见：《App Key 创建与管理》。

Path 参数

taskId string 必填

需要更新的任务ID

请求体参数

taskName string 可选

新的任务名称，长度 1–300 个字符。不传则保持原任务名称不变。

robotId string 可选

将任务绑定的机器人替换为指定机器人。该值为机器人 ID，可在机器人详情中获取，或通过机器人查询接口获取。不传则不修改。

lineId string 可选

任务使用的线路 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

forbiddenCallTime array 可选

禁止呼叫的时间，默认为晚上9点到早上8点为禁呼时间段。可定义多个时间段，每个时间段不能交叉，结构如下：

点击展开字段说明

startTime string 必填

开始时间，时间格式为 HH:mm，精确到分钟

endTime string 必填

结束时间，时间格式为 HH:mm，精确到分钟

callTimeType string 可选

拨打时间类型，默认为立即拨打，枚举值

immediate：立即拨打，创建任务并导入数据之后，立即开始拨打
scheduled：根据选择的拨打时间段进行拨打

scheduledTime array 可选

当拨打时间类型（callTimeType）为 scheduled 时，该字段为必填字段，定义任务的拨打时间。可定义多个时间段，每个时间段不能交叉，结构如下：

点击展开字段说明

dayOfWeeks array 必填

时间片段生效的日期，周一到周天分别对应 1 到 7

times array 必填

可以拨打的时间段。每个时间段不能交叉，结构如下：

点击展开字段说明

startTime string 必填

开始时间，时间格式为 HH:mm，精确到分钟

endTime string 必填

结束时间，时间格式为 HH:mm，精确到分钟

响应数据

code int

状态码，200 为成功，其他状态均为失败。

success boolean

是否成功，true 表示成功，false 表示失败。

message string

描述信息

data object

默认为 null

请求示例

shell

curl -X PUT --location 'https://dashboard.avavox.com/open/api/task/123' \
--header 'Authorization: Bearer $Key' \
--header 'Content-Type: application/json' \
--data '{
  "taskName": "任务名称",
  "robotId": "关联的机器人ID",
  "lineId": "线路ID",
  "backgroundAudio": "office_ambient",
  "concurrency": 10,
  "runtimeConfig": {
    "retryConfig": {
      "retryableStatuses": [
        "busy",
        "timeout"
      ],
      "maxRetries": 1,
      "retryInterval": 1,
      "enabled": true
    }
  },
  "forbiddenCallTime": [
    {
      "startTime": "22:00",
      "endTime": "07:00"
    }
  ],
  "callTimeType": "scheduled",
  "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": null
}

修改任务 ​

请求头 ​

Path 参数 ​

请求体参数 ​

响应数据 ​

请求示例 ​

响应示例 ​

修改任务

请求头

Path 参数

请求体参数

响应数据

请求示例

响应示例