# 呼叫中心API开发指南
# 注意事项
浏览器支持:IE8/IE9/IE10/IE11/Edge、Chrome、Firefox、Safari
WEBRTC登陆方式请使用Chrome或者Firefox浏览器并使用HTTPS协议
# 安装
# NPM
npm install 7moor-softphone-sdk
import Softphone from '7moor-softphone-sdk'
var vm = new Softphone ({
// 参数
})
# 免开发版
<script src="https://ccjs.7moor.com/sdk/moor-sdk-global.js"></script>
<script>
window.moorSimpleSoftphone.init({
accountId: '账户编号',
username: '座席账号',
password: '密码',
loginType: 'sip/Local/gateway',
pbxUrl: 'proxy_url'
})
</script>
# 创建一个 Softphone 实例
每个 Softphone 应用都是通过用 Softphone
函数创建一个新的 Softphone 实例开始的:
var vm = new Softphone (Object object)
# 参数
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
accountId | string | — | — | 是 | 账户编号 |
agentNumber | string | — | — | 是 | 座席账号 |
password | string | — | — | 是 | 座席密码 |
loginType | string | Local / sip / gateway | Local | 否 | 登陆类型 1.手机、3.WEBRTC、3.SIP话机 |
proxy_url | string | — | — | 否 | pbx地址 |
success | function | — | — | 否 | 座席初始化成功的回调函数 |
error | function | — | — | 否 | 座席初始化异常的回调函数 |
# 绑定通话事件
vm.attachEvent(Object object)
# 参数
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 事件绑定通道建立成功回调 |
message | function | — | — | 否 | 通话事件回调 具体看res.event参数说明 |
error | function | — | — | 否 | 事件绑定异常回调 主要是底层链接ws的异常回调 |
# object.message 回调函数
# 参数
# Object res.event
名称 | 类型 | 说明 |
---|---|---|
type | string | 事件类型 unregister:未注册、kick:被踢、peerstate:座席状态、dialing:呼叫中、innerTalking: 呼入通话、dialTalking:外呼通话 dialing:外呼振铃 belling:来电振铃 innerBelling:内线振铃 dialTransfer:外呼转接通话 threeWayTalking: 三方会话 |
typeValue | string | 座席状态值 0:空闲、1:忙碌 |
LinkedChannel | Object | 通话状态数据 |
# callApi
# 外呼
vm.callApi.dialout(Object object)
# 参数
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
calleeNumber | string | — | — | 是 | 外呼号码 |
success | function | — | — | 否 | 外呼成功回调 |
fail | function | — | — | 否 | 外呼失败回调 |
# 挂断
vm.callApi.hangup(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 挂机成功回调 |
fail | function | — | — | 否 | 挂机失败回调 |
# 保持
vm.callApi.hold(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 取消保持
vm.callApi.unhold(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 转接
vm.callApi.transfer(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
TransferNumber | string | — | — | 是 | 转接号码 |
type | string | in/out | — | 否 | in代表转内线 out代表转外线 |
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 取消转接
vm.callApi.canceltransfer(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 咨询
vm.callApi.consult(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
ConsultNumber | string | — | — | 是 | 转接号码 |
type | string | in/out | — | 否 | in代表转内线 out代表转外线 |
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 取消咨询
vm.callApi.cancelconsult(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 结束咨询
vm.callApi.endconsult(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 转移咨询
vm.callApi.transferconsult(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 三方通话
vm.callApi.threewaycall(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 三方通话
vm.callApi.threewaycall(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 获取三方通话用户
vm.callApi.getthreewaycalluser(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 获取转满意度列表
vm.callApi.getInvestigateList(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 转满意度评价
vm.callApi.transferSatisfaction(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 获取IVR列表
vm.callApi.getIvrMenuList(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
# 转IVR
vm.callApi.toIvrMenu(Object object)
# Object object
属性 | 类型 | 可选值 | 默认值 | 必填 | 说明 |
---|---|---|---|---|---|
success | function | — | — | 否 | 调用成功回调 |
fail | function | — | — | 否 | 调用失败回调 |
座席API →