PitelSDK Web
Bạn có thể chạy thử nghiệm SDK bằng cách sử dụng SDK Playground tại đây.
Để sử dụng PitelSDK cho ứng dụng, có thể thực hiện các bước đơn giản sau:
- Đăng nhập vào portal
- Chọn project đã tạo trước đây
- Chọn API_KEY đã tạo trước đó và copy đoạn Embed code nhúng vào website trước thẻ đóng </body>
- Trong project, sau khi đã chứng thực và nhận được Token từ BACKEND, khởi tạo và sử dụng PitekSDK
let pitelSDK = new PitelSDK(API_KEY, pitelToken, sipUsername, sipDelegates, sdkOptions)
Trong đó:
API_KEY: API_KEY đã tạo trên portal
pitelToken: token được tạo ra sau khi chứng thực
sipUsername: Sip account
sipDelegates: Một object gồm các hàm callback để nhận các sự kiện được trả về từ SDK. Các hàm này là tùy chọn.
sipOptions: Các tùy chọn cấu hình SDK gồm:
- Các thông tin cấu hình cơ bản:
| Thuộc tính | Kiểu dữ liệu | Mặc định | Chi tiết |
|---|---|---|---|
| enableWidget | boolean | true | Sử dụng hoặc không sử dụng widget |
| sipOnly | boolean | true | Tùy chọn sử dụng SDK thông qua pitel portal hoặc sip account. Nếu sipOnly=True, Vui lòng sử dụng API_KEY="d1ca84ac-2d98-4faa-92d4-699a6ce14eb7" |
| sipDomain | string | Thông tin sip domain (Sử dụng khi sipOnly=true) | |
| wsServer | string | Thông tin websocket (Sử dụng khi sipOnly=true) | |
| sipPassword | string | Thông tin sip password (Sử dụng khi sipOnly=true) | |
| debug | boolean | false | Bật chế độ debug. Chế độ debug sẽ cho phép SDK gửi thông tin debug trên console |
- Các thông tin cấu hình nâng cao:
| Thuộc tính | Kiểu dữ liệu | Mặc định | Chi tiết |
|---|---|---|---|
| dtmfUseRfc | boolean | true | Sử dụng RFC 2833 khi gửi DTMF. |
| contactName | string | Thêm thông tin contact name khi đăng ký | |
| viaHost | string | Thêm thông tin via host khi đăng ký | |
| expires | number | 600 | Thêm thông tin expires khi đăng ký |
| extraContactHeaders | array | Thêm thông tin extra contact headers khi đăng ký |
const sipDelegates = {
onRegistered: function() {
console.log('SIP Register success!')
//Demo call out, make sure SIP already registered
pitelSDK.call('502');
},
onUnregistered: function() {
console.log('SIP Unregister success!')
},
onCallReceived: function(remoteNumber) {
//do something
}
}
let pitelSDK = new PitelSDK(API_KEY, pitelToken, sipUsername, sipDelegates, sdkOptions)
Các hàm Delegates:
Các sự kiện được gọi thông qua delegates mô tả như bảng sau:
| Tên hàm | Tham số | Chi tiết |
|---|---|---|
| onRegistered | ||
| onUnregistered | Được gọi khi hủy đăng ký SIP thành công | |
| onCallReceived | remoteNumber: số điện thoại hoặc số nội bộ đầu xa | |
| onCallCreated | remoteNumber: số điện thoại hoặc số nội bộ đầu xa | |
| onCallAnswered | Được gọi khi cuộc gọi thông thoại | |
| onCallHangup | Được gọi khi cuộc gọi kết thúc | |
| onCallHold | held: true (tạm dừng), false (tiếp tục) | Được gọi khi cuộc gọi tạm dừng hoặc tiếp tục |
| onCallMute | isMuted: true (mic đang tắt), false (mic đang bật) | Được gọi khi thay đổi trạng thái microphone |
Các phương thức:
PitelSDK Web hỗ trợ các phương thức sau:
| Tên hàm | Tham số | Chi tiết |
|---|---|---|
| call | number: number, options: object | Thực hiện cuộc gọi đến số number; options là một object có thể chứa các tùy chọn khi gọi như { extraHeaders: [], earlyMedia: true } |
| unregister | Hủy đăng ký | |
| reject | Từ chối cuộc gọi đến | |
| accept | Trả lời cuộc gọi đến | |
| hangup | Kế thúc cuộc gọi | |
| mute | Tạm tắt kênh thoại chiều truyền đi, vẫn nghe âm thanh từ phía còn lại | |
| unmute | Mở lại kênh thoại truyền đi, âm thanh 2 chiều | |
| hold | Tạm dừng cuộc gọi | |
| unhold | Tiếp tục cuộc gọi sau khi tạm dừng | |
| dtmf | key: string | Gửi phím DTMF khi đang trong cuộc gọi. Chấp nhận [0-9*#] |
| setSilentMode | on: boolean | Bật / tắt chế độ im lặng. Trong chế độ im lặng, phím bấm và cuộc gọi đến sẽ không có âm báo. |