Skip to main content

外呼数据

零、注意事项：

0.1 格式说明

所有API，若未特殊注明，Content-Type 全部使用 application/json。

0.2 出参约定格式

如无特殊说明，出参固定为以下格式：

参数类型说明
codeint状态码，0 - 成功， 其余为失败
messagestring提示信息
datamixed数据

data 具体格式见每个接口具体说明

0.3 域名

如果无特殊说明，以下 API 中，所有域名均为: https://autocall.icsoc.net

一、外呼-数据列表

1.1 路由

GET/POST /api/v3/tasks/lists

1.2 入参

参数类型说明必填默认值
project_idint项目id是
created_atarray导入时间否
batch_numstring批次号否
phonestring呼叫号码否
call_resultarray呼叫结果：-3-已取消；-2-未呼叫；-1-重呼中；0-未接通；1-接通；2-呼叫中否
current_pageint当前页否1
per_pageint每页数量否15

1.3 出参

参数类型说明
idint任务id
project_idinteger项目id
project_namestring
batch_numstring批次号
phonearray被叫号码
custom_dataobject自定义信息
call_resultint呼叫结果
call_result_stringstring呼叫结果
expired_atint过期时间，时间戳
priorityint优先级
started_atstring呼叫开始时间
connected_atstring呼叫接通时间
ended_atstring呼叫结束时间
called_timesint呼叫次数
canceled_atstring取消时间
next_queue_timestring下一次重呼时间

1.4 举例

1.4.1 入参

{
    "project_id": 1
}

1.4.2 出参

{
  "code": 0,
  "message": "操作成功",
  "request_id": "cfdc83ae2d8058f6b94deb5ac32d0383",
  "data": {
    "current_page": 1,
    "total_page": 1,
    "per_page": 20,
    "total": 1,
    "empty": false,
    "results": [
      {
        "id": 1,
        "vcc_id": 782,
        "project_id": 11258,
        "import_id": 114,
        "batchNum": "20220523152018",
        "phone": [
          "13001111124"
        ],
        "expired_at": 4000000000,
        "priority": 10,
        "started_at": "2022-05-23 15:22:00",
        "connected_at": "2022-05-23 15:22:13",
        "ended_at": "2022-05-23 15:22:43",
        "call_result": 1,
        "called_times": 1,
        "asr_int": 0,
        "asr_text": "",
        "custom_data": {
          "extId": "不二",
          "extName": "哈哈"
        },
        "crmInfo": null,
        "canceled_at": null,
        "canceled_user_name": "",
        "created_at": "2022-05-23 15:20:24",
        "updated_at": "2022-05-23 15:22:44",
        "customer_id": "不二",
        "call_result_string": "接通",
        "custom_ext_id": "不二",
        "custom_ext_mame": "哈哈",
        "showPhone0": "13001111124",
        "project_name": "test-05-23",
        "next_queue_time": ""
      }
    ],
    "headers": []
  }
}

二、外呼-数据取消

2.1 路由

GET/POST /api/v3/tasks/cancel

2.2 入参

参数类型说明必填
project_idint项目id是
idsint[]任务id，如果没有此参数，则将取消整个项目下面的所有未呼叫数据否

2.3 出参

无

2.4 举例

2.4.1 入参

{
  "project_id": 1
}

2.4.2 出参

{
    "code":0,
    "message":"操作成功",
    "request_id":"c584766bd49f2aa38575cf785466dc49"
}

三、外呼-数据异步导入

3.1 路由

POST /api/v3/async/create

3.2 入参

参数类型说明必填
project_idint项目id是
async_actionstring固定值 import是
urlstring任务链接，url 和 data 必选其一特殊可选
dataData[]导入数据，低于 100 条建议使用同步导入，使用此方式单次最大导入条数限制1000条特殊可选
batch_numstring自定义批次号，查询任务列表时，可以通过此批次号进行搜索是
priorityint优先级，默认100否
filter_rulesFilterRules过滤规则, 例如：{"history":true,"blacklist":true}否
orderint导入顺序：1-顺序导入；2-随机导入，默认顺序导入否
max_queue_secsint数据有效时间，0代表永久有效是

当使用 url 方式时，文件模板请访问：/api/v3/import/template?project_id=? 下载 (如果使用此方式，建议直接在后台管理系统进行导入，以便获得更好的操作体验)

3.2.1 FilterRules 格式

参数类型说明
historybool是否过滤历史记录
blacklistbool导入过滤黑名单
uniquebool当前批次过滤

3.2.2 data 格式

参数类型说明必填
ext_idstring客户唯一标识否
priorityint优先级否
phonesstring[]号码，支持加密，加密方式请在管理后台配置，目前传递多个号码将只有第一个有效是
callerstring指定主叫号码否
custom_dataobject自定义参数，长度限制 400byte否
template_dataobject模板参数，对应任务设置中的自定义列否

3.3 出参

无

3.4 举例

3.4.1 入参

{
  "project_id": 10622,
  "url": "https://explame.cn/1695202593.csv",
  "filter_rules": {
    "history": false,
    "blacklist": false
  },
  "order": 1,
  "batch_num": "20230920173340",
  "priority": 100,
  "async_action": "import",
  "max_queue_secs": 0
}

3.4.2 出参

{
  "code":0,
  "message":"操作成功",
  "request_id":"14acfd91e86e6f74d07a9026ceec340d"
}

四、外呼-数据接收

4.1 路由

POST /api/v3/import/data

4.2 入参

参数类型说明必填
project_idint项目id是
dataData[]导入数据，请确保在 100 条数据内，超过100条请分批调用是
batch_numstring自定义批次号，默认为当前日期时间(yyyymmddhhiiss 格式)，查询任务列表时，可以通过此批次号进行搜索否
priorityint优先级，默认100否
filter_rulesFilterRules过滤规则, 例如：{"history":true,"blacklist":true}否
orderint导入顺序：1-顺序导入；2-随机导入，默认顺序导入否
max_queue_secsint数据有效时间，默认0代表永久有效否

4.2.1 Data 格式

参数类型说明必填
ext_idstring客户唯一标识否
priorityint优先级否
phonesstring[]号码，支持加密，加密方式请在管理后台配置，目前传递多个号码将只有第一个有效是
callerstring指定主叫号码否
custom_dataobject自定义参数，长度限制 400byte否
template_dataobject模板参数，对应任务设置中的自定义列否

4.2.2 FilterRules 格式

参数类型说明
historybool是否过滤历史记录
blacklistbool是否过滤黑名单
uniquebool当前批次过滤

4.3 出参

参数类型说明必填
/Result[]导入数据结果是

4.3.1 Result 格式

参数类型说明必填
phonestring[]号码是
task_idint导入数据结果否
messagestring错误原因否

4.4 举例

4.4.1 入参

{
    "project_id":10015,
    "batch_num": "buer-123",
    "data": [{
        "phones": ["18512345678"]
    }],
    "filter_rules":{
        "history":false,
        "blacklist":false
    },
    "max_queue_secs": 0
}

4.4.2 出参

{
    "code":0,
    "message":"操作成功",
    "request_id":"14acfd91e86e6f74d07a9026ceec340d",
    "data": [
        {
            "phone": ["18512345678"],
            "task_id": 1
        },
        {
            "phone": ["185fasdf"],
            "error": "号码格式错误"
        }
    ]
}

五、外呼-手动重呼

5.1 路由

GET/POST /api/v3/tasks/recall

5.2 入参

参数类型说明必填
project_idint项目id是
idsint[]任务id是

5.3 出参

无

5.4 举例

5.4.1 入参

{
  "projectId": 1,
  "ids": [1,20]
}

5.4.2 出参

{
    "code":0,
    "message":"操作成功",
    "request_id":"c584766bd49f2aa38575cf785466dc49"
}