Appearance
Gọi tự động cho thành viên SDK
VBot cung cấp Open API thực hiện cuộc gọi tự động trực tiếp qua VoIP đến các tài khoản thành viên (VBot hoặc SDK).
Bài toán & Giải pháp
- Bài toán: Phát cảnh báo khẩn cấp đến khách hàng một cách hiệu quả, tránh bỏ sót như thông báo đẩy (push notification) thông thường.
- Giải pháp: Tích hợp Open API để thực hiện cuộc gọi VoIP trực tiếp tới tài khoản SDK của khách hàng, hỗ trợ tuỳ chỉnh tên hiển thị và thông tin cuộc gọi.
Sơ đồ nghiệp vụ
Luồng tuần tự Backend

Usecase khách hàng dùng SDK

Khi hệ thống đối tác tạo cuộc gọi cảnh báo bằng Open API của VBot, tất cả các tài khoản SDK của khách hàng được khai báo trong member_infos sẽ nhận được cuộc gọi. Nội dung cuộc gọi được phát sẽ tùy theo kịch bản cuộc gọi đã chọn. Thông tin cuộc gọi hiển thị trên máy khách hàng (tên hiển thị, thời gian gọi) là thông tin đối tác đã truyền khi tạo cuộc gọi.
Quy trình tích hợp Backend
Tạo tài khoản & Lấy Token SDK
Phía Backend gọi API để tạo hoặc lấy JWT token cấp quyền cho SDK Client kèm theo member_no. Đối với tài khoản nhân viên/khách hàng mới chưa có trên hệ thống (member_no chưa tồn tại), hệ thống sẽ tự động khởi tạo thành viên.
Chi tiết API đã có trong tài liệu: Xem tại Tạo tài khoản & lấy Token SDK (One-Step Provisioning).
Lấy thông tin tài khoản SDK
Sau khi tạo tài khoản SDK thành công, đối tác gọi API để lấy thông tin tài khoản và lưu member_no vào cơ sở dữ liệu phục vụ bước tạo cuộc gọi tiếp theo.
Chi tiết API đã có trong tài liệu: Xem tại Lấy thông tin thành viên theo mã.
Tạo cuộc gọi tự động đến tài khoản SDK khách hàng
Để khởi tạo cuộc gọi cảnh báo trực tiếp tới các tài khoản SDK, đối tác gọi API dưới đây:
POST[URL]/m-auto-call/api/call/create-list-member
Header
| Tham số | Giá trị |
|---|---|
| X-API-Key | token-open-api |
Body Request
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
display_name | String | Có | Tên hiển thị trên app khách hàng khi thực hiện gọi tự động (không chứa dấu cách). |
type | String | Có | Kiểu cuộc gọi, truyền chuỗi "MEMBER". |
template_code | String | Có | Mã kịch bản cuộc gọi. |
max_time | Int | Không | Thời gian gọi tối đa (giây). |
max_waiting_time | Int | Không | Thời gian tối đa chờ khách hàng nhấc máy (giây). |
member_infos | Array | Có | Danh sách thành viên nhận cuộc gọi. |
member_infos[].external_call_id | String | Không | Mã định danh cuộc gọi phía đối tác. |
member_infos[].member_no | String | Có | Mã thành viên SDK. |
member_infos[].name | String | Không | Tên thành viên. |
member_infos[].datas | Object | Không | Danh sách giá trị của các trường thông tin trong kịch bản (custom fields). |
Ví dụ Request
json
{
"display_name": "CanhBaoKhanCap",
"type": "MEMBER",
"template_code": "TMP_26070909305271137",
"max_time": 120,
"max_waiting_time": 30,
"member_infos": [
{
"external_call_id": "EXT_CALL_001",
"member_no": "agent_001",
"name": "Nguyễn Văn A",
"datas": {
"order_content": "Thông báo đơn hàng bị hủy",
"order_cod": "150000"
}
}
]
}Response
| Tham số | Kiểu | Mô tả |
|---|---|---|
error | Int | Mã lỗi (0: Thành công, khác 0: Có lỗi) |
message | String | Thông điệp phản hồi |
data | Boolean | Kết quả xử lý (true/false) |
errorCode | Int | Mã lỗi hệ thống (nếu có) |
Ví dụ Response
json
{
"error": 0,
"message": "success",
"data": true,
"errorCode": 0
}Các API hỗ trợ liên quan
Các API được sử dụng để lấy thông tin cần thiết trước khi tạo cuộc gọi đã có sẵn trong tài liệu:
Lấy danh sách thành viên &
member_no:
Xem tại Lấy danh sách thành viên.Lấy danh sách kịch bản mẫu &
template_code: Lấy danh sách kịch bản mẫu và mã của từng kịch bản (trả qua paramcode). Mỗi cuộc gọi tự động sẽ sử dụng 1 kịch bản, tương ứng với 1template_codetruyền vào. Xem tại Lấy danh sách kịch bản.Lấy các biến tùy chỉnh trong kịch bản (
datas):
Với các kịch bản có biến tuỳ chỉnh (custom field), đối tác gọi api để lấy danh sách các biến trong kịch bản đó (Tải danh sách biến tuỳ chỉnh ngay sau khi chọn kịch bản). Các biến và giá trị sẽ được truyền vàodatascủamember_infostrong api tạo cuộc gọi tự động. Xem tại Lấy trường tùy chỉnh trong kịch bản.
Nhận sự kiện thông qua Webhook sau khi kết thúc cuộc gọi
Đối với mỗi cuộc gọi tự động tới khách hàng, sau khi cuộc gọi kết thúc, VBot sẽ tự động gửi sự kiện (event) Webhook về URL đã được đối tác cấu hình từ trước.
Các bản tin sự kiện nhận được bao gồm:
AUTO_CALL_COMPLETE: Bản tin đầy đủ thông tin cuộc gọi, ghi âm và dữ liệu AI trích xuất.AUTO_CALL_AI_EXTRACTION: Bản tin trích xuất dữ liệu trả lời của khách hàng từ AI.AUTO_CALL_RECORDING: Bản tin chứa link file ghi âm cuộc gọi.
Chi tiết cấu hình Webhook và cấu trúc payload: Xem tại Webhooks - Event Auto Call và Lịch sử gọi tự động.
