4.2 手动话单实时推送
4.2.1 手动外呼和呼入(多条话单逐条推送)
基本信息
Path:客户地址
Method: POST
接口描述:
将通话的多条leg的话单消息逐条推送给三方对接地址
- {
- "CallNo":"010114215011",
- "userData":{},
- "HangupDir":"1",
- "CallID":"20217090926082179125",
- "CallType":"dialout",
- "recordStartTime":" ",
- "sipId":"87666",
- "WebcallActionID":"",
- "ActionID":"",
- "RecordFile":"/app/clpms/record/20210407/154_20217090926082179125_010114215011_13366557640_20210407173344_1617788024685.wav",
- "Cause":"0",
- "Begin":"2021-04-07 17:33:48",
- "QueueTime":"",
- "AgentName":"yangsl",
- "CallState":"",
- "Queue":"通用技能组",
- "FileServer":"http://114.215.196.183:9910",
- "owner":1,
- "Agent":"1001",
- "CalledNo":"13366557640",
- "QueueEndTime":"",
- "CalledCity":"北京",
- "RingTime":"2021-04-07 17:33:44",
- "CallerProvince":"",
- "Dir":"1",
- "Exten":"1001",
- "IVRKEY":"",
- "Province":"",
- "CallerCity":"",
- "DeviceType":"2",
- "CallSheetID":"",
- "Ring":"2021-04-07 17:33:43",
- "mediano":"1",
- "End":"2021-04-07 17:34:09",
- "cmd":"manual_callcleared",
- "CalledProvince":"北京",
- "device":"20217092025593806922",
- "District":"",
- "CdrType":"0"
- }
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
CallNo | string | 非必须 | 主叫号码 | ||
userData | object | 非必须 | 随路数据 | ||
HangupDir | string | 非必须 | 挂机方向(0:坐席挂机,1:用户挂机) | ||
CallID | string | 非必须 | 通话ID,通话连接的在系统中的唯一标识。 | ||
CallType | string | 非必须 | 通话类型: dialout外呼通话,normal普通来电, transfer转接电话,dialTransfer外呼转接 | ||
WebcallActionID | string | 非必须 | 通过调用webcall接口,该字段会保存请求的actionID, 其它情况下该字段为空 | ||
ActionID | string | 非必须 | 通过接口调用时,该字段会保存请求的actionID, 其它情况下该字段为空 | ||
RecordFile | string | 非必须 | 通话录音文件名 | ||
Cause | string | 非必须 | 详见文档末<挂机原因说明> | ||
Begin | string | 非必须 | 接听时间 | ||
QueueTime | string | 非必须 | 来电进入技能组时间 | ||
AgentName | string | 非必须 | 处理坐席的姓名(郭小芳) | ||
CallState | string | 非必须 | 事件状态 | ||
Queue | string | 非必须 | 通话进入的技能组名称 | ||
FileServer | string | 非必须 | 录音文件的服务器名(http://121.40.138.123) | ||
owner | integer | 非必须 | 1-ccs;2-IVR;3-acd | ||
Agent | string | 非必须 | 处理坐席的工号(8007) | ||
CalledNo | string | 非必须 | 被叫号码 | ||
CalledCity | string | 非必须 | 被叫归属市 | ||
RingTime | string | 非必须 | 振铃时间(yyyy-MM-dd HH:mm:ss) | ||
CallerProvince | string | 非必须 | 主叫归属省 | ||
Dir | string | 非必须 | 呼叫方向:0:呼入;1:呼出 | ||
Exten | string | 非必须 | 处理坐席的工号,历史原因该字段与Agent相同 | ||
IVRKEY | string | 非必须 | 通话在系统中选择的按键菜单 | ||
Province | string | 非必须 | 目标号码的省 (呼入为来电号码,呼出为去电号码) | ||
CallerCity | string | 非必须 | 主叫归属市 | ||
DeviceType | string | 非必须 | 1座席 2用户 3被咨询座席 4被咨询用户 5被转接座席 6被转接用户 7被内呼座席 8 节假日被转接手机 9 班长 10硬话机 | ||
CallSheetID | string | 非必须 | 通话记录唯一id(2966c9e8-8066-4b91-93a9-c43c9f2f6036) | ||
Ring | string | 非必须 | 话务进入呼叫中心系统的时间 开始时间 | ||
mediano | string | 非必须 | 媒体站点号 | ||
End | string | 非必须 | 通话结束时间 | ||
CalledProvince | string | 非必须 | 被叫归属省 | ||
device | string | 非必须 | 设备编号 | ||
District | string | 非必须 | 目标号码的市 (呼入为来电号码,呼出为去电号码) | ||
CdrType | string | 非必须 | cdr类型 0 正常 1咨询 2转接 3咨询转接 4三方 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 非必须 | |||
msg | string | 非必须 |
4.2.2 手动外呼和呼入(多条话单合并推送)
基本信息
Path:客户地址
Method: POST
接口描述:
将通话的多条leg话单合并为一条话单消息推送给三方对接地址
配置方式:后台管理-推送消息-选择手动实时话单推送-推送url后缀增加两个井号
- {
- "ANI":"871556590425003",
- "DNIS":"13300010002",
- "agentTransferCount":0,
- "answerFlag":0,
- "callAnswerTime":"2021-07-05 09:56:49",
- "callEndTime":"2021-07-05 09:57:19",
- "callStartTime":"2021-07-05 09:56:46",
- "callid":"202184778147943809039",
- "deviceCount":2,
- "devices":[
- {
- "ActionID":"",
- "Agent":"1001",
- "AgentAnswerStatus":1,
- "AgentHangup":"2021-07-05 09:57:19",
- "AgentName":"TEST",
- "AgentRing":"2021-07-05 09:56:46",
- "AgentRingEnd":"2021-07-05 09:56:47",
- "AgentsipId":"871556590425003",
- "Begin":"2021-07-05 09:56:49",
- "CallID":"202184778147943809039",
- "CallNo":"1001",
- "CallState":"",
- "CallType":"dialout",
- "CalledCity":"安庆",
- "CalledNo":"13300010002",
- "CalledProvince":"安徽",
- "CallerCity":"",
- "CallerProvince":"",
- "Cause":0,
- "CdrType":0,
- "DeviceType":"2",
- "Dir":1,
- "District":"安庆",
- "End":"2021-07-05 09:57:19",
- "Exten":"1001",
- "FileServer":"http://192.168.177.183:9910",
- "HangupDir":0,
- "HangupParty":1,
- "IVRKEY":"",
- "InboundIVREndTime":"2021-07-05 09:57:19",
- "Province":"安徽",
- "Queue":"外呼技能组",
- "QueueEndTime":"2021-07-05 09:56:47",
- "QueueStatus":2,
- "QueueTime":"",
- "RecordFile":"/app/clpms/record/20210705/129_202184778147943809039_1001_13300010002_20210705095649_1625450209155.wav",
- "Ring":"2021-07-05 09:56:47",
- "RingTime":"2021-07-05 09:56:47",
- "WebcallActionID":"",
- "device":"202184779247455436832",
- "mediano":201,
- "owner":1,
- "userData":"{}"
- },
- {
- "ActionID":"",
- "Agent":"1001",
- "AgentName":"TEST",
- "Begin":"2021-07-05 09:56:47",
- "CallID":"202184778147943809039",
- "CallNo":"1001",
- "CallState":"",
- "CallType":"dialout",
- "CalledCity":"",
- "CalledNo":"871556590425003",
- "CalledProvince":"",
- "CallerCity":"",
- "CallerProvince":"",
- "Cause":0,
- "CdrType":0,
- "DeviceType":"1",
- "Dir":1,
- "End":"2021-07-05 09:57:19",
- "Exten":"1001",
- "FileServer":"http://192.168.177.183:9910",
- "HangupDir":0,
- "IVRKEY":"",
- "Queue":"外呼技能组",
- "QueueEndTime":"",
- "QueueTime":"",
- "RecordFile":"/app/clpms/record/20210705/129_202184778147943809039_1001_13300010002_20210705095649_1625450209155.wav",
- "Ring":"2021-07-05 09:56:46",
- "RingTime":"2021-07-05 09:56:46",
- "WebcallActionID":"",
- "device":"202184779247455436831",
- "mediano":201,
- "owner":1,
- "userData":"{}"
- }
- ],
- "direction":1,
- "hangupDir":1,
- "userCallDuration":30
- }
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 |
Body
字段 | 类型 | 说明 | 备注 |
callid | String | 通话唯一标识 | 通话标识 |
direction | Integer | 呼叫方向 | 0:呼入,1:外呼,2:内呼 |
ANI | String | 主叫号码 | 打入电话为主叫,打出电话为分机号 |
DNIS | String | 被叫号码 | 打入电话为被叫,打出电话为对方号码 |
callStartTime | String | 开始时间,格式(yyyy-MM-dd HH:mm:ss) | 打入或打出电话振铃时间,打出电话为坐席的外呼时间, 打入电话为客户的进入平台时间 |
callAnswerTime | String | 应答时间,格式(yyyy-MM-dd HH:mm:ss) | 打入或打出电话应答时间,打出电话为坐席的应答时间 打入电话为客户同callStartTime |
callEndTime | String | 结束时间,格式(yyyy-MM-dd HH:mm:ss) | 打入为客户的挂机时间 打出为坐席的挂机时间 |
answerFlag | Integer | 接通标识 | 0:接通 , 1:坐席未接听,用户未接听 , 2:坐席接听,用户未接听, 3:用户接听,坐席未接听。 |
deviceCount | Integer | 参与设备数 | 本次呼叫总共参与参与设备个数(含分配但未接听的坐席以及班长监听通话数) |
agentTransferCount | Integer | 转接次数 | 本次呼叫总共被坐席转移的次数(不含班长监听等通话类型) |
hangupDir | Integer | 挂机方向 | 1:主叫挂机,2:被叫挂机,3:系统挂机 |
userCallDuration | Integer | 用户通话时长 | 如果未呼通则为0 |
companyId | Integer | 企业id | 企业id |
devices | Array | 电话参与者 | 集合类型,有多少个人参与,就有多少条数据,Devices节点的排列顺序为, 客户第一条(或坐席间纯内呼模式发起呼叫的坐席第一条), 第一个参与坐席第二条,后续参与坐席顺序依次往后推 |
devices[0]├─ CallID | String | 通话ID | 通话连接的在系统中的唯一标识。 |
devices[0]├─ CallNo | String | 主叫号码 | 主叫号码 |
devices[0]├─ CallerCity | String | 主叫归属市 | 主叫归属市 |
devices[0]├─ CallerProvince | String | 主叫归属省 | 主叫归属省 |
devices[0]├─ CalledNo | String | 被叫号码 | 被叫号码 |
devices[0]├─ CalledCity | String | 被叫归属市 | (手动外呼,用户侧有)被叫归属市 |
devices[0]├─ CalledProvince | String | 被叫归属省 | (手动外呼,用户侧有)被叫归属省 |
devices[0]├─ District | String | 目标号码的市 | (手动外呼,用户侧有)呼入为来电号码,呼出为去电号码 |
devices[0]├─ Province | String | 目标号码的省 | (手动外呼,用户侧有)呼入为来电号码,呼出为去电号码 |
devices[0]├─ CallSheetID | String | 保留字段 | |
devices[0]├─ RecordFile | String | 通话录音文件名 | 录音只录一侧,推送时2侧都有 |
devices[0]├─ FileServer | String | 录音文件的服务器名 | http://121.40.138.123/ |
devices[0]├─ Ring | String | 开始时间,格式(yyyy-MM-dd HH:mm:ss) | 话务进入呼叫中心系统本设备的时间 ,即本侧呼叫的开始时间 |
devices[0]├─ RingTime | String | 振铃时间,格式(yyyy-MM-dd HH:mm:ss) | (用户侧没有)呼入客户侧振铃时间等于开始时间 |
devices[0]├─ Begin | String | 接听时间,格式(yyyy-MM-dd HH:mm:ss) | 本侧呼叫的接听时间,呼入客户侧接听时间等于开始时间 |
devices[0]├─ End | String | 结束时间,格式(yyyy-MM-dd HH:mm:ss) | 本侧呼叫的通话结束时间 |
devices[0]├─ InboundIVREndTime | String | ivr结束时间(呼入),格式(yyyy-MM-dd HH:mm:ss) | 呼入场景下,从IVR平台转接到队列或客户挂机的时间(呼入类型客户侧通话信息携带此字段) 【当前如果有QueueTime取QueueTime,如果无QueueTime则取End】 |
devices[0]├─ IVRKEY | JSONArray String | 菜单按键 | 通话在系统中选择的按键菜单 |
devices[0]├─ QueueStatus | Integer | 排队情况(目前只有0和1) | (用户侧有)当前通话排队最终情况,0当前呼叫未被分配,等待超时Abando, 1当前溢出此技能组,2分配给了坐席(最初应答技能组) |
devices[0]├─ QueueTime | String | 进队列时间 | (用户侧有)来电进入技能组进线时间(在呼入类型客户侧通话信息上此字段为本次通话客户最初应答坐席所在技能组分配时间) 【当前如果有QueueTime取QueueTime,如果无QueueTime则取AgentRing】 |
devices[0]├─ Queue | String | 技能组名称 | 当前通话进入的技能组名称 |
devices[0]├─ QueueEndTime | String | 出队列时间,格式(yyyy-MM-dd HH:mm:ss) | 呼入场景下,从ACD转接到坐席,即坐席应答或客户挂机的时间 【当前如果有AgentRingEnd取 AgentRingEnd,如果无AgentRingEnd则取End】 |
devices[0]├─ Agent | String | 坐席工号 | 当前处理坐席的工号(8007)【来电分配的第一个坐席(无论是否接听)或外呼发起坐席】 |
devices[0]├─ Exten | 保留字段 | ||
devices[0]├─ AgentName | String | 坐席昵称 | 处理坐席的姓名(郭小芳) |
devices[0]├─ AgentsipId | String | 坐席分机 | 当前处理坐席的SIP分机号 |
devices[0]├─ AgentRing | String | 坐席振铃时间,格式(yyyy-MM-dd HH:mm:ss) | 当前处理坐席的振铃时间(呼入类型客户侧通话信息携带此字段) |
devices[0]├─ AgentAnswerStatus | Integer | 坐席应答状态 | (用户侧有)0 坐席未正常通话 呼叫被放弃;1 坐席正常通话 |
devices[0]├─ AgentRingEnd | String | 振铃结束时间,格式(yyyy-MM-dd HH:mm:ss) | 第一个处理坐席的应答时间or Abandon 时间(呼入类型客户侧通话信息携带此字段) |
devices[0]├─ AgentHangup | String | 坐席挂机时间,格式(yyyy-MM-dd HH:mm:ss) | 第一个处理坐席的挂机时间or Abandon 时间(呼入类型客户侧通话信息携带此字段) |
devices[0]├─ ActionID | String | 保留字段 | |
devices[0]├─ WebcallActionID | String | 保留字段 | |
devices[0]├─ CallState | String | 事件状态 | |
devices[0]├─ CallType | String | 通话类型 | dialout外呼通话,normal普通来电,transfer转接电话,dialTransfer外呼转接 |
devices[0]├─ DeviceType | String | 角色类型 | 1座席 2用户 3被咨询座席 4被咨询用户 5被转接座席 6被转接用户 7被内呼座席 8 节假日被转接手机 9 班长 10硬话机 |
devices[0]├─ Dir | Integer | 呼叫方向 | 0:呼入;1:呼出 |
devices[0]├─ CdrType | Integer | 电话类型 | cdr类型 0 正常 1咨询 2转接 3咨询转接 4三方 |
devices[0]├─ Cause | Integer | 挂机原因 | |
devices[0]├─ HangupDir | Integer | 挂机方向 | 0:平台挂机,1:对端挂机 |
devices[0]├─ owner | Integer | 通话结束模块 | 1-ccs;2-IVR;3-acd |
devices[0]├─ mediano | Integer | 媒体站点号 | |
devices[0]├─ device | String | 设备编号 | |
devices[0]├─ userData | JSON String | 随路数据 | 都是字符类型 |
devices[0]├─ HangupParty | Integer | 挂机方向 | 1 坐席 2 用户(在客户侧通话信息携带此字段) |
devices[0]├─ EvaluationKeyContent | Integer | 客户评价 | 1.非常满意 2.满意 3.一般 4.不满意 5.非常不满意(在客户侧通话信息携带此字段) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 非必须 | |||
msg | string | 非必须 |