call-control-sdk 5.2.4 → 5.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A lightweight SDK that provides a **draggable call control panel** and utility hooks for managing calls in real-time. Built with **TypeScript**, **Material-UI**, and designed for **agent productivity**.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
#### ✨ Features
|
|
6
6
|
|
|
7
7
|
- 🎯 **Complete Call Control** – Hold, Mute, Status management, and End Call
|
|
8
8
|
- 🖱️ **Draggable Interface** – Movable panel with persisted position
|
|
@@ -15,19 +15,19 @@ A lightweight SDK that provides a **draggable call control panel** and utility h
|
|
|
15
15
|
|
|
16
16
|
[](https://bundlephobia.com/package/call-control-sdk)
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
##### 📦 Installation
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
21
|
npm install call-control-sdk
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
###### 🔑 Peer Dependencies
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
27
|
npm install react react-dom axios @mui/material @mui/icons-material @emotion/react @emotion/styled
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
##### 📚 Table of Contents
|
|
31
31
|
|
|
32
32
|
1. [Getting Started](#-getting-started)
|
|
33
33
|
2. [Core API](#-core-api)
|
|
@@ -42,7 +42,7 @@ npm install react react-dom axios @mui/material @mui/icons-material @emotion/rea
|
|
|
42
42
|
6. [Browser Support](#-browser-support)
|
|
43
43
|
7. [License](#-license)
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
##### 🚀 Getting Started
|
|
46
46
|
|
|
47
47
|
### 1. Initialize the SDK
|
|
48
48
|
|
|
@@ -126,7 +126,7 @@ export default function EndCallButton() {
|
|
|
126
126
|
}
|
|
127
127
|
```
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
##### 🛠 Core API
|
|
130
130
|
|
|
131
131
|
### `initSDK(config)`
|
|
132
132
|
|
|
@@ -162,7 +162,7 @@ Update call data programmatically.
|
|
|
162
162
|
| `callReferenceId?` | string | Unique call reference |
|
|
163
163
|
| `agentLoginId?` | string | Agent login identifier |
|
|
164
164
|
|
|
165
|
-
|
|
165
|
+
##### 🪝 Hooks
|
|
166
166
|
|
|
167
167
|
### `useLogout()`
|
|
168
168
|
|
|
@@ -188,7 +188,7 @@ Hook for ending an active call.
|
|
|
188
188
|
| `error` | any | Error object if failed |
|
|
189
189
|
| `data` | any | API response on success |
|
|
190
190
|
|
|
191
|
-
|
|
191
|
+
##### 📦 Payloads
|
|
192
192
|
|
|
193
193
|
### `EndCallPayload`
|
|
194
194
|
|
|
@@ -204,7 +204,7 @@ interface EndCallPayload {
|
|
|
204
204
|
- **Call Controls**: Hold / Resume, Mute / Unmute, End Call, Agent Status
|
|
205
205
|
- **Persistent State**: Hold, mute, agent status, panel position, call timer
|
|
206
206
|
|
|
207
|
-
|
|
207
|
+
##### 🌍 Browser Support
|
|
208
208
|
|
|
209
209
|
- ✅ Chrome 60+
|
|
210
210
|
- ✅ Firefox 60+
|
|
@@ -213,6 +213,6 @@ interface EndCallPayload {
|
|
|
213
213
|
|
|
214
214
|
---
|
|
215
215
|
|
|
216
|
-
|
|
216
|
+
##### 📄 License
|
|
217
217
|
|
|
218
218
|
MIT © 2025 [](#-license)
|