外呼接口文档
  1. 智能外呼
外呼接口文档
  • 公共部分说明
    • 请求公共部分
  • 智能外呼
    • 通话记录下载创建
      POST
    • 上传文件
      POST
    • 分页查询外呼任务列表
      POST
    • 下载任务中上传未成功的数据
      GET
    • 获取当前用户剩余并发数
      POST
    • 查询任务任务详情
      GET
    • 编辑任务任务信息
      POST
    • 创建任务
      POST
    • 创建任务(代码直接调用；被呼号码不使用excel模版上传直接使用参数传递，每次传递最多10000条)
      POST
    • 获取指定 ID 的场景详情
      GET
    • 检索所有电话号码资源。
      POST
    • 下载excel模版
      POST
    • 校验上传号码信息
      POST
    • 暂停任务
      POST
    • 重启任务
      POST
    • 停止任务
      POST
    • 创建外呼通话导出任务
      POST
    • 查询已发起的下载任务
      POST
    • 创建外呼历史下载链接
      POST
    • 创建导出任务
      POST
    • 分页查询场景列表
      POST
    • 根据场景uuid获取场景的动态属性列表(对外只返回属性key)
      POST
    • 分页查询通话列表
      POST
    • 查询通话的的标签
      POST
    • 查询通话对话文本列表
      POST
    • 音频下载
      GET
    • 下载通话对话文本列表
      GET
  1. 智能外呼

创建任务(代码直接调用；被呼号码不使用excel模版上传直接使用参数传递，每次传递最多10000条)

POST
/outcall/task/createTaskWithApi

请求参数

Body 参数application/json

示例
{
  "taskId": 0,
  "taskName": "",
  "sceneId": "",
  "executeType": 1,
  "concurrency": 1,
  "maxAttempts": 2,
  "attemptInterval": 5,
  "callerList": [
    {
      "phoneNumber": "",
      "phonePrefix": ""
    }
  ],
  "executeStartTime": "2022-12-25 16:30:00",
  "executeEndTime": "2022-12-25 17:30:00",
  "calleeList": [
    {
      "calleePhone": "",
      "variableParams": [
        {
          "key": "",
          "value": ""
        }
      ]
    }
  ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/outcall/task/createTaskWithApi' \
--header 'Content-Type: application/json' \
--data-raw '{
  "taskId": 0,
  "taskName": "",
  "sceneId": "",
  "executeType": 1,
  "concurrency": 1,
  "maxAttempts": 2,
  "attemptInterval": 5,
  "callerList": [
    {
      "phoneNumber": "",
      "phonePrefix": ""
    }
  ],
  "executeStartTime": "2022-12-25 16:30:00",
  "executeEndTime": "2022-12-25 17:30:00",
  "calleeList": [
    {
      "calleePhone": "",
      "variableParams": [
        {
          "key": "",
          "value": ""
        }
      ]
    }
  ]
}'

返回响应

🟢200成功
*/*
OK
Body

示例
{
  "code": 0,
  "message": "",
  "data": {
    "id": 0,
    "ownerId": 0,
    "taskUuid": "",
    "instanceUuid": "",
    "sceneName": "",
    "scenesUuid": "",
    "name": "",
    "sceneId": 0,
    "callerNumber": 0,
    "executeType": "IMMEDIATE",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "priority": "DAILY",
    "maxConcurrency": 0,
    "locationStrategy": "NO_STRATEGY",
    "ringDuration": 0,
    "maxDailyAttempts": 0,
    "retryInterval": 0,
    "repeatFilterStrategy": 0,
    "repeatNumberStrategy": true,
    "status": "DRAFT",
    "creatorId": 0,
    "createdAt": "yyyy-MM-dd HH:mm:ss",
    "updatedAt": "yyyy-MM-dd HH:mm:ss",
    "isDel": true,
    "workingTime": [
      {
        "beginTime": "",
        "endTime": ""
      }
    ],
    "repeatDays": [
      ""
    ],
    "repeatBy": "NO",
    "channel": "宇跃",
    "errorMsg": ""
  }
}
修改于 2025-11-07 11:47:47
上一页
创建任务
下一页
获取指定 ID 的场景详情
Built with