# v2 Integration ```markup Latest version : 2.1.25 Release date : 12/10/2025 Changelog : https://api.omicall.com/sdk/web-sdk-changelog ``` ### Hướng dẫn cài đặt ![Giao diện Dialog Call](https://3454047468-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LukDt3aTxo8xMLonIwO%2F-MaaYP_FsurjffQi9bhd%2F-MaabZGf0actFZxjALoK%2Fsdk1.png?alt=media\&token=485002ba-1655-4521-9fc7-d5533c679f11) ![Giao diện Dialog Call với Input Note mặc định](https://3454047468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LukDt3aTxo8xMLonIwO%2Fuploads%2FbBVf3Mi5SufZAuDOfDQS%2FScreen%20Shot%202022-06-26%20at%2012.14.16%20PM%20\(1\).png?alt=media\&token=865127c9-022d-458d-940c-d9e08bac4537) ![Giao diện dialog gọi với custom form data](https://3454047468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LukDt3aTxo8xMLonIwO%2Fuploads%2FNQt15sktQZgK058Ub64E%2Fnew-sdk-form-end-validate.png?alt=media\&token=d6beb6ea-5efb-4789-a351-d2ff78fe81cb) Nhúng Web SDK vào HTML của website cần tích hợp ```markup ``` {% file src="" %} File demo tích hợp SDK {% endfile %} **Phương thức** | **Phương thức** | **Mô tả** | | | | | | ---------------------------------------------------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -------- | ----- | ------------------------------------------------------------------------------------------------------------------- | | omiSDK**.init(config, callback)** | Khởi tạo các cấu hình cần thiết cho SDK và load UI nếu có truyền theme | | | | | | omiSDK.**register(params)** |

{
domain : "abc" // domain tổng dài

username: "100", // Số nội bộ

password: "\*\*\*" // Mật khẩu số nội bộ

}

\*Lưu ý: Có thể lấy các thông tin ghi danh tổng đài ở cấu hình số nội bộ hoặc thông qua API của OMICall

| | | | | | omiSDK.**unregister()** | Ngưng kết nối với tổng đài | | | | | | omiSDK.**reregister(params)** | Ngưng kết nối với tổng đài và tạo một phiên kết nối mới với params trước đó hoặc từ params mới truyền | | | | | | omiSDK.**makeCall(phone)** |

- phone:

| | | | | |

omiSDK.makeCall(phone, hotline)
or
omiSDK.makeCall(phone, options)

|

- phone:

- hotline (String): đầu số tổng đài dùng để gọi ra (\*Lưu ý: phải là đầu số cho phép gọi ra và tài khoản nhân viên thực hiện cuộc gọi được quyền sử dụng đầu số này)
- options (Object):
{
sipNumber: String,

sneakyType: String,
datas: {
'User-Data': String
}
}
+ sipNumber: như param hotline cũ
+ sneakyType: loại cuộc gọi giám giát số nội bộ khác, gồm:
> monitoring: Giám sát
> whisper: Thì thầm
> colloquy: Đàm thoại 3 bên
+ datas: dữ liệu truyền lên tổng đài để lưu thêm dữ liệu tuỳ chỉnh vào lịch sử cuộc gọi, max length của string data là 256

| | | | | | omiSDK.**stopCall**() | Từ chối cuộc gọi/ Kết thúc cuộc gọi | | | | | | omiSDK.**acceptCall**() | Chấp nhận cuộc gọi | | | | | | omiSDK.**transferCall(extension)** |

Chuyển tiếp cuộc gọi.

extension : Là số máy lẻ nhân viên cần chuyển tới
\*Lưu ý: chỉ hỗ trợ chuyển tiếp khi cuộc gọi đã được bắt máy

| | | | | | omiSDK.**sendDTMF(tone)** |

Gửi tín hiệu tương tác bấm phím

tone: các số từ 0-9 hoặc \*#

| | | | | | omiSDK.**toggleMute(status)** |

Bật tắt âm thanh từ micro của bạn

status:

| | | | | | omiSDK.**toggleHold(status)** |

Thay đổi trạng thái giữ cuộc gọi

status:

| | | | | | omiSDK.**getStatus()** |

Lấy trạng thái kết nối hiện tại của SDK với tổng đài:

| | | | | | omiSDK.**toggleDialog()** | Chủ động ẩn hiện dialog cuộc gọi của SDK nếu có sử dụng theme | | | | | | omiSDK.**isCalling**() | Trả về giá trị true/false | | | | | | omiSDK.**updateContactInfo**(Object) |

Cập nhật Tên và Avatar của khách hàng trên cửa số cuộc gọi

omiSDK.updateContactInfo({

name : "Nguyễn Thanh Sang",

avatar : "https\://...."

});

\*Giá trị avatar sẽ được truyền vào thuộc tính src của thẻ img: có thẻ là http link hoặc base64,...

| | | | | | omiSDK.**getAccessToken**() | Trả về **accessToken** của phiên kết nối tổng đài hiện tại, có thể dùng để gọi các API public của OMI | | | | | | omiSDKTheme.**setFormData**(Object) | Set value cho các text input với id tương ứng khi truyền mảng "forms" trong cấu hình | | | | | | omiSDK.**setBusy**(status) |

status (String | Boolean): inbound | outbound | local | all

Cập nhật trạng thái BUSY của SDK, được lưu trong localStorage để đồng bộ giứa các tab của trình duyệt

| | omiSDK.**isBusy**(direction) |

direction (String): nhận các giá trị của param status khi dùng omiSDK.setBusy(status) (Nếu không truyền, giá trị mặc định là inbound).
Trả về trạng thái BUSY hiện tại của SDK theo hướng cuộc gọi.

| | | | | **Dữ liệu callback từ sự kiện** | **Tham số** | **Loại** | **Mô tả** | | ------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **direction** | **String** | Hướng của cuộc gọi: **`outbound, inbound`** | | **directionTxt** | **String** | Tên hướng của cuộc gọi | | **status** | **String** | Trạng thái hiện tại của cuộc gọi: **`connecting, ringing, connected, ended, hold`** | | **statusTxt** | **String** | Tên trạng thái hiện tại của cuộc gọi | | **remoteNumber** hoặc **phone** | **String** | | | **sipDomain** | **String** | Domain tổng đài của phiên kết nối hiện tại | | **sipUser** | **String** | Số nội bộ của phiên kết nối hiện tại | | **sipNumber** | **String** | Số tổng đài đang dùng để thực hiện cuộc gọi ra hay nhận cuộc gọi tới | | **startTime** | **Date** | Thời gian bắt đầu cuộc gọi | | **answerTime** | **Date** | Thời gian bắt đầu chấp nhận cuộc gọi | | **endTime** | **Date** | Thời gian kết thúc cuộc gọi | | **endCause** | **String** |

Nguyễn nhân kết thúc cuộc gọi.

Gồm:

| | **uuid** | **String** | **Transaction ID** của cuộc gọi | | **duration** | **Number** | Thời gian gọi giữa 2 người sau khi chấp nhận cuộc gọi cho tới khi cuộc gọi kết thúc | | **durationTxt** | **String** | Thời gian gọi giữa 2 người sau khi chấp nhận cuộc gọi cho tới khi cuộc gọi kết thúc và đã được định dạng theo thời gian: **`00:00`** | | **totalDuration** | **Number** | Tổng thời gian từ khi bắt đầu thực hiện/nhận cuộc gọi tới khi kết thúc | | **ping** | **Object** | Dữ liệu về trạng thái tín hiệu của cuộc gọi | | **isAccepted** | **Boolean** | Trạng thái đã nhận cuộc gọi giữa hai bên | **Cấu hình và Sự kiện** | config.**theme** | **String** |

Giao diện dialog cuộc gọi (nếu để trống thì sẽ không có giao diện). Hoặc một trong các giá trị sau

| | | | | ----------------------------: | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | config.**debug** | **Boolean** |

Bật tắt chức năng log các sự kiện của SDK.

Mặc định: false

| | | | | config.**busy** | **Boolean** | Trạng thái cho phép thực hiện cuộc gọi ra, nhưng sẽ tự động từ chối tất cả các cuộc gọi tới | | | | | config.**language** | **String** |

Ngôn ngữ hiển thị dialog cuộc gọi mặc định của SDK.

Gồm:
"vi" : Tiếng Việt (default)
"en" : Tiếng anh

| | | | | config.**ringtoneVolume** | **Number** | Âm lượng chuông, khi khách gọi tới (từ 0 - 1) | | | | | config.**options** | **Object** |

| | config.**forms** | **Array \[Object]** |

Mảng form data tuỳ chỉnh.

\*Ví dụ:
{

id: 'address', => bắt buộc
label: 'Địa chỉ',
plh: 'Nhập địa chỉ',
multiline: true/fasle,
required: true/fasle,
className: String,
height: '200px',
}

| | | | | config.**classes** | **Object** | | | | | | config.**styles** | **Object** |

E.g. Object style:
{
'background-color': 'blue',
justifyContent: 'center',
color: 'red'
},

| | | | | config.**callbacks** | **Object** | Object chứa các event function callback | | | | | callbacks.**register** | **Function** | Sự kiện xảy ra khi trạng thái kết nối tổng đài thay đổi | | | | | callbacks.**connecting** | **Function** | Sự kiện xảy ra khi bắt đầu thực hiện cuộc gọi ra | | | | | callbacks.**invite** | **Function** | Sự kiện xảy ra khi có cuộc gọi tới | | | | | callbacks.**inviteRejected** | **Function** | Sự kiện xảy ra khi có cuộc gọi tới, nhưng bị tự động từ chối | | | | | callbacks.**ringing** | **Function** | Sự kiện xảy ra khi cuộc gọi ra bắt đầu đổ chuông | | | | | callbacks.**accepted** | **Function** | Sự kiện xảy ra khi cuộc gọi vừa được chấp nhận | | | | | callbacks.**incall** | **Function** | Sự kiện xảy ra mỗi 1 giây sau khi cuộc gọi đã được chấp nhận | | | | | callbacks.**acceptedByOther** | **Function** | Sự kiện dùng để kiểm tra xem cuộc gọi bị kết thúc, đã được chấp nhận ở thiết bị khác hay không | | | | | callbacks.**ended** | **Function** | Sự kiện xảy ra khi cuộc gọi kết thúc | | | | | callbacks.**holdChanged** | **Function** | Sự kiện xảy ra khi trạng thái giữ cuộc gọi thay đổi | | | | | callbacks.**saveCallInfo** | **Function** | Sự kiện xảy ra khi cuộc gọi đã có đổ chuông hoặc cuộc gọi tới, khi user có nhập note input mặc định hoặc form input custom | | | | | callbacks.**infoLastCall** | **Function** | Sự kiện xảy ra khi có bật options.showInfoLastCall và SDK có get được data cho số điện thoại đang gọi | | | |