call-control-sdk 6.2.2 → 6.2.4
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 +64 -49
- package/package.json +1 -1
- package/LICENSE.res +0 -96
package/README.md
CHANGED
|
@@ -1,25 +1,70 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Call Control SDK
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/call-control-sdk)
|
|
6
6
|
[](https://www.npmjs.com/package/call-control-sdk)
|
|
7
7
|
[](https://bundlephobia.com/package/call-control-sdk)
|
|
8
8
|
[](https://github.com/your-org/call-control-sdk/blob/main/LICENSE)
|
|
9
9
|
|
|
10
|
-
**A powerful, lightweight SDK for real-time call management
|
|
11
|
-
|
|
12
|
-
[📖 Documentation](#-documentation) • [🚀 Quick Start](#-quick-start) • [💡 Examples](#-examples) • [🔧 API Reference](#-api-reference)
|
|
10
|
+
**A powerful, lightweight SDK for real-time call management**
|
|
13
11
|
|
|
12
|
+
</div>
|
|
13
|
+
<div align="center">
|
|
14
|
+
🔑 **AUTHORIZED ACCESS REQUIRED** - API Key & Tenant ID
|
|
14
15
|
</div>
|
|
15
16
|
|
|
17
|
+
### 🔑 **License Features**
|
|
18
|
+
|
|
19
|
+
- **API Key Authentication** - Secure access through authorized API keys
|
|
20
|
+
- **Tenant ID Management** - Multi-tenant support with isolated access
|
|
21
|
+
- **Cross-Platform Support** - Use across web, mobile, desktop, and server platforms
|
|
22
|
+
- **Usage Monitoring** - Real-time tracking and compliance monitoring
|
|
23
|
+
- **Flexible Deployment** - Deploy on authorized platforms with proper credentials
|
|
24
|
+
|
|
25
|
+
### 🔒 **Access Requirements**
|
|
26
|
+
|
|
27
|
+
To use this SDK, you must have:
|
|
28
|
+
|
|
29
|
+
- ✅ **Valid API Key** - Issued by CTI SDK Team
|
|
30
|
+
- ✅ **Active Tenant ID** - Registered and in good standing
|
|
31
|
+
- ✅ **Active Subscription** - Current and compliant
|
|
32
|
+
- ✅ **Authorized Platform** - Using on approved platforms only
|
|
33
|
+
|
|
34
|
+
### 🚫 **Prohibited Activities**
|
|
35
|
+
|
|
36
|
+
- **No Unauthorized Access** - Cannot use without valid credentials
|
|
37
|
+
- **No Credential Sharing** - API keys and tenant IDs are confidential
|
|
38
|
+
- **No Reverse Engineering** - Cannot decompile or reverse engineer
|
|
39
|
+
- **No Platform Violations** - Must use only on authorized platforms
|
|
40
|
+
- **No Usage Abuse** - Cannot exceed subscription limits
|
|
41
|
+
|
|
42
|
+
## **Unauthorized access or misuse may result in immediate termination and legal action.**
|
|
43
|
+
|
|
44
|
+
## 📑 Table of Contents
|
|
45
|
+
|
|
46
|
+
- [✨ Key Features](#-key-features)
|
|
47
|
+
- [📦 Installation](#-installation)
|
|
48
|
+
- [🚀 Quick Start](#-quick-start)
|
|
49
|
+
- [1️⃣ Initialize the SDK](#1️⃣-initialize-the-sdk)
|
|
50
|
+
- [2️⃣ Add Call Control Panel](#2️⃣-add-call-control-panel)
|
|
51
|
+
- [3️⃣ Use Call Management Hooks](#3️⃣-use-call-management-hooks)
|
|
52
|
+
- [🔧 Configuration Options](#-configuration-options)
|
|
53
|
+
- [📚 API Reference](#-api-reference)
|
|
54
|
+
- [🔧 Core Functions](#-core-functions)
|
|
55
|
+
- [🪝 React Hooks](#-react-hooks)
|
|
56
|
+
- [📦 Data Types](#-data-types)
|
|
57
|
+
- [🎛 Control Features](#-control-features)
|
|
58
|
+
- [🌍 Browser Support](#-browser-support)
|
|
59
|
+
- [📄 License](#-license)
|
|
60
|
+
|
|
16
61
|
---
|
|
17
62
|
|
|
18
63
|
## ✨ Key Features
|
|
19
64
|
|
|
20
65
|
<table>
|
|
21
66
|
<tr>
|
|
22
|
-
<td width="
|
|
67
|
+
<td width="100%">
|
|
23
68
|
|
|
24
69
|
### 🎯 **Complete Call Control**
|
|
25
70
|
|
|
@@ -29,7 +74,9 @@
|
|
|
29
74
|
- End call with disposition
|
|
30
75
|
|
|
31
76
|
</td>
|
|
32
|
-
|
|
77
|
+
</tr>
|
|
78
|
+
<tr>
|
|
79
|
+
<td width="100%">
|
|
33
80
|
|
|
34
81
|
### 🖱️ **Intuitive Interface**
|
|
35
82
|
|
|
@@ -41,7 +88,7 @@
|
|
|
41
88
|
</td>
|
|
42
89
|
</tr>
|
|
43
90
|
<tr>
|
|
44
|
-
<td width="
|
|
91
|
+
<td width="100%">
|
|
45
92
|
|
|
46
93
|
### 💾 **Smart State Management**
|
|
47
94
|
|
|
@@ -51,7 +98,9 @@
|
|
|
51
98
|
- Cross-component sync
|
|
52
99
|
|
|
53
100
|
</td>
|
|
54
|
-
|
|
101
|
+
</tr>
|
|
102
|
+
<tr>
|
|
103
|
+
<td width="100%">
|
|
55
104
|
|
|
56
105
|
### 🎨 **Modern Design**
|
|
57
106
|
|
|
@@ -78,10 +127,14 @@ npm install call-control-sdk
|
|
|
78
127
|
|
|
79
128
|
Make sure you have these peer dependencies installed:
|
|
80
129
|
|
|
130
|
+
<div align="center">
|
|
131
|
+
|
|
81
132
|
```bash
|
|
82
133
|
npm install react react-dom axios @mui/material @mui/icons-material @emotion/react @emotion/styled
|
|
83
134
|
```
|
|
84
135
|
|
|
136
|
+
</div>
|
|
137
|
+
|
|
85
138
|
---
|
|
86
139
|
|
|
87
140
|
## 🚀 Quick Start
|
|
@@ -372,18 +425,11 @@ interface EndCallPayload {
|
|
|
372
425
|
- **Agent Status** - Maintains current status across sessions
|
|
373
426
|
- **Call State** - Preserves hold/mute states
|
|
374
427
|
|
|
375
|
-
### 🎨 **UI Features**
|
|
376
|
-
|
|
377
|
-
- **Draggable Panel** - Moveable interface with position memory
|
|
378
|
-
- **Touch Support** - Works on desktop and mobile devices
|
|
379
|
-
- **Responsive Design** - Adapts to different screen sizes
|
|
380
|
-
- **Material-UI** - Consistent, accessible design system
|
|
381
|
-
|
|
382
428
|
---
|
|
383
429
|
|
|
384
430
|
## 🌍 **Browser Support**
|
|
385
431
|
|
|
386
|
-
<div align="
|
|
432
|
+
<div align="left">
|
|
387
433
|
|
|
388
434
|
| Browser | Version | Status |
|
|
389
435
|
| ----------------------------------------------------------------------------- | ------- | ------------ |
|
|
@@ -402,38 +448,7 @@ interface EndCallPayload {
|
|
|
402
448
|
|
|
403
449
|
**REDIX LICENSE** © 2025
|
|
404
450
|
|
|
405
|
-
[]
|
|
407
|
-
|
|
408
|
-
🔑 **AUTHORIZED ACCESS REQUIRED** - API Key & Tenant ID Based
|
|
451
|
+
[]
|
|
452
|
+
[]
|
|
409
453
|
|
|
410
454
|
</div>
|
|
411
|
-
|
|
412
|
-
### 🔑 **Redix License Features**
|
|
413
|
-
|
|
414
|
-
This software uses a **Redix-based licensing system** that provides:
|
|
415
|
-
|
|
416
|
-
- **API Key Authentication** - Secure access through authorized API keys
|
|
417
|
-
- **Tenant ID Management** - Multi-tenant support with isolated access
|
|
418
|
-
- **Cross-Platform Support** - Use across web, mobile, desktop, and server platforms
|
|
419
|
-
- **Usage Monitoring** - Real-time tracking and compliance monitoring
|
|
420
|
-
- **Flexible Deployment** - Deploy on authorized platforms with proper credentials
|
|
421
|
-
|
|
422
|
-
### 🔒 **Access Requirements**
|
|
423
|
-
|
|
424
|
-
To use this SDK, you must have:
|
|
425
|
-
|
|
426
|
-
- ✅ **Valid API Key** - Issued by CTI SDK Team
|
|
427
|
-
- ✅ **Active Tenant ID** - Registered and in good standing
|
|
428
|
-
- ✅ **Active Subscription** - Current and compliant
|
|
429
|
-
- ✅ **Authorized Platform** - Using on approved platforms only
|
|
430
|
-
|
|
431
|
-
### 🚫 **Prohibited Activities**
|
|
432
|
-
|
|
433
|
-
- **No Unauthorized Access** - Cannot use without valid credentials
|
|
434
|
-
- **No Credential Sharing** - API keys and tenant IDs are confidential
|
|
435
|
-
- **No Reverse Engineering** - Cannot decompile or reverse engineer
|
|
436
|
-
- **No Platform Violations** - Must use only on authorized platforms
|
|
437
|
-
- **No Usage Abuse** - Cannot exceed subscription limits
|
|
438
|
-
|
|
439
|
-
**Unauthorized access or misuse may result in immediate termination and legal action.**
|
package/package.json
CHANGED
package/LICENSE.res
DELETED
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
REDIX SOFTWARE LICENSE AGREEMENT
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 CTI SDK Team. All rights reserved.
|
|
4
|
-
|
|
5
|
-
IMPORTANT: READ CAREFULLY BEFORE USING THIS SOFTWARE
|
|
6
|
-
|
|
7
|
-
This software and associated documentation files (the "Software") are proprietary
|
|
8
|
-
and confidential. The Software is licensed, not sold, to you by CTI SDK Team
|
|
9
|
-
("Licensor") under the terms of this Redix-based license agreement.
|
|
10
|
-
|
|
11
|
-
1. GRANT OF LICENSE
|
|
12
|
-
Subject to the terms and conditions of this agreement, Licensor hereby grants
|
|
13
|
-
you a limited, non-exclusive, non-transferable license to use the Software
|
|
14
|
-
solely through authorized API keys and tenant IDs across different platforms
|
|
15
|
-
as specified in your subscription agreement.
|
|
16
|
-
|
|
17
|
-
2. AUTHORIZED ACCESS REQUIREMENTS
|
|
18
|
-
You may use the Software ONLY when:
|
|
19
|
-
- You possess a valid, authorized API key issued by Licensor
|
|
20
|
-
- You have a valid tenant ID registered with Licensor
|
|
21
|
-
- Your subscription is active and in good standing
|
|
22
|
-
- You are using the Software on authorized platforms only
|
|
23
|
-
|
|
24
|
-
3. PLATFORM RESTRICTIONS
|
|
25
|
-
The Software may be used on the following authorized platforms:
|
|
26
|
-
- Web applications (browser-based)
|
|
27
|
-
- Mobile applications (iOS/Android)
|
|
28
|
-
- Desktop applications (Windows/macOS/Linux)
|
|
29
|
-
- Server-side applications (Node.js/Python/Java)
|
|
30
|
-
- Cloud platforms (AWS/Azure/GCP) - with prior written consent
|
|
31
|
-
|
|
32
|
-
4. PROHIBITED ACTIVITIES
|
|
33
|
-
You may NOT:
|
|
34
|
-
- Use the Software without valid API key and tenant ID
|
|
35
|
-
- Share, transfer, or distribute your API key or tenant ID
|
|
36
|
-
- Reverse engineer, decompile, or disassemble the Software
|
|
37
|
-
- Create derivative works or modifications
|
|
38
|
-
- Use the Software on unauthorized platforms
|
|
39
|
-
- Exceed the usage limits defined in your subscription
|
|
40
|
-
- Attempt to circumvent API rate limits or security measures
|
|
41
|
-
|
|
42
|
-
5. API KEY AND TENANT ID MANAGEMENT
|
|
43
|
-
- API keys and tenant IDs are confidential and must be protected
|
|
44
|
-
- You are responsible for maintaining the security of your credentials
|
|
45
|
-
- Report any suspected compromise immediately to Licensor
|
|
46
|
-
- Licensor reserves the right to revoke access at any time
|
|
47
|
-
- Unauthorized use of credentials may result in immediate termination
|
|
48
|
-
|
|
49
|
-
6. USAGE MONITORING AND COMPLIANCE
|
|
50
|
-
- Licensor may monitor usage patterns and API calls
|
|
51
|
-
- You must comply with all usage limits and restrictions
|
|
52
|
-
- Excessive or suspicious usage may trigger security reviews
|
|
53
|
-
- Non-compliance may result in immediate license termination
|
|
54
|
-
|
|
55
|
-
7. PLATFORM-SPECIFIC TERMS
|
|
56
|
-
- Each platform may have additional terms and conditions
|
|
57
|
-
- Platform-specific features may require separate authorization
|
|
58
|
-
- Cross-platform data sharing must comply with privacy regulations
|
|
59
|
-
- Third-party integrations require prior written approval
|
|
60
|
-
|
|
61
|
-
8. OWNERSHIP AND INTELLECTUAL PROPERTY
|
|
62
|
-
The Software and all intellectual property rights remain the exclusive
|
|
63
|
-
property of Licensor. This license does not grant you any ownership rights.
|
|
64
|
-
|
|
65
|
-
9. CONFIDENTIALITY
|
|
66
|
-
The Software contains confidential and proprietary information. You agree to:
|
|
67
|
-
- Maintain strict confidentiality of all Software components
|
|
68
|
-
- Not disclose API keys, tenant IDs, or Software details to third parties
|
|
69
|
-
- Use reasonable care to protect against unauthorized access
|
|
70
|
-
- Report any security breaches immediately
|
|
71
|
-
|
|
72
|
-
10. TERMINATION
|
|
73
|
-
This license is effective until terminated. Licensor may terminate this
|
|
74
|
-
license immediately if you breach any terms. Upon termination, you must:
|
|
75
|
-
- Cease all use of the Software immediately
|
|
76
|
-
- Destroy all copies of the Software
|
|
77
|
-
- Return or destroy all API keys and credentials
|
|
78
|
-
- Provide certification of compliance upon request
|
|
79
|
-
|
|
80
|
-
11. NO WARRANTY
|
|
81
|
-
THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
82
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY,
|
|
83
|
-
FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.
|
|
84
|
-
|
|
85
|
-
12. LIMITATION OF LIABILITY
|
|
86
|
-
IN NO EVENT SHALL LICENSOR BE LIABLE FOR ANY DAMAGES WHATSOEVER ARISING
|
|
87
|
-
OUT OF THE USE OR INABILITY TO USE THE SOFTWARE.
|
|
88
|
-
|
|
89
|
-
13. GOVERNING LAW
|
|
90
|
-
This agreement shall be governed by and construed in accordance with the
|
|
91
|
-
laws of [Your Jurisdiction].
|
|
92
|
-
|
|
93
|
-
By using this Software, you acknowledge that you have read this agreement,
|
|
94
|
-
understand it, and agree to be bound by its terms and conditions.
|
|
95
|
-
|
|
96
|
-
REDIX LICENSE VERSION 1.0 - Effective Date: January 1, 2025
|