HƯỚNG DẪN TÍCH HỢP STRINGEE SDK

VỚI HỆ THỐNG TỔNG ĐÀI VPBX CỦA VHT

1. Đăng ký tổng đài.

Vui lòng đăng ký mới tổng đài tại trang web https://vcall.vht.com.vn/
Sau khi đăng ký xong bạn sẽ nhận được thông tin đăng nhập gồm user, password
của các số nội bộ (máy nhánh) qua email.

URL : https://acd.vht.com.vn
Email : <Email đã đăng ký>
Pasword : <Mật khẩu đã đăng ký>

Nếu bạn đã có thông tin tài khoản vào trang web quản trị tổng đài, vui lòng đăng
nhập vào trang quản trị để xem thông tin đăng nhập của số nôi bộ. Bạn có thể
tham khảo hướng dẫn tại https://docs.vht.com.vn.

Ví dụ một thông tin đang nhập của số nội bộ gồm :

User Name : 100

Authen Name : VPBX_ABCDE_100
Authen Pass : 123qweX123
Server : voip.vht.com.vn

2. Tải Stringee SDK và sample code

Bắt đầu tải Stringee SDK từ trang chủ stringee
https://developer.stringee.com/download
Để tham khảo cách xây dựng sản phẩm từ SDK này bạn có thể tải sample code tại :
+ Web SDK : https://github.com/stringeecom/web-sdk-samples
+ IOS SDK : https://github.com/stringeecom/ios-sdk-samples
+ Android SDK : https://github.com/stringeecom/android-sdk-samples
Tham khảo hướng dẫn sử dụng Stringee SDK :
+ Web : https://developer.stringee.com/docs/web-api-reference
+ IOS : https://developer.stringee.com/docs/ios-api-reference
+ Android : https://developer.stringee.com/docs/android-api-reference
 3. Lấy token
Để có thể kết nối và sử dụng Stringee SDK, bạn phải có thông tin token đê chứng
thực.
Thông thường thông tin token này phải đăng ký tài khoản Stringee mới có được
nhưng hệ thống tổng đài VPBX của VHT đã tích hợp kết nối với Stringee SDK
nên bạn không cần phải đăng ký tài khoản Stringee nữa.
Thay vào đó bạn có thể sử dụng thông tin đăng nhập số nội bộ (máy nhánh) ở mục
1 để lấy tocken kết nối Stringee SDK tương ứng theo API sau :

● API request :
❏ Method : POST
❏ URL : https://acd-api.vht.com.vn/rest/softphones/login
❏ Content-Type : application/json
❏ Body :

{
"username" : "VPBX_TTAO_100",
"password" : "4yitVgike1InA"
}

● Api response :

❏ Success :

{
"account": {
"vpbx": "VPBX_TTAO",
"extension": "100"
},
"token":
"eyJjdHkiOikkJzb2Z0cGhvbmU7dj0xIiwidHlwIjoiSldUIiwiYWxnIjoiSFMyNTYifQ.eyJ
qdGkiOiJTSzdGdTZUQ2tnVWJyOVQyUm5yQU9LaUFZMU9EcFE3UXNKLTE1Mjg3
ODk4ODYiLCJpc3MiOiJTSzdGdTZUQ2tnVWJyOVQyUm5yQU9LaUFZMU9EcFE3UX
NKIiwiZXhwIjoxODQ0MTQ5ODg2LCJ1c2VySWQiOiIxMDAiLCJ1c2VybmFtZSI6IlZQ
QlhfVFRBTyIsImFjY291bnRJZCI6NjR9.fx5eppBHJ-C9IRHJUtOvJ9txn8NTYD-
 DisTgSlJ3E"
}

❏ Fail :

{
"error": [
"Error name required","Error password required"]
}

Token có thời hạn sử dụng là 30 ngày, khi hết hạn sử dụng bạn phải tạo lại token
mới hoặc bạn có thể tạo mới token mỗi khi kết nối Stringee SDK.

4. Ví dụ kết nối Stringee SDK

Từ sample code Web đã tải về ở mục 2. Thay đổi thông tin đăng nhâp trong file
“voice_call.html” như sau:

var fromNumber = <Authen Name>;

var access_token = <token>;

Ví dụ :

var fromNumber = ‘VPBX_TTAO’;

var access_token =
‘eyJjdHkiOikkJzb2Z0cGhvbmU7dj0xIiwidHlwIjoiSldUIiwiYWxnIjoiSFMyNTYifQ.eyJqd
GkiOiJTSzdGdTZUQ2tnVWJyOVQyUm5yQU9LaUFZMU9EcFE3UXNKLTE1Mjg3ODk
4ODYiLCJpc3MiOiJTSzdGdTZUQ2tnVWJyOVQyUm5yQU9LaUFZMU9EcFE3UXNKIiw
iZXhwIjoxODQ0MTQ5ODg2LCJ1c2VySWQiOiIxMDAiLCJ1c2VybmFtZSI6IlZQQlhfVF
RBTyIsImFjY291bnRJZCI6NjR9.fx5eppBHJ-C9IRHJUtOvJ9txn8NTYD-DisTgSlJ3E’;

Đăng nhập thành công :

 5. Ví dụ gọi điện
Bạn có thể tham khảo các event handler của Stringee SDK để xử lý cuộc gọi.

Nhập số điện thoại và thực hiện cuộc gọi :

Có cuộc gọi đến :

 6. Lấy lịch sử cuộc gọi và file ghi âm
VHT cũng cung cấp cho bạn một API để lấy thông tin lịch sử cuộc gọi và file ghi âm.
Để sử dụng API này bạn cần phải có thông tin api_key và api_secret. Để lấy 2
thông tin này bạn cần đăng nhập vào trang quản trị tổng đài như ở bước 1. Ở mục
“Tài khoản” bạn sẽ thấy được thông tin api_key và api_secret.

Sử dụng api_key và api_secret này cho chứng thực API theo định dạng HTTP
Basic Authentication :

User = <api_key>
Password = <api_secret>

Hoặc thêm Header :

Authorization: Basic base64_encode(<api_key>:<api_secret>)

 ● API request :
❏ Method : GET
❏ URL : https://acd-api.vht.com.vn/rest/cdrs
❏ URL Params :

Tên Mô tả

page Số trang, Dùng cho phân trang kết quả trả về.
Ví dụ : 1, 2, 3, ….

limit Giới hạn số phần tử trong 1 trang.

Ví dụ : 5, 6, 7, …

sort_by Trường dữ liệu cần sắp xếp. Hiện tại chỉ hỗ trợ xếp theo
cdr_id (thứ tự id trong hệ thống dữ liệu).

sort_type Các sắp xếp : ASC, DESC

state Trạng thái cuộc gọi dự theo mã phản hồi của giao thức
SIP (SIP response code).

direction Hướng cuộc gọi :

1 : gọi vào
3 : gọi ra

extension Số máy nhánh.

Ví dụ : 100, 101, ….

from_number Số gọi điện

to_number Số bị gọi

date_started Thời gian bắt đầu. Kết quả trả về sẽ có thời gian cuộc gọi
lớn hơn giá trị này. Định dạng time_stamp
Ví dụ : 1538627467

date_ended Thời gian kết thúc. Kết quả trả về sẽ có thời gian gọi nhỏ
hơn giá trị này. Định dạng time_stamp
Ví dụ : 1538627467
 ● Api response :

❏ Success :
{
"total": 9,
"currentpage": 1,
"limit": 1,
"items": [
{
"data_tracking": [
{
"cdr_id": "124247285",
"call_id": "sc1363168746752",
"sip_call_id": "a",
"cause": "200",
"duration": 14,
"direction": 3,
"call_leg": "A",
"recording_url": "https://acd-dev-
api.vht.com.vn/rest/recordings/aHR0cDovLzE3Mi4xNi4xNi4xMDAvdXBsb2Fkcy9
maWxlY2xvdWQvcmVjb3JkaW5ncy9WUEJYX0NUQ1BWVDFfMTAwLzEwMC8yMDE
4MDcxM19zYzEzNjMxNjg3NDY3NTJfOTAwLm1wMw==",
"record_file_size": 448684,
"extension": "100",
"from_number": "0899179053",
"to_number": "900",
"time_started": 1531455984,
"time_connected": 1531455996,
"time_ended": 1531455998
}
],
"cdr_id": "124247285",
"call_id": "sc1363168746752",
"sip_call_id": "a",
"cause": "200",
"extension": "100",
"from_number": "0899179053",
 "to_number": "900",
"duration": 14,
"direction": 3,
"time_started": 1531455984,
"time_connected": 1531455984,
"time_ended": 1531455998,
"call_leg": "A",
"recording_url": "https://acd-dev-
api.vht.com.vn/rest/recordings/aHR0cDovLzE3Mi4xNi4xNi4xMDAvdXBsb2Fkcy9
maWxlY2xvdWQvcmVjb3JkaW5ncy9WUEJYX0NUQ1BWVDFfMTAwLzEwMC8yMDE
4MDcxM19zYzEzNjMxNjg3NDY3NTJfOTAwLm1wMw==",
"record_file_size": 448684
}
]
}

Mô tả kết quả trả về như sau :

Tên Mô tả
cdr_id Thông tin ID lưu trên hệ thống
call_id Thông tin ID của cuộc gọi trên hệ thống
của VHT
sip_call_id Thông tin ID của cuộc gọi giao thức SIP
cause Mã phản hồi SIP (SIP response code)
extension Số nội bộ
from_number Cuộc gọi từ số
to_number Cuộc gọi đến số
duration Thời gian đàm thoại tính bằng giây.
direction Hướng cuộc gọi :
1 : gọi vào
3 : gọi ra
time_started Thời gian bắt đầu cuộc gọi
time_connected Thời gian cuộc gọi kết nối
time_ended Thời gian kết thúc cuộc gọi
recording_url Đường dẫn file ghi âm
record_file_size Dung lượng file ghi âm tính bằng byte.

❏ Fail :
{
 "error": [
"error_account_invalid"
]
}

----- HẾT -----