0.1.3 • Published 11 months ago

yb-xcti-sdk-v2 v0.1.3

Weekly downloads
-
License
-
Repository
-
Last release
11 months ago

ybcti-js-sdk-v2

使用

安装

通过npm进行安装

npm install yb-xcti-sdk-v2 -S

引用

// 在main.js文件中
import YBCTI from 'yb-xcti-sdk-v2';
Vue.use(YBCTI);
<!-- vue组件中 -->
<yb-cti />或 <yb-cti></yb-cti>

支持环境

  • 推荐使用chrome浏览器

开始

库加载后,会在全局注入一个实例对象window.ybcti,window.ybcti包含了初始化,坐席操作和事件监听方法。

初始化

初始化使用示例

window.ybcti.initCTI(params).then(res => {
  console.log(res)
}).catch(err => {
  console.log(err)// 0.0.4新增错误信息
})

参数对象params

参数类型是否必选描述
requestIdString请求ID
channelIdString合作渠道 ID
accessTokenString客户端接入 Token
accountString用户标识
secretKeyString密钥
environment'test'、'production'环境(0.0.4新增)

返回字段说明

参数类型说明
codeNumber结果码
messageString返回结果描述

坐席操作

外呼

外呼使用示例

window.ybcti.callOut(params).then(res => {
  console.log(res)
}).catch(err => {
  console.log(err)// 0.0.4新增错误信息
})

参数对象params

参数类型是否必选描述
customIdString线索Id
callModeNumber1、 自动号码外呼(推荐)2、 使用上次呼叫号码呼叫 3、 兜底号码外呼

返回字段说明

参数类型说明
codeNumber结果码
messageString返回结果描述
dataObjectcallId
paramsObject外呼信息

挂断

挂断使用示例

window.ybcti.hangup().then(res => {
    console.log(res)
})

签出

window.ybcti.logout(params)

参数对象params

参数类型是否必选描述
logoutTypeNumber可选签出类型 枚举值 1 : 完全退出 2:仅退出动态模式(默认)

返回字段说明

参数类型说明
codeNumber结果码
messageString返回结果描述

事件

注意:必须开启all监听后才能开启对其他子事件的监听。

事件监听方法

/**
 * params  eventName/eventType
 * cb1     成功回调函数
 * cb2     错误回调函数
 */
window.ybcti.listenEvent(params, cb1, cb2)

事件使用示例,以 all 事件为例

<script>
  window.ybcti.listenEvent('all', (res) => {
    console.log(res)
    // phoneRingCalled
    // phoneConnect
  }, (err) => {
    console.log(err)
  })
</script>

事件表

顶层事件

eventName描述
all所有状态
wsws连接状态
phone电话状态
agent坐席状态
initstatewebsocket重连更新状态
ivrivr状态
update更新状态
error错误状态

phone子事件

eventName描述
phoneHangup通话完成
phoneCallOut外呼中
phoneRing来电振铃
phoneConnect通话中
phoneSelfConnect己方接通
phoneConsultOut咨询外呼中
phoneConsultConnect咨询接通
phoneConsultBack咨询接回
phoneConsultFail咨询未呼通
phone3WaySuccess三方接通
phone3WayBack三方接回
phoneChanSPYSuccess监听成功
phoneBreakinSuccess强插成功
phoneTransferSuccess转接成功
phoneInterceptSuccess拦截成功
phoneTransfer电话转接

phoneRing子事件

eventName描述
phoneRingCalled被叫
phoneRingQueue技能组分配来电
phoneRingOutbound外呼来电
phoneRingChanSPY监听来电
phoneRingConsult咨询来电
phoneRingAutoCall自动外呼来电

agent子事件

eventName描述
agentLogout被签出
agentUnbusy空闲
agentSysBusy忙碌
agentSysUnbusy空闲
agentSysOccupy系统占用
agentSysAftDeal事后处理

update子事件

eventName描述
updateQueue技能组
updateCaller主叫号码

error子事件

eventName描述产生场景
errorLogoff强制退出后台进行强制签出时会收到此事件
errorUnbusy强制置闲后台进行强制置闲时会收到此事件
errorBusy强制置忙后台进行强制置忙时会收到此事件
forceLogoff超时退出当签入类型为动态坐席时,websocket连接由于网络异常等原因断开连接超过1分钟后,此时服务端会认为此坐席已经签出,此时websocket再重新连接上后会收到此事件,但是SDK会自动进行重连并自动签入
0.1.0

11 months ago

0.1.2

11 months ago

0.1.1

11 months ago

0.0.9

11 months ago

0.1.3

11 months ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago