切换主题

创建任务 ​

该接口用于导入客户到任务中并开始进行外呼。使用该接口前需要先在系统中创建任务，再根据查询任务列表获取到任务ID。

POSThttps://dashboard.avavox.com/open/api/task

请求头 ​

Authorization string 必填

鉴权使用，格式为 Authorization: Bearer <Key> ，key从系统中获取

请求体参数 ​

taskName string 必填

任务名称

robotId string 必填

需要关联的机器人

lineId string 可选

需要使用的线路，为空时，任务不能进行外呼

backgroundAudio string 可选

背景音。

  • office_ambient：办公室环境音
  • busy_call_center：繁忙的呼叫中心办公室
  • telemarketing_office：电销办公室

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

点击展开字段说明

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",
  "lineId": "线路ID",
  "backgroundAudio": "office_ambient",
  "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": {
    "taskId": "xxx"
  }
}