配置与管理接口

HTTP 数字线路分机外呼显号设置

使用场景

数字线路具有多个号码时，该接口用于指定分机外呼显示哪个号码。

实现流程

略

接口描述

外呼接口完整URL：

http://x.x.x.x:12121/bridge/callctrl?extnum=801&channel=2001&dspnum=xxxxxxxx&opt=SET_EXT_OUT_CALL_DSPLAY
字段名字段含义描述
extnum被叫分机号码
channel外呼通道用于指定分机使用哪个外呼通道呼出。
对应后台分机管理数字中继网关注册账号。
dspnum外呼显示号码注意该号码必须是运营商合法授权的号码。
optSET_EXT_OUT_CALL_DSPLAY默认不要修改
x.x.x.x:12121服务器IP通讯地址12121默认端口，如果手动修改过端口号请使用修改后的端口

Http请求响应码解释：

  • 200: 成功
  • 400: 参数错误
  • 404: 分机不存在

HTTP 客户回拨直达分机设置

使用场景

当分机外呼后，需要在一定时间内，让回拨的来电直接到达分机。若分机忙则直接释放通话。 注意：需要在配置管理后台，高级参数设置中，开启“客户回拨”直达开关（默认关闭） 可配置参考历史呼叫的最长天数

实现流程

略

接口描述

外呼接口完整URL：

http://127.0.0.1:12121/bridge/callctrl?extnum=801&offon=true&opt=SET_EXT_DIRECT_CALL_BACK
字段名字段含义描述
extnum被叫分机号码
offon开关true: 开启回拨直达
false: 关闭
optSET_EXT_DIRECT_CALL_BACK默认不要修改
x.x.x.x:12121服务器IP通讯地址12121默认端口，如果手动修改过端口号请使用修改后的端口

Http请求响应码解释：

  • 200: 成功
  • 400: 参数错误
  • 404: 分机不存在

HTTP黑名单维护接口

使用场景

可使用接口添加电话号码到呼叫中心黑名单，添加黑名单的电话无法打入也无法被打出。

实现流程

略

接口描述

添加黑名单接口完整URL：

http://x.x.x.x:12121/bridge/jsoncfg?opt=BLACK_LIST_ADD&json=135XXXXXXXX
字段名字段含义描述
json被添加的号码
optBLACK_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被删除的号码
optBLACK_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查询的号码非必填项，不填写则查询所有号码
optBLACK_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"}
telnumVIP客户电话号码
viplevelVIP等级，后台会根据VIP等级进行插队。例如：1等级VIP，会少排队30秒，2级少排队60秒，3级少排队90
秒。
Createtime创建的时间
des描述
optVIP_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被删除的号码
optVIP_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查询的号码非必填项，不填写则查询所有号码
optVIP_LIST_QUERY默认不要修改
x.x.x.x:12121服务器IP通讯地址12121默认端口，如果手动修改过端口号请使用修改后的端口

Http请求响应码解释：

  • 200: 操作成功
  • 400: 参数错误 VIP客户相关JSON 字符串

HTTP 来电排队监控接口

使用场景

通过接口可以了解到当前系统的排队情况。

实现流程

略

接口描述

排队监控****接口完整URL：

http://x.x.x.x:12121/bridge/callctrl?opt=QUEUE_INFO
字段名字段含义描述
optQUEUE_INFO默认不要修改
x.x.x.x:12121服务器IP通讯地址12121默认端口，如果手动修改过端口号请使用修改后的端口

Http请求响应码解释：

  • []: 无排队 有排队信息返回： {"group":"3003","count":2,"queue":{"caller":"15875566080","viplevel":0,"waitingtime":41,"target":"3003"},{"caller":"15919823608","viplevel":0,"waitingtime":1,"target":"3003"}},{"group":"3005","count":1,"queue":{"caller":"15875566081","viplevel":0,"waitingtime":41,"target":"3005"}}
字段名字段含义描述
caller客户电话号码
viplevel客户VIP等级0：表示普通用户
waitingtime等待接通时长单位:秒
target等待接入的坐席分组或者分机
x.x.x.x:12121服务器IP通讯地址12121默认端口，如果手动修改过端口号请使用修改后的端口