黑名单与排队 VIP 插队维护接口
::: tip 提示
- 外呼显号设置与客户回拨直达分机设置，见 坐席资料绑定与分机外呼属性接口
- 来电排队监控，见 系统状态与排队监控接口 :::
HTTP黑名单维护接口
使用场景
可使用接口添加电话号码到呼叫中心黑名单，添加黑名单的电话无法打入也无法被打出。
实现流程
略
接口描述
添加黑名单接口完整URL：
http://x.x.x.x:12121/bridge/jsoncfg?opt=BLACK_LIST_ADD&json=135XXXXXXXX
| 字段名 | 字段含义 | 描述 |
|---|---|---|
| json | 被添加的号码 | |
| opt | BLACK_LIST_ADD | 默认不要修改 |
| x.x.x.x:12121 | 服务器IP通讯地址 | 12121默认端口，如果手动修改过端口号请使用修改后的端口 |
Http请求响应码解释：
- 200: 操作成功
- 400: 参数错误
删除黑名单接口完整URL：
http://x.x.x.x:12121/bridge/jsoncfg?opt=BLACK_LIST_RMV&json=135XXXXXXXX
| 字段名 | 字段含义 | 描述 |
|---|---|---|
| json | 被删除的号码 | |
| opt | BLACK_LIST_RMV | 默认不要修改 |
| x.x.x.x:12121 | 服务器IP通讯地址 | 12121默认端口，如果手动修改过端口号请使用修改后的端口 |
Http请求响应码解释：
- 200: 操作成功
- 400: 参数错误
查询黑名单接口完整URL：
http://x.x.x.x:12121/bridge/jsoncfg?opt=BLACK_LIST_QUERY&json=%7B%22first%22:0,%22maxResults%22:10,%22telnum%22:%22132XXXXXXXX%22%7D
| 字段名 | 字段含义 | 描述 |
|---|---|---|
| json | 查询条件 | {"first":0,"maxResults":10,telnum":"132XXXXXXXX"} 的 URLEncode后的字符串 |
| first | 第一条记录ID | |
| maxResults | 最大返回值数量 | |
| telnum | 查询的号码 | 非必填项，不填写则查询所有号码 |
| opt | BLACK_LIST_QUERY | 默认不要修改 |
| x.x.x.x:12121 | 服务器IP通讯地址 | 12121默认端口，如果手动修改过端口号请使用修改后的端口 |
Http请求响应码解释：
- 200: 操作成功
- 400: 参数错误 JSON 客户电话号码字符串数字，例如: "13255555555","13566666666"
扩展功能：设置软参，可开启或关闭黑名单定时功能。
blacklist.forbit.duration=24
注意： 24表示24小时。24小时之后解除禁闭
HTTP 排队VIP插队维护接口
使用场景
在对接系统存在VIP客户，希望VIP客户能优先接入进系统。可使用该接口把客户的电话号码设置进系统。排队时VIP会根据等级相应提前。
实现流程
略
接口描述
添加VIP号码接口完整URL：
http://127.0.0.1:12121/bridge/jsoncfg?opt=VIP_LIST_ADD&json=%7B%22telnum%22:%22135XXXXXXXX%22,%22viplevel%22:5,%22des%22:%22vipcustomer%22,%22createtime%22:%222018-09-11 15:28:02%22%7D
| 字段名 | 字段含义 | 描述 |
|---|---|---|
| json | 被添加的号码JSON格式并被URLEncode | {"telnum":"135XXXXXXXX","viplevel":5,"des":"vip customer","createtime":"2018-09-11 15:57:41"} |
| telnum | VIP客户电话号码 | |
| viplevel | VIP等级，后台会根据VIP等级进行插队。例如：1等级VIP，会少排队30秒，2级少排队60秒，3级少排队90 秒。 | |
| Createtime | 创建的时间 | |
| des | 描述 | |
| opt | VIP_LIST_ADD | 默认不要修改 |
| x.x.x.x:12121 | 服务器IP通讯地址 | 12121默认端口，如果手动修改过端口号请使用修改后的端口 |
Http请求响应码解释：
- 200: 操作成功
- 400: 参数错误
删除VIP号码接口完整URL：
http://x.x.x.x:12121/bridge/jsoncfg?opt=VIP_LIST_RMV&json=135XXXXXXXX
| 字段名 | 字段含义 | 描述 |
|---|---|---|
| json | 被删除的号码 | |
| opt | VIP_LIST_RMV | 默认不要修改 |
| x.x.x.x:12121 | 服务器IP通讯地址 | 12121默认端口，如果手动修改过端口号请使用修改后的端口 |
Http请求响应码解释：
- 200: 操作成功
- 400: 参数错误
查询VIP单接口完整URL：
http://x.x.x.x:12121/bridge/jsoncfg?opt=VIP_LIST_QUERY&json=%7B%22first%22:0,%22maxResults%22:10,telnum%22:%22132XXXXXXXX%22%7D
| 字段名 | 字段含义 | 描述 |
|---|---|---|
| json | 查询条件 | {"first":0,"maxResults":10,telnum":"132XXXXXXXX"} 的 URLEncode后的字符串 |
| first | 第一条记录ID | |
| maxResults | 最大返回值数量 | |
| telnum | 查询的号码 | 非必填项，不填写则查询所有号码 |
| opt | VIP_LIST_QUERY | 默认不要修改 |
| x.x.x.x:12121 | 服务器IP通讯地址 | 12121默认端口，如果手动修改过端口号请使用修改后的端口 |
Http请求响应码解释：
- 200: 操作成功
- 400: 参数错误 VIP客户相关JSON 字符串