@wizai/agent-sip-sdk 0.1.15-alpha → 0.1.16-alpha

package/README.md

@@ -1,242 +1,242 @@
-# AgentSipSDK
-
-`AgentSipSDK` 是一个用于管理 SIP 客户端和坐席状态的 JavaScript 类。它封装了 SIP 和 API 调用，以便更轻松地处理坐席状态、来电、外呼和事件监听等功能。
-
-## 安装
-
-### 通过 NPM/YARN/PNPM 安装
-
-```bash
-npm install @wizai/agent-sip-sdk
-```
-
-```bash
-yarn add @wizai/agent-sip-sdk
-```
-
-```bash
-pnpm add @wizai/agent-sip-sdk
-```
-
-### 通过 `<script>` 标签引入
-
-你可以从 CDN 引入 `AgentSipSDK`，例如：
-
-```html
-<script src="https://cdn.example.com/agent-sip-sdk/latest/umd.js"></script>
-```
-
-## 使用方法
-
-### 初始化
-
-#### 通过 NPM/YARN/PNPM 安装的方式
-```typescript
-import AgentSipSDK from '@wizai/agent-sip-sdk';
-
-const options = {
-  id: '123',
-  getSystemToken: () => Promise.resolve('xxx'),
-  baseUrl: '', // 可选，默认是空，接口基础地址
-  retryCount: 0  // 可选，默认是0
-}
-const ASK = new AgentSipSDK(options);
-```
-
-#### 通过 `<script>` 标签引入的方式
-
-```html
-<script>
-const options = {
-  id: '123',
-  getSystemToken: () => Promise.resolve('xxx'),
-  baseUrl: '', // 可选，默认是空，接口基础地址
-  retryCount: 0  // 可选，默认是0
-}
-const ASK = new AgentSipSDK(options);
-</script>
-```
-### 获取坐席状态列表
-
-```typescript
-ASK.getAgentStatusList().then(({code, data}) => {
-    console.log(code);
-}).catch(() => {
-    console.log('失败');
-})
-```
-
-### 获取坐席状态
-
-```typescript
-ASK.getAgentStatus().then(({code, data}) => {
-    console.log(code);
-}).catch(() => {
-    console.log('失败');
-})
-```
-
-### 切换坐席状态 （上/下线）
-
-```typescript
-ASK.switchAgentStatus({
-  status: 1, // 1: 上线，0: 下线
-  subStatus: 'Online', // 子状态 Online | Offline | 自定义
-}).then(({code}) => {
-    console.log(code);
-}).catch(err => {
-    console.log('坐席上/下线失败', err);
-});
-```
-
-### 外呼
-
-```typescript
-/**
- *
- * @param {string} phoneNumber
- * @memberof AgentSipSDK
- */
-ASK.outboundCall('123456789').then(({code}) => {
-    console.log(code);
-}).catch(err => {
-    console.log('外呼失败', err)
-})
-```
-
-### 话后处理（ACW）
-
-```typescript
-ASK.finshACW().then(({code}) => {
-    console.log(code);
-}).catch(err => {
-    console.log('外呼失败', err)
-})
-```
-
-### 其他功能
-
-- **挂断:** `agentSipClient.hangup()`
-- **接听:** `agentSipClient.answer()`
-- **忽略:** `agentSipClient.ignore()`
-- **静音:** `agentSipClient.mute()`
-- **取消静音:** `agentSipClient.unmute()`
-
-### 事件监听
-
-#### 初始化事件
-
-```typescript
-const fn = ({code}) => {
-    console.log(code);
-}
-
-// 初始化结果事件监听
-ASK.attachInitEvent('failed', fn);
-
-// 移除事件监听
-ASK.removeInitEvent('failed', fn);
-```
-
-#### 坐席事件
-
-```typescript
-const fn = ({code}) => {
-    console.log(code);
-}
-
-// 坐席事件监听
-ASK.attachAgentEvent('online', fn);
-
-// 移除事件监听
-ASK.removeAgentEvent('online', fn);
-```
-
-#### 来电事件
-
-```typescript
-const fn = ({code, data}) => {
-    // data 通话详情信息
-    console.log('来电啦');
-}
-// 来电呼入事件监听
-ASK.attachAnswerEvent(fn);
-
-// 移除事件监听
-ASK.removeAnswerEvent(fn);
-```
-
-#### 新消息事件
-
-```typescript
-const fn = ({code, data}) => {
-    // data 详情信息
-    console.log('来电啦');
-}
-// 新消息事件监听
-ASK.attachNewMessageEvent(fn);
-
-// 移除事件监听
-ASK.removeNewMessageEvent(fn);
-```
-
-#### 会话事件
-
-- `success`: 通话接听成功
-- `failed`: 通话接听失败/拒接
-- `ended`:通话结束
-
-```typescript
-const fn = () => {
-    
-}
-
-// 通话事件监听
-ASK.attchSessionEvent('success', fn);
-
-// 移除事件监听
-ASK.removeSessionEvent('success', fn);
-```
-
-
-## API 参考
-
-
-### 方法
-
-- `getAgentStatusList()`: 获取坐席状态列表。
-- `getAgentStatus()`: 获取当前坐席状态。
-- `switchAgentStatus(data)`: 切换坐席状态。
-- `outboundCall(phoneNumber)`: 发起外呼。
-- `hangup()`: 挂断。
-- `answer()`: 接听。
-- `ignore()`: 拒接。
-- `mute()`: 静音。
-- `unmute()`: 取消静音。
-- `processAfterCall(data)`: ACW。
-- `attachInitEvent(type, listener)`: 添加初始化事件监听器。
-- `removeInitEvent(type, listener)`: 移除初始化事件监听器。
-- `attachAgentEvent(type, listener)`: 添加坐席事件监听器。
-- `removeAgentEvent(type, listener)`: 移除坐席事件监听器。
-- `attachAnswerEvent(listener)`: 添加来电事件监听器。
-- `removeAnswerEvent(listener)`: 移除来电事件监听器。
-- `attachNewMessageEvent(listener)`: 添加新消息事件监听器。
-- `removeNewMessageEvent(listener)`: 移除新消息事件监听器。
-- `attchSessionEvent(type, listener)`: 添加会话事件监听器。
-- `removeSessionEvent(type, listener)`: 移除会话事件监听器。
-
-## 注意事项
-
-- 确保所有 API 调用成功返回，否则可能会导致坐席状态不一致。
-
-## 贡献
-
-欢迎提出问题和提交 PR，以帮助改进此类。
-
-## 许可证
-
-MIT
-
----
-
+# AgentSipSDK
+
+`AgentSipSDK` 是一个用于管理 SIP 客户端和坐席状态的 JavaScript 类。它封装了 SIP 和 API 调用，以便更轻松地处理坐席状态、来电、外呼和事件监听等功能。
+
+## 安装
+
+### 通过 NPM/YARN/PNPM 安装
+
+```bash
+npm install @wizai/agent-sip-sdk
+```
+
+```bash
+yarn add @wizai/agent-sip-sdk
+```
+
+```bash
+pnpm add @wizai/agent-sip-sdk
+```
+
+### 通过 `<script>` 标签引入
+
+你可以从 CDN 引入 `AgentSipSDK`，例如：
+
+```html
+<script src="https://cdn.example.com/agent-sip-sdk/latest/umd.js"></script>
+```
+
+## 使用方法
+
+### 初始化
+
+#### 通过 NPM/YARN/PNPM 安装的方式
+```typescript
+import AgentSipSDK from '@wizai/agent-sip-sdk';
+
+const options = {
+  id: '123',
+  getSystemToken: () => Promise.resolve('xxx'),
+  baseUrl: '', // 可选，默认是空，接口基础地址
+  retryCount: 0  // 可选，默认是0
+}
+const ASK = new AgentSipSDK(options);
+```
+
+#### 通过 `<script>` 标签引入的方式
+
+```html
+<script>
+const options = {
+  id: '123',
+  getSystemToken: () => Promise.resolve('xxx'),
+  baseUrl: '', // 可选，默认是空，接口基础地址
+  retryCount: 0  // 可选，默认是0
+}
+const ASK = new AgentSipSDK(options);
+</script>
+```
+### 获取坐席状态列表
+
+```typescript
+ASK.getAgentStatusList().then(({code, data}) => {
+    console.log(code);
+}).catch(() => {
+    console.log('失败');
+})
+```
+
+### 获取坐席状态
+
+```typescript
+ASK.getAgentStatus().then(({code, data}) => {
+    console.log(code);
+}).catch(() => {
+    console.log('失败');
+})
+```
+
+### 切换坐席状态 （上/下线）
+
+```typescript
+ASK.switchAgentStatus({
+  status: 1, // 1: 上线，0: 下线
+  subStatus: 'Online', // 子状态 Online | Offline | 自定义
+}).then(({code}) => {
+    console.log(code);
+}).catch(err => {
+    console.log('坐席上/下线失败', err);
+});
+```
+
+### 外呼
+
+```typescript
+/**
+ *
+ * @param {string} phoneNumber
+ * @memberof AgentSipSDK
+ */
+ASK.outboundCall('123456789').then(({code}) => {
+    console.log(code);
+}).catch(err => {
+    console.log('外呼失败', err)
+})
+```
+
+### 话后处理（ACW）
+
+```typescript
+ASK.finshACW().then(({code}) => {
+    console.log(code);
+}).catch(err => {
+    console.log('外呼失败', err)
+})
+```
+
+### 其他功能
+
+- **挂断:** `agentSipClient.hangup()`
+- **接听:** `agentSipClient.answer()`
+- **忽略:** `agentSipClient.ignore()`
+- **静音:** `agentSipClient.mute()`
+- **取消静音:** `agentSipClient.unmute()`
+
+### 事件监听
+
+#### 初始化事件
+
+```typescript
+const fn = ({code}) => {
+    console.log(code);
+}
+
+// 初始化结果事件监听
+ASK.attachInitEvent('failed', fn);
+
+// 移除事件监听
+ASK.removeInitEvent('failed', fn);
+```
+
+#### 坐席事件
+
+```typescript
+const fn = ({code}) => {
+    console.log(code);
+}
+
+// 坐席事件监听
+ASK.attachAgentEvent('online', fn);
+
+// 移除事件监听
+ASK.removeAgentEvent('online', fn);
+```
+
+#### 来电事件
+
+```typescript
+const fn = ({code, data}) => {
+    // data 通话详情信息
+    console.log('来电啦');
+}
+// 来电呼入事件监听
+ASK.attachAnswerEvent(fn);
+
+// 移除事件监听
+ASK.removeAnswerEvent(fn);
+```
+
+#### 新消息事件
+
+```typescript
+const fn = ({code, data}) => {
+    // data 详情信息
+    console.log('来电啦');
+}
+// 新消息事件监听
+ASK.attachNewMessageEvent(fn);
+
+// 移除事件监听
+ASK.removeNewMessageEvent(fn);
+```
+
+#### 会话事件
+
+- `success`: 通话接听成功
+- `failed`: 通话接听失败/拒接
+- `ended`:通话结束
+
+```typescript
+const fn = () => {
+    
+}
+
+// 通话事件监听
+ASK.attchSessionEvent('success', fn);
+
+// 移除事件监听
+ASK.removeSessionEvent('success', fn);
+```
+
+
+## API 参考
+
+
+### 方法
+
+- `getAgentStatusList()`: 获取坐席状态列表。
+- `getAgentStatus()`: 获取当前坐席状态。
+- `switchAgentStatus(data)`: 切换坐席状态。
+- `outboundCall(phoneNumber)`: 发起外呼。
+- `hangup()`: 挂断。
+- `answer()`: 接听。
+- `ignore()`: 拒接。
+- `mute()`: 静音。
+- `unmute()`: 取消静音。
+- `processAfterCall(data)`: ACW。
+- `attachInitEvent(type, listener)`: 添加初始化事件监听器。
+- `removeInitEvent(type, listener)`: 移除初始化事件监听器。
+- `attachAgentEvent(type, listener)`: 添加坐席事件监听器。
+- `removeAgentEvent(type, listener)`: 移除坐席事件监听器。
+- `attachAnswerEvent(listener)`: 添加来电事件监听器。
+- `removeAnswerEvent(listener)`: 移除来电事件监听器。
+- `attachNewMessageEvent(listener)`: 添加新消息事件监听器。
+- `removeNewMessageEvent(listener)`: 移除新消息事件监听器。
+- `attchSessionEvent(type, listener)`: 添加会话事件监听器。
+- `removeSessionEvent(type, listener)`: 移除会话事件监听器。
+
+## 注意事项
+
+- 确保所有 API 调用成功返回，否则可能会导致坐席状态不一致。
+
+## 贡献
+
+欢迎提出问题和提交 PR，以帮助改进此类。
+
+## 许可证
+
+MIT
+
+---
+
 感谢使用 `AgentSipSDK`！希望它能对你的项目有所帮助。