接口详情
更新时间:2023-07-05
坐席接口
配置选项
属性 | 类型 | 默认值 | 描述 |
---|---|---|---|
entId | string | 企业编号,签入状态下只读 | |
agentId | string | 坐席工号,签入状态下只读 | |
agentDn | string | 坐席分机,签入状态下只读 | |
agentName | string | 坐席名称,签入状态下只读 | |
agentType | string | 5 | 坐席类型,签入状态下只读 2:外置IP电话 3:手机及固化 5:内置IP电话 默认 |
acdAgentPassword | string | 坐席密码,签入状态下只读,MD5加密 | |
agentDnPwd | string | 分机密码 | |
autoRTCAnswer | boolean | false | WebRTC SIP 是否自动应答 |
proxyUrl | string | SOCKET代理地址 | |
wsUrl | string | webSocket 地址 | |
udpUrl | string | sip 注册地址 | |
stunServers | string | ice 服务地址 |
初始化接口
接口: | initialize(data) |
---|---|
参数: | { entId: '',// 企业编号 agentId: '', // 坐席工号 agentDn: '', // 分机号 agentName: '', // 坐席名 agentType: '', // 坐席类型(2:外置IP电话3:手机及固化5:内置IP电话) acdAgentPassword: '', // 坐席密码 MD5加密 agentDnPwd: '', // 分机密码 autoRTCAnswer: false, // RTC是否自动应答 proxyUrl: '',//代理服务地址 wsUrl: '',//webSocket 服务地址 udpUrl: '',// SIP 服务地址 stunServers: ''// ICE 服务地址 } |
说明: | 初始化参数 |
功能接口
start(启动坐席端服务)
接口原型:
onAgentState(event)
事件属性:
名称 | 类型 | 说明 |
---|---|---|
sateCode | number | 状态码 0:签入 1:置闲 2:通话 3:置忙 4:振铃 5:锁定 6:事后整理 |
onAgentListData(坐席列表事件)
接口原型:
onAgentListData(event)
事件属性:
名称 | 类型 | 说明 |
---|---|---|
data | JSONArray | [ { "agentId": "1001",//坐席工号 "agentName": "调度员",//坐席名 "dn": "sip:1015",//分机号 "skillGroupName": "业务咨询,默认技能组" //技能组 } ] |
onAgentDialCallerData(获取外显号码事件)
坐席签入成功时触发此事件。
接口原型:
onAgentDialCallerData(event)
事件属性:
名称 | 类型 | 说明 |
---|---|---|
data | JSONArray | [ "tel:03162427770" ] |
onGetCallData(获取随路数据事件)
坐席签出成功时触发此事件。
接口原型:
onGetCallData(event)
事件属性:
名称 | 类型 | 说明 |
---|---|---|
data | JSON | { "msg": "操作成功", "SD": "DetectSpeech", //随路数据 "code": 200, "MessageID": "Resp_IContact_GetAssociateData" } |
事件接口
onEvent(状态变化事件)
此事件为统一的事件出口,坐席状态变化、系统状态变化等。
接口原型:
onEvent(event)
事件属性:
名称 | 类型 | 说明 |
---|---|---|
EventType | string | 事件类型,详见5.1事件属性 |
CallDetailEvent | string | 事件名称,详见5.1事件属性 |
MessageID | string | 消息ID,详见5.2 消息类型 |
SessionID | string | 通话标识 |
OrgANI | string | 原始主叫号码 |
OrgDNIS | string | 原始被叫号码 |
ANI | string | 主叫号码 |
DNIS | string | 被叫号码 |
CslANI | string | 咨询主叫号码 |
CslDNIS | string | 咨询被叫号码 |
ServiceType | string | 服务类型 (ACDService:呼出,IVRService:呼入,NoService:其他状态) |
OrgReqSkill | string | 原始请求技能(nodata:呼出,呼入: 具体的技能组 例如:业务咨询) |
ResSkill | string | 请求技能 |
CallType | string | 呼叫方向(INTERNAL:呼入, OUTBOUND:呼出) |
SessionID | string | 通话标识(格式: SessionID:企业账号) |
IVRData | string | IVR随路数据( nodata:无数据) |
AgentMessage | string | 坐席消息描述 |
bIsInfo | string | 目前无用处,忽略 |
strDestAgentID | string | 目前无用处,忽略 |
Result | number | 事件结果:0:成功,其余失败 |
webSocketSessionId | string | 事件消息标识,目前无用处,忽略 |
软电话(WebRTC)接口说明
应用情景
该软电话工具条可以实现对通话状态的显示与控制,同时依靠浏览器和电脑的语音通话设备实现通话功能。
注意:针对此模式,坐席接听方式请选择为webRTC模式,该模式下坐席登陆电话条后即可实现呼叫功能。
1.集成webRTC模式时浏览器建议用谷歌浏览器70及70版本以上
2.webRTC集成环境必须要https环境下,不支持http环境
集成指南
1)开发者集成SDK,需要先引入SDK。即在您的页面中引入如下代码:
<script src="js/SIPml-api.js"></script>
<script src="js/webrtc-phone.min.js"></script>
2)新建RTC服务对象
var webRTCClient = new webrtcPhone();
3) 初始化参数
//初始化
webRTCClient.init({
serverUrl:'127.0.0.1',//SIP服务地址
name:'1001', //分机别名
exten:'1001',//分机号
password:'123456',//分机密码
wssUrl: '127.0.0.1:2100',// WebRTC webSocket 服务地址
udpUrl: '127.0.0.1:3065',// WebRTC sip 服务地址
stunServers: '127.0.0.1:1345',// WebRTC ice服务地址
autoAnswer: false// 是否自动应答
})
功能接口
init(初始化参数)
接口: | init(data) |
---|---|
参数: | serverUrl 服务地址 name 分机别名 exten分机号 password 分机密码 wssUrl WebSocket服务地址 udpUrl SI服务地址 stunServers ICE服务地址 autoAnswer 是否自动应答 |
返回: | 无 |
说明: | 命令执行的结果应根据onEvent事件来判断 |
login(登录)
接口: | login() |
---|---|
参数: | 无 |
返回: | 无 |
说明: | 命令执行的结果应根据onEvent事件来判断 |
logout(登出)
接口: | logout () |
---|---|
参数: | 无 |
返回: | 无 |
说明: | 命令执行的结果应根据onEvent事件来判断 |
call(外呼)
接口: | call(phoneNumber) |
---|---|
参数: | phoneNumber 外呼分机号 |
返回: | 无 |
说明: | 命令执行的结果应根据onEvent事件来判断 |
answer(应答)
接口: | answer() |
---|---|
参数: | 无 |
返回: | 无 |
说明: | 命令执行的结果应根据onEvent事件来判断 |
hangup(挂断)
接口: | hangup () |
---|---|
参数: | 无 |
返回: | 无 |
说明: | 命令执行的结果应根据onEvent事件来判断 |
sipToggleMute(静音)
接口: | sipToggleMute(bMute) |
---|---|
参数: | bMute:是否静音(true:开始,false:结束) |
返回: | 无 |
说明: | 命令执行的结果应根据onEvent事件来判断 |
事件接口
onEvent(状态变化事件)
此事件为统一的事件出口,SIP状态变化等。
接口原型:
onEvent(event)
WebRTC对接常见问题
- 1.webRTC依赖于网络环境,如果网络环境不好会出现坐席状态失效的情况,可尝试刷新浏览器或更换网络,时刻观察坐席到通话服务器的网络状况。
- 2.通话时需要允许浏览器获取语音权限,否则无法正常拨打电话。同时需要保证电脑语音设备正常(可通过qq,微信语音测试是否正常),不正常可以下载驱动软件更新一下电脑声卡驱动。
## 常量属性 ### 事件状态属性~~~~
类型 | 名称 | 说明 |
EventType | AgentStatus_Connecting | 外呼对方振铃 | AgentStatus_Disconnected | 挂断事件 | AgentStatus_Connected_Normal | 通话事件 | AgentStatus_Alerting | 振铃事件 | AgentStatus_ACW | 事后整理 | AgentStatus_Ready | 坐席置闲 | AgentStatus_Otherwork | 坐席置忙 | AgentStatus_Logout | UC未登陆/登出 | AgentStatus_Suspended | 坐席保持 | AgentStatus_Login | 坐席登录 | AgentStatus_Consulted | 咨询事件 | AgentStatus_Conferenced | 会议事件 | AgentStatus_Monitored | 监听事件 | AgentStatus_Inserted | 强插事件 | CallDetailEvent | CA_CALL_EVENT_ALERTING | 呼入振铃 | CA_CALL_EVENT_CONNECTED | 呼入接通 | CA_CALL_EVENT_OP_DISCONNECT | 对方挂机 | CA_CALL_EVENT_TP_DISCONNECT | 本方挂机 | CA_CALL_EVENT_THIRD_PARTY_DISCONNECT | 第三方挂机 | CA_CALL_EVENT_FOURTH_PARTY_DISCONNECT | 第四方挂机 | CA_CALL_EVENT_HOLD | 保持 | CA_CALL_EVENT_HOLD_RETRIEVE | 保持接回 | CA_CALL_EVENT_CONSULT_CONNECTED_OP | 咨询对方接通 | CA_CALL_EVENT_CONSULT_RETRIEVE | 咨询接回 | CA_CALL_EVENT_CONFERENCE | 会议 | CA_CALL_EVENT_INTERNAL_ALERTING_TP | 内线本方振铃 | CA_CALL_EVENT_MONITOR | 监听 | CA_CALL_EVENT_INTRUDE | 强插 | CA_CALL_EVENT_TEARDOWN | 强拆 | CA_CALL_EVENT_MONITOR_ALERTING | 监听振铃 | CA_CALL_EVENT_INTERNAL_CONNECTED_TP | 内线本方接通 | CA_CALL_EVENT_CONSULT_ALERTING_TP | 咨询本方振铃 | CA_CALL_EVENT_CONSULT_CONNECTED_TP | 咨询本方应答 | CA_CALL_EVENT_OUTBOUND_ALERTING_TP | 外呼本方振铃 | CA_CALL_EVENT_OUTBOUND_CONNECTED_TP | 外呼本方接通 | CA_CALL_EVENT_CLEAR_CALL | 全拆 | CA_CALL_EVENT_OUTBOUND_ALERTING_OP | 外呼对方振铃 |
消息类型
类型 | 消息编码 | 消息说明 |
EventType | Evt_AgentStatus_Login | 登录 | Evt_AgentStatus_Logout | 登出 | Evt_AgentStatus_Otherwork | 置忙 | Evt_AgentStatus_Ready | 置闲 | Evt_AgentStatus_ACW | 事后整理 | 设备话务状态 | Evt_AgentStatus_Alerting | 振铃 | Evt_AgentStatus_Connecting | 外呼对方振铃 | Evt_AgentStatus_Connected_Normal | 双方通话 | Evt_AgentStatus_Disconnected | 挂断 | Evt_AgentStatus_Suspended | 保持 | Evt_AgentStatus_Consulted | 咨询 | Evt_AgentStatus_Conferenced | 会议 | Evt_AgentStatus_Monitored | 监听 | Evt_AgentStatus_Inserted | 强插 |
呼叫类型
编码 | 说明 |
---|---|
1 | 外部呼叫 |
呼叫方向
编码 | 说明 |
---|---|
INTERNAL | 呼入 |
OUTBOUND | 呼出 |
咨询类型
编码 | 说明 |
---|---|
1 | 内线 |
2 | 外线 |
使用操作场景