[TOC]

代理API

一、API认证方式

1. 查看认证Token

2. 统一请求格式

二、API接口

用户相关

1.用户列表

参数 类型 示例 解释 required
page int 1 页码 yes

2.注册账户

3.编辑用户

4.编辑保存用户

5.删除用户

6.生成授权后的客户端url(登录)

任务相关

1.创建任务初始化

2.任务创建

参数 类型 示例 解释 required
caller_line_id string 37d73edf-4628-4cf1-8beb-758433fd0aab 使用线路列表caller_line_list的value yes
customer_service_id int 1 使用客服组的id no
destination_extension int 297 使用话术分组的id yes
disable_dial_timegroup string 146979fe-3864-4817-ad76-13b37f43bb1c 禁用呼叫时间的uuid yes
maximumcall int 1 并发数(不得超过选用线路的residue) yes
name string 测试任务 任务名称 yes
random_assignment_number int 0 固定为0 yes
recycle_limit int 1 呼叫失败最大重拨次数[弃用,有且只能为0] yes
remark string 第一个任务 任务描述 no
_originate_timeout int 60 拨号超时 yes
call_pause_second int 10 每通电话的呼叫间隔,单并发的建议间隔10秒,多并发可选择0秒 yes
auto_recycle_rule_id int 1 重呼规则id yes
{
    "code": 200,
    "status": "success",
    "message": "创建任务成功",
    "data": {
        "id": "ba4d5b07-c4c0-49dd-888f-d038457fc08a"
    }
}

3.任务编辑

4.任务修改

5.任务列表

参数 类型 示例 解释 required
page int 1 页码 yes

6.任务删除

7. 任务开启

8.任务停止

9.任务拨打进度

10.根据任务获取获取标签场景,标签分组,标签

线路相关

1.线路列表

话术相关

1.话术分组

参数 类型 示例 解释 required
page int 1 页码 yes

代理商线路操作

1. 线路列表

参数 类型 示例 解释 required
page int 1 页码 yes
user_id string ascnjwnvc1561 用户id,不填时查询所有线路,填写时查询已分配到该用户下的所有线路 no
unused boolean true 不填时查询所有线路,true时查询所有未被分配的线路 no

示例

{
    "user_id":"f00c8abc-433f-4666-a9d6-70479605ced1",
    "unused":true
}

2.分配线路

参数 类型 示例 解释 required
user string ascnjwnvc1561 用户 yes
lines array [{"id":"8d5772a9-04d7-4d5e-a9a9-b8d922fbd490","available_time":"31536000"}] 分配的线路,id为线路id,available_time为可用时间 yes

示例

{
    "user":"f00c8abc-433f-4666-a9d6-70479605ced1",
    "lines":[{"id":"8d5772a9-04d7-4d5e-a9a9-b8d922fbd490","available_time":"31536000"}]
}

返回结果

{
    "code": 200,
    "status": "success",
    "message": "分配线路成功"
}

3.取消分配线路

参数 类型 示例 解释 required
lines array ["8d5772a9-04d7-4d5e-a9a9-b8d922fbd490"] 取消分配的线路 yes

示例

{
    "lines":["8d5772a9-04d7-4d5e-a9a9-b8d922fbd490"]
}

其他

1.获取已配置的评分等级

参数 类型 示例 解释 required
page int 1 页码 yes

2.获取可用的标签

参数 类型 示例 解释 required
page int 1 页码 yes

3.客服组列表

参数 类型 示例 解释 required
page int 1 页码 yes

客户公海

1.公海创建模板

参数 类型 示例 解释 required
user_id string 4d99d91c-f5d9-49da-88da-758977cc58a9 用户id yes

2.批量导入客户公海

参数 类型 示例 解释 required
data array [] 客户公海数据 yes

号码相关

1.号码列表

参数 类型 示例 解释 required
page int 1 分页 yes
user_id string fwevweve251 用户id yes
task_id string 1254685jjuq 任务id yes

2.号码详情

参数 类型 示例 解释 required
user_id string 4d99d91c-f5d9-49da-88da-758977cc58a9 用户id yes
task_id string b15b7392-a83f-4e0e-9570-31dd2ec8f85c 任务id yes
phone string 18651683344 手机号码 yes

3.批量添加号码

参数 类型 示例 解释 required
phone string 13012121211 号码 yes
sort int 0 排序 yes
components array [] 组件数据 no

4.批量重置号码状态

参数 类型 示例 解释 required
user_id string 4d99d91c-f5d9-49da-88da-758977cc58a9 用户id yes
task_id string b15b7392-a83f-4e0e-9570-31dd2ec8f85c 任务id yes
keyword string 18365474148 号码 no
start_at string 2020-07-28 创建开始时间 no
end_at string 2020-07-28 创建开结束时间 no
status int 1 筛选你所需要重置的号码的状态 no

5.批量删除号码

参数 类型 示例 解释 required
user_id string 4d99d91c-f5d9-49da-88da-758977cc58a9 用户id yes
task_id string b15b7392-a83f-4e0e-9570-31dd2ec8f85c 任务id yes
customer_info_list array [] 号码 yes

通话相关

1.通话列表

参数 类型 示例 解释 required
page int 1 页码 yes
levels array [ [300, 500] ] 评分区间 no
keyword string 1874125147 被叫号码 no
start_at string 2020-08-02 开始时间 no
end_at string 2020-08-03 结束时间 no

2.通话详情

参数 类型 示例 解释 required
task_id string b15b7392-a83f-4e0e-9570-31dd2ec8f85c 任务id yes
record_id string 17364fcc-45a8-4f0c-88d8-83ee57e1341b 通话id yes

三、代理回调

1.配置回调地址

2.任务结束回调数据

{
    "task_data": {
        "task_name": "bank",
        "created_at": "2020-05-28 16:41:45",
        "task_id": "b15b739e0e-9570-31d5c",
        "callerline": "南京-云蝠智能",
        "callerline_id": "6c48047947-b958-2fe0fc",
        "outbond_group": "测试话术",
        "number_count": 10
    },
    "number_status": [{
        "status": 0,
        "status_str": "等待呼叫",
        "count": 0
    }, {
        "status": 1,
        "status_str": "呼叫成功",
        "count": 1
    }, {
        "status": 2,
        "status_str": "线路故障",
        "count": 0
    }, {
        "status": 3,
        "status_str": "拒接",
        "count": 0
    }, {
        "status": 4,
        "status_str": "无应答、无人接听",
        "count": 0
    }, {
        "status": 5,
        "status_str": "空号",
        "count": 0
    }, {
        "status": 6,
        "status_str": "关机",
        "count": 0
    }, {
        "status": 7,
        "status_str": "停机",
        "count": 0
    }, {
        "status": 8,
        "status_str": "占线、用户正忙",
        "count": 0
    }, {
        "status": 9,
        "status_str": "呼入限制",
        "count": 0
    }, {
        "status": 10,
        "status_str": "欠费",
        "count": 0
    }, {
        "status": 11,
        "status_str": "黑名单",
        "count": 0
    }, {
        "status": 12,
        "status_str": "呼损",
        "count": 0
    }],
    "answer_rate": {
        "answered": 73,
        "noAnswer": 0
    },
    "user_data": {
            "user_id": "f00c8abc-433f-4666-a9d6-70479605ced1",
            "user_name": "1121"
        }
}

3.通话完成回调数据

{
    "calldate": "2020-08-06 12:00:07",
    "task_name": "bank",
    "original_number": "15472155875",
    "keyword": "不需要",
    "level_name": null,
    "bill": 9,
    "user_id": "f00c8ab-433f-a9d6-704791",
    "username": "用户名称"
}