@zhaokun/cti 1.3.3 → 1.4.3

package/README.md

@@ -0,0 +1,371 @@
+# 呼叫中心 ZHAOKUN-CTI-SDK
+
+### 安装
+
+#### Script 标签引入
+
+```
+<script src="./zhaokun.cti.min.js"></script>
+```
+
+#### NPM 安装
+
+```
+npm i @zhaokun/cti
+```
+
+### 使用
+
+#### 初始化(签入)
+
+```
+var content = null
+function init() {
+  // 实例化成功后会自动签入 调用
+  content = new zhaokunCTI({
+    webrtc: true, // 必填 是否是webrtc
+    token: "", // 必填 接口获取的token
+    agent: "", // 必填 坐席工号
+    account: "", // 必填 分机号
+    socket: "", // 必填 socket连接地址
+    env: "", // debug 打印日志
+    aiDenoise: false, // ai 降噪开关
+    aiDenoisePath: "https://www.example.com/denoiser.wasm", // 可访问的文件地址，文件在https://www.npmjs.com/package/@zhaokun/cti?activeTab=code latest文件夹里面的denoiser.wasm
+  })
+
+  content.onmessage(function (obj) {
+    console.log("收到数据", obj)
+    // 具体返回类型参考下方【onmessage 事件响应格式】
+    const type = obj.type // 消息类型
+    const data = obj.data // 消息数据
+  })
+
+  // socket 连接成功
+  content.onopen(function () {
+    console.log("onopen")
+  })
+
+  // 获取在线时间
+  content.onlinetime(function (time) {
+    console.log("onlinetime", time)
+  })
+
+	// 实时权限检测
+  content.onpermission(function (permission) {
+    // console.log("onpermission", permission)
+    {
+        "microphone": true // 麦克风是否开启 true false
+    }
+  })
+
+  // socket 连接错误
+  content.onerror(function (e) {
+    console.log("onerror", e)
+  })
+
+  // socket 连接断开
+  content.onclose(function () {
+    console.log("onclose")
+  })
+
+  // 错误事件
+  content.error(function (e) {
+    console.log("error", e)
+  })
+
+  // 初始化（自动签入）
+  content.agent.start()
+
+}
+
+init()
+```
+
+[onmessage 事件响应格式](#onmessage-事件响应格式)
+
+#### 签出
+
+```
+content.agent.logout()
+```
+
+#### 呼叫
+
+```
+content.agent.call({
+  customer: "", // 手机号或分机号
+  relayNumber: "", // 主叫号码（中继号码）
+  custom: "", // 业务编号(长度限制32位字母数字组成)
+})
+```
+
+#### 挂机
+
+```
+content.agent.hangup()
+```
+
+#### 呼入接听
+
+```
+content.agent.answer()
+```
+
+#### 保持
+
+```
+content.agent.hold()
+```
+
+#### 取消保持
+
+```
+content.agent.unhold()
+```
+
+#### 开启手机接听
+
+```
+content.agent.mobileAnswer({
+  status: 1,
+  relayNumber: "", // 主叫号码（中继号码）
+})
+```
+
+#### 取消手机接听
+
+```
+content.agent.mobileAnswer({
+  status: 0,
+  relayNumber: "", // 主叫号码（中继号码）
+})
+```
+
+#### 转接
+
+```
+content.agent.transfer({
+  customer: "", // 手机号或分机号
+  relayNumber: "", // 主叫号码（中继号码）
+})
+```
+
+#### 转到队列（技能组）
+
+```
+content.agent.transferQueue("")
+```
+
+#### 询问开始
+
+```
+content.agent.threeWayStart({
+  customer: "", // 手机号或分机号
+  relayNumber: "", // 主叫号码（中继号码）
+})
+```
+
+#### 询问取消
+
+```
+content.agent.consultCancel()
+```
+
+#### 询问确定
+
+```
+content.agent.consultTransfer()
+```
+
+#### DTMF
+
+```
+content.agent.keyup("1") // 按键值(0-9*#)
+```
+
+#### 三方开始
+
+```
+content.agent.threeWayStart({
+  customer: "", // 手机号或分机号
+  relayNumber: "", // 主叫号码（中继号码）
+})
+```
+
+#### 取消三方
+
+```
+content.agent.threeWayCancel()
+```
+
+#### 评价
+
+```
+content.agent.grade()
+```
+
+#### 主叫号码（中继号）列表
+
+```
+content.agent.relayList()
+```
+
+#### 队列（技能组）列表
+
+```
+content.agent.queueList()
+```
+
+#### 获取系统信息
+
+```
+content.tool.getSystemInfo()
+// 返回格式
+{
+    "type": "SystemInfo",
+    "code": 200,
+    "data": {
+        "browser": {
+            "name": "Chrome", // 浏览器名称
+            "version": "133.0" // 版本
+        },
+        "support": {
+            "webrtc": true, // true false 浏览器是否支持webrtc
+            "websocket": true // true false 浏览器是否支持websocket
+        }
+    }
+}
+```
+
+#### 检测麦克风
+
+```
+content.tool.checkMicrophoneStatus()
+// 返回数据
+{
+    "type": "CheckMicrophoneStatus",
+    "code": 200, // 200 成功 其他失败
+    "message": "麦克风已开启"
+}
+```
+
+#### 获取默认媒体设备
+
+```
+content.tool.getDefaultMedia()
+{
+    "type": "DefaultMedia",
+    "code": 200,
+    "data": {
+    // 默认麦克风设备
+        "input": {
+            "deviceId": "default",
+            "kind": "audioinput",
+            "label": "默认 - 外置麦克风 (Built-in)", // 设备名称
+            "groupId": "775636b3e17f56abe21a8c2ed7f4dbfca3dbb2882ce75034541d45226e43c335"
+        },
+        // 默认扬声器
+        "output": {
+            "deviceId": "default",
+            "kind": "audiooutput",
+            "label": "默认 - 外置耳机 (Built-in)",// 设备名称
+            "groupId": "775636b3e17f56abe21a8c2ed7f4dbfca3dbb2882ce75034541d45226e43c335"
+        }
+    }
+}
+```
+
+####
+
+### onmessage-事件响应格式
+
+#### 中继号码消息(响应)
+
+| 参数名称      | 类型   | 描述      |
+| ------------- | ------ | --------- |
+| type          | string | RelayList |
+| data          | object |           |
+| └ relay400    | string | 400号码   |
+| └ relayName   | string | 中继名称  |
+| └ relayNumber | string | 中继号码  |
+
+#### 队列列表消息(响应)
+
+| 参数名称 | 类型   | 描述      |
+| -------- | ------ | --------- |
+| type     | string | QueueList |
+| data     | object |           |
+| └ id     | string | 队列ID    |
+| └ title  | string | 队列名称  |
+
+#### 号码属地消息(响应)
+
+| 参数名称   | 类型   | 描述         |
+| ---------- | ------ | ------------ |
+| type       | string | RegionInfo   |
+| data       | object |              |
+| └ channel  | string | 运营商       |
+| └ zone     | string | 区号         |
+| └ code     | string | 行政区域代码 |
+| └ province | string | 省           |
+| └ city     | string | 市           |
+
+#### 账号签出(响应)
+
+| 参数名称 | 类型   | 描述   |
+| -------- | ------ | ------ |
+| type     | string | Logout |
+| data     | object |        |
+
+#### 坐席状态消息(响应)
+
+| 参数名称  | 类型    | 描述                                        |
+| --------- | ------- | ------------------------------------------- |
+| type      | string  | Status                                      |
+| data      | object  |                                             |
+| └ uid     | integer | 账号ID                                      |
+| └ account | string  | 话机账号                                    |
+| └ status  | integer | 状态(1空闲2忙碌3小休4振铃5通话6保持7后处理) |
+| └ time    | integer | 状态时间(10位时间戳)                        |
+
+#### 电话振铃(响应)
+
+| 参数名称       | 类型    | 描述                 |
+| -------------- | ------- | -------------------- |
+| type           | string  | Ring                 |
+| data           | object  |                      |
+| └ id           | string  | 电话UUID             |
+| └ uid          | integer | 账号ID               |
+| └ type         | integer | 电话类型(1呼出0呼入) |
+| └ customer     | string  | 客户号码             |
+| └ relay400     | string  | relay400             |
+| └ transferType | string  | 转接类型             |
+| └ transferFrom | string  | 转接来源             |
+| └ custom       | string  | 业务编号             |
+
+#### 三方/询问(响应)
+
+| 参数名称 | 类型   | 描述                                              |
+| -------- | ------ | ------------------------------------------------- |
+| type     | string | TransferResult                                    |
+| data     | object |                                                   |
+| └ type   | string | 类型(threeway三方consult询问)                     |
+| └ result | string | 结果(start开始 cancel取消 transfer转接answer应答) |
+
+#### 状态恢复(响应)
+
+| 参数名称   | 类型    | 描述                 |
+| ---------- | ------- | -------------------- |
+| type       | string  | Resume               |
+| data       | object  |                      |
+| └ id       | string  | 电话UUID             |
+| └ uid      | integer | 账号ID               |
+| └ type     | integer | 电话类型(1呼出0呼入) |
+| └ customer | string  | 客户号码             |
+
+#### 通用错误消息(响应)
+
+| 参数名称 | 类型   | 描述     |
+| -------- | ------ | -------- |
+| type     | string | Error    |
+| data     | string | 错误消息 |

package/index.d.ts

@@ -0,0 +1,36 @@
+export interface CTIConfig {
+  webrtc: boolean;
+  token: string;
+  agent: string;
+  account: string;
+  socket: string;
+  env?: string;
+}
+
+export interface CTIMessage {
+  type: string;
+  data: any;
+}
+
+export interface Agent {
+  start(): void;
+  call(params: { phone: string; relayNumber?: string }): void;
+  answer(): void;
+  hangup(): void;
+  hold(): void;
+  unhold(): void;
+  transfer(params: { phone: string }): void;
+  mobileAnswer(params: { status: number; relayNumber?: string }): void;
+}
+
+export default class zhaokunCTI {
+  constructor(config: CTIConfig);
+  agent: Agent;
+  onmessage(callback: (message: CTIMessage) => void): void;
+  onopen(callback: (event: any) => void): void;
+  onerror(callback: (error: any) => void): void;
+  onclose(callback: (event: any) => void): void;
+  onlinetime(callback: (time: string) => void): void;
+  onpermission(callback: (permission: any) => void): void;
+  error(callback: (error: any) => void): void;
+}

package/latest/index.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8">
@@ -134,6 +134,11 @@
       <div class="item">
         <button id="customHandle">自定义发送</button>
       </div>
+
+      <div class="item">
+        <button id="aiDenoiseOpen">ai降噪开启</button>
+        <button id="aiDenoiseClose">ai降噪关闭</button>
+      </div>
     </div>
 
     <div style="color: #f56c6c">
@@ -157,11 +162,13 @@
       // 实例化成功后会自动签入 调用
       content = new zhaokunCTI({
         webrtc: true, // 必填 是否是webrtc
-        token: "your_token", // 必填 接口获取的token
-        agent: "your_agent", // 必填 坐席工号
-        account: "your_account", // 必填 分机号
-        socket: "your_socket", // 必填 socket连接地址
-        env: "1", // debug 打印日志
+        token: "", // 必填 接口获取的token
+        agent: "", // 必填 坐席工号
+        account: "", // 必填 分机号
+        socket: "", // 必填 socket连接地址
+        aiDenoise: false, // ai 降噪开关
+        aiDenoisePath: "", // ai 降噪的文件
+        env: "", // debug 打印日志
       })
 
       // content.onmessage(function (obj) {
@@ -196,6 +203,10 @@
         // console.log("onlinetime", time)
         $("#onlinetime").html(time)
       })
+      content.onaidenoise(function (status) {
+        // 设置成功以后会在下次通话生效
+        console.log("降噪状态:", status) // true / false
+      })
       // content.onlinetime(function (time) {
       //   console.log("onlinetime2", time)
       // })
@@ -270,6 +281,13 @@
       })
     }
 
+    $("#aiDenoiseOpen").click(() => {
+      content.tool.setAiDenoise(true)
+    })
+    $("#aiDenoiseClose").click(() => {
+      content.tool.setAiDenoise(false)
+    })
+
     $("#hold").click(() => {
       // 保持
       content.agent.hold()