Appearance
更新日志
约束说明
- 接口新增字段:加粗 表示
- 接口废弃字段:
删除线表示 或标识【已废弃】 - 接口修改字段:下划线 表示有发送的字段/URL有变化
V3.0.0
新增云节点管理
可以获取当前伙伴可使用的云节点(tenant),是在创建用户时,新增的参数(tenant_id)。
- 【新】云节点列表
- 获取用户列表需要新增参数
tenant_id - 查询当前云节点上的用户列表
更新接口
| 接口 | 变更内容 |
|---|---|
| 【更新】用户列表 | 获取用户列表需要新增参数 tenant_id |
| 【更新】用户注册 | 注册用户新增字段 tenant_id |
| 【更新】线路列表 | 获取线路列表新增参数 tenant_id |
| 【更新】分配线路 | 分配线路新增参数 tenant_id |
| 【更新】通话列表 | 通话列表增加参数用户id |
| 【更新】通话详情 | 通话详情增加参数用户id |
v1.2.34
变动时间:2022-07-28
新增【子账户】功能
| 接口 | 方法 | 路径 |
|---|---|---|
| 列表接口 | GET | /agent-api/user/{user_id}/subset_users |
| 注册接口 | POST | /agent-api/user/{user_id}/subset_users |
| 编辑接口 | GET | /agent-api/user/{user_id}/subset_users/{sub_user_id}/edit |
| 修改接口 | PUT | /agent-api/user/{user_id}/subset_users/{sub_user_id} |
| 删除接口 | DELETE | /agent-api/user/{user_id}/subset_users/{sub_user_id} |
部分接口兼容子账户
以下接口请求参数中传入 sub_user_id 参数则是对子账户数据进行操作:
- 任务 【任务列表】 GET
/agent-api/user/{user_id}/task - 客户公海 【导入数据】 POST
/agent-api/user/{user_id}/customer - 客户公海 【异步导入数据】 POST
/agent-api/user/{user_id}/async_customer - 号码 【添加号码】 POST
/agent-api/user/{user_id}/task/{task_id}/number - 号码 【异步添加号码】 POST
/agent-api/user/{user_id}/task/{task_id}/async_number - 用户 【登录指定用户】 POST
/user/{id}/authorize - 其他 【查看回调数据】 POST
/agent-api/user/{user_id}/{unique_id}
v1.2.33
变动时间:2022-07-12
变动内容
- 号码 增加接口【黑名单组列表】GET
agent-api/user/{user_id}/blacklist_group - 号码 【添加黑名单】接口地址修改,由
agent-api/user/{user_id}/blacklist变为agent-api/user/{user_id}/group/{group_id}/blacklist
v1.2.32
变动时间:2022-04-27
变动内容
- 客户公海 【导入数据】、【异步导入数据】接口新增
email字段(邮箱)和company字段(公司) - 客户公海 【查看数据】接口新增
email字段(邮箱)和company字段(公司)筛选条件 - 号码 【添加号码】、【异步添加号码】新增
email字段(邮箱)和company字段(公司) - 回调 【通话完成】接口新增
email字段(邮箱)和company字段(公司)展示
v1.2.31
变动时间:2022-01-17
新增【呼叫时间组功能】
| 接口 | 方法 | 路径 |
|---|---|---|
| 列表接口 | GET | /agent-api/user/{user_id}/dial-time-group |
| 新增接口 | POST | /agent-api/user/{user_id}/dial-time-group |
| 编辑接口 | GET | /agent-api/user/{user_id}/dial-time-group/{group_id}/edit |
| 更新接口 | PUT | /agent-api/user/{user_id}/dial-time-group/{group_id} |
| 删除接口 | DELETE | /agent-api/user/{user_id}/dial-time-group/{group_id} |
新增业务返回 code 码
8100=> 呼叫时间组不存在8101=> 呼叫时间组已关联任务,不可删除
呼叫时间组功能说明
- 任务初始化、任务列表、编辑任务等接口,新增【用户呼叫组】字段,用来完全替代【原禁呼时间组】功能,且【原禁呼时间组】功能完全废弃
- 外呼任务必须绑定一个【呼叫时间组】
- 【呼叫时间组】可设置最大呼叫时间范围是【周一至周日,8点至22点】,其他时间为不拨打时间
- 呼叫时间可分开设置,如周一:8点至13点、14点至18点;周二:9点至14点、15点至19点
- 【呼叫时间组】可以设置是否跳过节假日,跳过节假日为 true,表示在法定节假日期间不会拨打(如春节、清明节、端午节等)
字段变更
- 任务初始化、任务列表、更新任务等接口,废弃【disable_time_group】字段(禁呼组),新增【task_dial_time】字段(呼叫组)
- 任务初始化、任务列表、任务编辑接口废弃了【start】字段,增加了新状态【status】、【status_str】两个字段
任务状态说明
| status | 说明 |
|---|---|
| 1 | 表示任务当前状态为【已手动停止】(手动停止的任务,不会再继续拨打,除非手动开启) |
| 2 | 表示任务当前的状态为【执行中】,可正常自动外呼 |
| 3 | 表示任务当前的状态为【等待执行】(当前任务不在呼叫时间中,等待执行) |
接口地址变更
| 接口 | 旧地址 | 新地址 |
|---|---|---|
| 【任务开启】 | /agent-api/task_start/{task_id} | /agent-api/user/{user_id}/task_start/{task_id} |
| 【任务关闭】 | /agent-api/task_stop/{task_id} | /agent-api/user/{user_id}/task_stop/{task_id} |
| 【任务进度】 | /agent-api/task_progress/{task_id} | /agent-api/user/{user_id}/task_progress/{task_id} |
| 【任务场景/分组/标签】 | /agent-api/task/{task_id}/tag | /agent-api/user/{user_id}/task/{task_id}/tag |
其他变更
- 【新建任务】、【编辑任务】接口,
bridge_group_id字段的验证方式调整为:存在即验证 - 【批量进度】接口方式一已废弃;方式二调用方式不变,优化了内部处理速度