批量外呼回访接口

批量外呼-查询外呼任务

使用场景

当需要使用批量外呼时，首先需要查询后台设置的批量外呼任务信息，才能决定后续的号码导入到哪一个外呼任务中呼叫。

实现流程

略

接口描述

http://x.x.x.x:xx/bridge/jsoncfg?opt=BatchCallMonitor_GET_ALL_RUN_TASK_INFO&json=GET_ALL_RUN_TASK_INFO
字段名字段含义描述
opt=BatchCallMonitor_GET_ALL_RUN_TASK_INFO固定值表示获取所有已经配置好的外呼任务
x.x.x.x:xx呼叫中心服务器的IP和端口

接口响应

[{
  "id": 1,
  "calltaskid": 1,
  "chnltype": 1,
  "outgwgrp": "3000",
  "extgrp": "3003",
  "starttime": "1899-12-30 16:00:00",
  "taskstate": 3,
  "des": "小额贷款机器人",
  "owerid": 1,
  "createtime": "2018-11-16 16:11:56",
  "gwintervaltime": 0,
  "intervaltime": 1.0,
  "precallcount": 0,
  "timeslot": "",
  "smsoffon": false,
  "smsplaylen": 0,
  "smscontent": "",
  "smssubscriber": ""
}]

返回的是一个JSON对象组 Id： 任务编号，后续导入数据需要使用 Des：任务标题或描述，用于方便操作人员在前端识别和选择任务

批量外呼任务-导入号码接口

使用场景

当您的系统需要批量拨打客户号码放音通知客户时，或者需要批量拨打电话转坐席接听时。可预先使用呼叫中心的助手软件设置好流程，使用该接口导入号码，驱动呼叫。

实现流程

略

接口描述

导入号码支持http-post请求

http://x.x.x.x:12121/bridge/batchcallimport
字段名字段含义描述
URLhttp://x.x.x.x:12121/bridge/batchcallimport请使用 post 提交 json 格式的数据
bodyUTF-8编码的 json 数据字符串字符串格式参考下面定义
x.x.x.x呼叫中心服务器的IP

Json 格式定义

{
  "runtaskid": 100,
  "telnums": [{
    "telnum": "1322784XXXX",
    "ctname": "",
    "des": ""
  }, {
    "telnum": "13227841199",
    "ctname": "测试用户",
    "des": ""
  }]
}
字段名字段含义描述
runtaskid批量外呼任务编号请在电话助手批量外呼任务管理中查找需要使用的任务编号
telnums需要导入的号码列表
telnum客户号码
ctname客户名称
des描述

Http请求响应：

  • 400: 参数错误
  • 404：无法找到相关外呼任务
  • 402: 未开通机器人
  • 500: 系统内部错误
  • 200: 导入成功

● 清除导入数据(含呼叫结果，请小心使用)

http://x.x.x.x:12121/bridge/jsoncfg?opt=BatchCallClear&json=26

批量外呼-启动外呼任务接口

使用场景

启动批量外呼任务。

实现流程

略

接口描述

http://127.0.0.1:12121/bridge/jsoncfg?opt=BatchCallStart&json=26
字段名字段含义描述
json请填写外呼任务的编号请在电话助手批量外呼任务管理中查找需要使用的任务编号
optopt=BatchCallStart启动批量外呼任务，请不要变动
x.x.x.x呼叫中心服务器的IP

Http请求响应：

  • 200: 启动成功
  • 202：已经被启动，不需要重复操作
  • 400:: 参数错误
  • 404: 根据编号找不到需要启动的任务
  • 500: 系统内部错误

批量外呼-停止外呼任务接口

使用场景

停止批量外呼任务。

实现流程

略

接口描述

http://127.0.0.1:12121/bridge/jsoncfg?opt=BatchCallStop&json=26
字段名字段含义描述
json请填写外呼任务的编号请在电话助手批量外呼任务管理中查找需要使用的任务编号
optopt=BatchCallStop停止批量外呼任务，请不要变动
x.x.x.x呼叫中心服务器的IP

Http请求响应：

  • 200: 启动成功
  • 404: 根据编号找不到需要停止的任务

批量外呼-呼叫状态监控接口

使用场景

批量外呼开始后，使用该接口监控批量外呼任务的外呼实时情况。

实现流程

略

接口描述

http://127.0.0.1:12121/bridge/jsoncfg?opt=BatchCallMonitorInfo_GET&json=26

注：建议刷新不要太频繁，2秒以上时间间隔比较合适。

字段名字段含义描述
json请填写外呼任务的编号请在批量外呼任务中查找需要使用的任务编号
optopt=BatchCallMonitorInfo_GET获取当前指定外呼任务的呼叫状态
x.x.x.x呼叫中心服务器的IP

Http请求响应：

  • 404: 根据编号找不到需要监控的任务
  • 成功返回：
{
  "talkingCount": 1,
  "customerRingCount": 1,
  "extRingCount": 0,
  "musiCount": 0,
  "queuingCount": 0,
  "idleExtCount": 0,
  "phoneCount": 19,
  "phoneCalledCount": 2,
  "coustomers": [{
    "callid": "89b11bfa-dbcc-4e2e-a81c-6305017918b4%40192.168.1.82",
    "telnum": "13227841200",
    "state": "EARLY",
    "talktime": 19
  }],
  "assises": [{
    "telnum": "13227841199",
    "extnum": "808",
    "state": "CONFIRMED",
    "duration": 4
  }]
}
字段名字段含义描述
talkingCount正在与坐席通话中的数量
customerRingCount客户正在振铃的数量
extRingCount坐席分机正在振铃的数量
musiCount在收听放音的客户的数量
queuingCount转坐席后，坐席全忙，排队的数量
idleExtCount空闲坐席分机的数量
phoneCount已导入客户号码总数
phoneCalledCount已拨打的客户号码的数量
coustomers客户侧呼叫状态明细组
---- callid呼叫编号无实际用处，可忽略
---- telnum客户号码
---- state呼叫客户号码的状态EARLY: 已振铃
CONFIRMING: 已接通,但是尚未进入语音交互
CONFIRMED: 已接听
BATCH_CALL_AI: 与AI机器人沟通中
---- talktime接通时长（秒）
assises客户接通电话转坐席后状态明细组
---- telnum客户号码
---- extnum坐席分机号码
---- state通话状态EARLY：分机振铃
CONFIRMED: 分机已接听
---- duration通话时长

批量外呼-号码数据查询接口

使用场景

使用该接口查询相关批量外呼数据。

实现流程

略

接口描述

查询条件，JSON格式的字符串，如下：

{
  "runtaskid": 1,
  "pageIndex": 0,
  "maxResults": 100,
  "timetype": 0,
  "beginTime": "2020-06-10 16:35:00",
  "endTime": "2020-06-10 18:35:00",
  "callstate": -1,
  "telnum": "13227000001",
  "extnums": ["801", "802", "803"],
  "dtmfkey": "1",
  "playduration": 0,
  "callduration": 0,
  "exeptCalled": 0,
  "aievaluate": 5
}
字段名字段含义描述
runtaskid任务编号
pageIndex分页页码
maxResults单次查询最大返回数据条数
timetype查询时间类型0: 按导入 1:按呼叫 2:按归档
beginTime开始时间格式：yyyy-MM-dd HH:mm:ss
endTime结束时间格式：yyyy-MM-dd HH:mm:ss
callstate呼叫状态-1: 不限
0: 初始状态
1: 呼叫完成
2: 呼叫失败
3: 号码不存在
4: 等待呼叫 (中间状态,非最终状态)
5: 客户忙
6: 暂时无法接通
7: 加错了或者未加长途前缀
8: 坐席漏接
9: 欠费停机
10: 振铃超时
11: 本地卡欠费停机
12: 振铃后拒接
13: 在黑名单中
14: 线路忙
15: TTS失败
16: ASR服务不可用
telnum客户号码不填写，则查询所有
extnums相关分机号码不填写，则查询所有
playduration最短放音时长0：表示不作为条件查询
callduration通话时长0：表示不作为条件查询
exeptCalled忽略已呼叫号码0：表示不作为条件查询，1：忽略已呼叫号码
aievaluate客户号码沟通后机器人评分用于AI机器人外呼的号码质量评价

总数量查询：

http://x.x.x.x:12121/bridge/jsoncfg?opt=Taskphone_GET_COUNT&json=查询条件

该查询会自动忽略：pageIndex和maxResults条件

{"conditionCount": 100, "totalCount": 200, "calledCount": 50}
字段名字段含义描述
conditionCount根据条件查询的数量
totalCount任务中号码总数量
calledCount已呼叫的数量

数据查询：

http://x.x.x.x:12121/bridge/jsoncfg?opt=Taskphone_GET_CONDITION&json=查询条件

返回JSON格式的数据

字段名字段含义描述
json请填写外呼任务的编号请参考上面查询条件描述
optopt=Taskphone_GET_CONDITION获取当前指定外呼任务的呼叫状态
x.x.x.x呼叫中心服务器的IP

Http请求响应：

  • 404: 根据条件无法查询出数据
  • 成功返回：JSON数据列表

返回数据字段说明：

字段名字段含义描述
runtaskid任务编号
telnum客户号码
ctname客户名称
des客户描述
times呼叫次数
callid呼叫ID
callstate呼叫状态参考上面查询条件，呼叫状态描述
manustate人工分类话务员接听后，手动归类
writing人工通话备注
linktime呼叫时间
createtime导入时间
playtimes放音次数
playduration放音时长
dtmfkey客户按键信息
callduration通话时长