1 推送接口概述
推送消息示例
{ "messageType": "callEvent", "eventName": "initiated", "appSid": "3000000", "agentNo": "2002", "data":
{ "conversationSid":"...",
...
}
}
推送消息根据事件类型分为两类
事件类型 | messageType |
---|
呼叫事件 | callEvent |
坐席状态事件 | statusEvent |
2 呼叫事件(CallEvent)
参数说明如下:
参数 | 说明 |
---|
eventName | initiated, ringing, answered, completed, failed |
appSid | 应用id |
agentNo | 坐席号 |
|
|
agentNumber | 坐席号码 |
conversationSid | 会话id |
callSid | 呼叫id |
failedCause | failed, no-answer, canceled,time-out |
completedCause | time-limit |
callType | 呼叫类型。1:拨号呼入、2:后台外呼、3:拨号外呼、4:点击外呼 |
callSubtype | 呼叫子类型。1-呼叫用户;2-呼叫坐席 |
callState | 呼叫状态:idle,ringing,connected, |
userNumber | 用户号码。来电呼入或外呼的用户号码 |
userArea | 用户号码归属地信息 |
isBridged | callStatus="answered"且isBridged="0"表示应答未桥接 |
coAgentNo | 合作坐席,用于咨询转接等场景 |
userData | 自定义数据 |
timestamp | 时间戳 |
2.1 eventName与failedCause说明
eventName值 | 说明 |
---|
"initiated" | 呼叫发起 |
"ringing" | 被叫振铃 |
"answered" | 被叫应答 |
"completed" | 呼叫结束 |
"failed" | 呼叫失败 |
failedCause值 | 说明 |
---|
"failed" | 呼叫失败-呼出失败 |
"no-answer" | 呼叫失败-无应答 |
"canceled" | 呼叫失败-取消 |
"time-out" | 呼叫失败-超时 |
2.2 callType与callSubtype组合
callSubtype/callType
cst/ct | 1-拨号呼入 | 2-后台外呼 | 3-拨号外呼 | 4-点击外呼 |
---|
1-呼叫用户 |
|
| M | M |
2-呼叫坐席 | M | M |
| O |
3-转接 | O | O | O | O |
4-咨询 | O | O | O | O |
3 坐席状态事件 StatusEvent
参数说明如下:
参数 | 说明 |
---|
eventName | "login","pause","ready","autoReady","completed","unregistered" |
appSid | 应用id |
agentNo | 坐席号 |
|
|
workStatus | 座席工作状态:"ready","pause" |
pauseCause | 暂停原因(workStatus=pause时有效) |
readyCause | 就绪原因(workStatus=ready时有效) |
timestamp | 时间戳 |
事件说明
事件 | eventName值 | workStatus值 |
---|
座席登入 | "login" | 由座席login操作传入的workStatus参数值确定 |
座席暂停 | "pause" | "pause" |
座席就绪 | "ready" | "ready" |
通话结束 | "completed" | "pause"(需要座席手动就绪) |
SIP终端未注册 | "unregistered" | 空(保持当前状态),或"pause"(需要座席手动恢复就绪) |