预测式外呼-数据

零、注意事项：

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/v1/poc/tasks/lists

1.2 入参

参数类型说明必填默认值
projectIdint项目id是
phonestring呼叫号码否
callResultint呼叫结果：-3-已取消；-2-未呼叫；-1-重呼中；0-未接通；1-接通否
currentPageint当前页否1
perPageint每页数量否15

1.3 出参

参数类型说明
idint任务id
projectIdinteger项目id
projectNamestring
batchNumstring批次号
phonestring被叫号码
customerIdstring自定义id
callResultint呼叫结果
callResultStringstring呼叫结果
expiredAtint过期时间，时间戳
priorityint优先级
startedAtstring呼叫开始时间
connectedAtstring呼叫接通时间
endedAtstring呼叫结束时间
calledTimesint呼叫次数
canceledAtstring取消时间
nextQueueTimestring下一次重呼时间

1.4 举例

1.4.1 入参

{
    "projectId": 1
}

1.4.2 出参

{
    "code":0,
    "message":"操作成功",
    "request_id":"e5dfd0cdbe371e647ea2f8af9390b89e",
    "data":{
        "currentPage":1,
        "totalPage":18,
        "perPage":20,
        "total":345,
        "empty":false,
        "results":[
            {
                "id":1,
                "projectId":10000,
                "importId":1,
                "batchNum":"20210312163254",
                "phone":"15827598865",
                "expiredAt":4294967295,
                "priority":1,
                "startedAt":"2021-03-12 16:53:08",
                "connectedAt":null,
                "endedAt":"2021-03-12 16:53:39",
                "callResult":-3,
                "calledTimes":1,
                "asrInt":0,
                "asrText":"",
                "customData":{
                    "extId":"long"
                },
                "callbackTimes":0,
                "callbackResponse":"",
                "callbackAt":null,
                "crmInfo":null,
                "contactResult":0,
                "ownerUserId":0,
                "handlerUserId":0,
                "assignerUserId":0,
                "assignedAt":null,
                "savedAt":null,
                "canceledAt":"2021-03-12 16:57:38",
                "canceledUserName":"yansongda | yansongda",
                "createdAt":"2021-03-12 16:32:56",
                "updatedAt":"2021-03-12 16:57:38",
                "projectName":"小龙_test",
                "customerId":"long",
                "callResultString":"已取消",
                "nextQueueTime":""
            }
        ]
    }
}

二、预测式外呼-数据取消

2.1 路由

GET/POST /api/v1/poc/tasks/cancel

2.2 入参

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

2.3 出参

无

2.4 举例

2.4.1 入参

{
  "projectId": 1
}

2.4.2 出参

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

三、预测式外呼-数据异步导入

3.1 路由

GET/POST /api/v1/poc/tasks/import

3.2 入参

参数类型说明必填
projectIdint项目id是
urlstring任务链接，url 和 data 和 file 必选其一特殊可选
dataData[]导入数据，url 和 data 和 file 必选其一特殊可选
fileFILE文件类型导入，url 和 data 和 file 必选其一，如果使用此参数，content-type 需为 form-data特殊可选
batchNumstring自定义批次号，默认为当前日期时间(yyyymmddhhiiss 格式)，查询任务列表时，可以通过此批次号进行搜索否
priorityint优先级，默认100否
filterRulesFilterRules过滤规则, 例如：{"history":true,"blacklist":true}否
orderint导入顺序：1-顺序导入；2-随机导入，默认顺序导入否
maxQueueSecsint数据有效时间，默认0代表永久有效是

当使用 url 方式时，文件模板请访问：/api/v1/tasks/template?projectId=? 下载 (如果使用此方式，建议直接在 manage 企业管理后端进行导入，提升操作体验)

3.2.1 Data 格式

参数类型说明必填
ext_idstring客户唯一标识否
prirorityint优先级否
phonesstring[]号码是

3.2.2 FilterRules 格式

参数类型说明
historybool是否过滤历史记录
blacklistbool是否过滤黑名单

3.3 出参

无

3.4 举例

3.4.1 入参

{
    "projectId":10015,
    "url":"https://yansongda.cn/task_template-1616549684.csv",
    "filterRules":{
        "history":false,
        "blacklist":false
    },
    "order":1,
    "batchNum":"20210324093443",
    "priority":100,
    "maxQueueSecs": 0
}

3.4.2 出参

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

四、预测式外呼-数据接收

4.1 路由

POST/PUT /api/v1/poc/tasks/data

4.2 入参

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

4.2.1 Data 格式

参数类型说明必填
ext_idstring客户唯一标识，自定义标识符否
priorityint优先级，如果没有此参数，则使用入参中的 priority 参数否
phonesstring[]号码是

4.2.2 FilterRules 格式

参数类型说明
historybool是否过滤历史记录
blacklistbool是否过滤黑名单

4.3 出参

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

4.3.1 Result 格式

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

4.4 举例

4.4.1 入参

{
    "projectId":10015,
    "batchNum": "yansongda-123",
    "data": [{
        "phones": ["18512345678"]
    }],
    "filterRules":{
        "history":false,
        "blacklist":false
    },
    "order":1,
    "priority":100,
    "maxQueueSecs": 0
}

4.4.2 出参

{
    "code":0,
    "message":"操作成功",
    "request_id":"14acfd91e86e6f74d07a9026ceec340d",
    "data": [
        {
            "phone": ["18566722456"],
            "taskId": 1
        },
        {
            "phone": ["185fasdf"],
            "error": "号码格式错误"
        }
    ]
}
Last updated on 9/9/2021 by yanda
← 预测式外呼-任务预测式外呼-监控 →