Appearance
Webhooks
Webhook cho phép hệ thống VBot gửi thông báo realtime đến server của bạn khi có sự kiện xảy ra (ví dụ: cuộc gọi mới, kết thúc cuộc gọi, v.v.).
Lưu ý
Khách hàng cần mua thêm tiện ích bổ sung trong gói VBot để sử dụng tính năng này.
Mua tiện ích bổ sung
Thông báo
Tính năng mua tiện ích bổ sung hiện đang bảo trì. Khách hàng vui lòng liên hệ với VBot để mua gói.
Cài đặt Webhooks
Sau khi mua tiện ích API dịch vụ, truy cập trang cấu hình Webhooks để thiết lập.
Các bước thực hiện:
- Nhập URL nhận webhook hệ thống của bạn
- Nhập Auth header (nếu có) để xác thực request
- Bật các sự kiện bạn muốn nhận thông báo
Tổng quan sự kiện
| Mã sự kiện | Nhóm | Mô tả |
|---|---|---|
MANUAL_CALL_COMPLETE | Manual Call | Gói đủ: Lịch sử + Ghi âm + AI trích xuất |
MANUAL_CALL_LOG | Manual Call | Lịch sử 1 cuộc gọi thường (vừa kết thúc) |
MANUAL_CALL_RECORDING | Manual Call | File ghi âm cuộc gọi thường |
MANUAL_CALL_AI_EXTRACTION | Manual Call | AI trích xuất cuộc gọi thường |
AUTO_CALL_COMPLETE | Auto Call | Gói đủ: Lịch sử + Ghi âm + AI trích xuất |
AUTO_CALL_LOG | Auto Call | Lịch sử 1 cuộc gọi tự động (vừa kết thúc) |
AUTO_CALL_RECORDING | Auto Call | File ghi âm cuộc gọi tự động |
AUTO_CALL_AI_EXTRACTION | Auto Call | AI trích xuất cuộc gọi tự động |
P2P_CALL_LOG | P2P | Lịch sử cuộc gọi nội bộ |
IN_COMINGCALL | Incoming | Thông báo realtime có cuộc gọi đang gọi vào |
Cuộc gọi thường (Manual Call)
MANUAL_CALL_COMPLETE
Gói đầy đủ khi cuộc gọi thường hoàn tất, bao gồm lịch sử + ghi âm.
Cấu trúc payload:
| Phần | Kiểu | Mô tả |
|---|---|---|
| manualCallLog | Object | Thông tin chi tiết cuộc gọi |
| manualCallRecording | Object | Thông tin ghi âm cuộc gọi |
manualCallLog
| Tham số | Kiểu | Mô tả |
|---|---|---|
| transId | String | Mã giao dịch cuộc gọi (duy nhất) |
| projectCode | String | Mã dự án |
| typeCall | Int | Loại cuộc gọi (1: Gọi vào, 2: Gọi ra) |
| timeCall | Int | Thời lượng đổ chuông (giây) |
| durationCall | Int | Tổng thời lượng cuộc gọi (giây) |
| createAt | Long | Thời điểm tạo cuộc gọi (Unix timestamp ms) |
| callAt | Long | Thời điểm bắt đầu gọi (Unix timestamp ms) |
| callerId | String | ID người gọi |
| caller | String | Số người gọi |
| callerName | String | Tên người gọi |
| typeCaller | String | Loại người gọi (Website_RTC, Phone, SIP, ...) |
| channelCaller | String | Channel ID người gọi |
| calleeId | String | ID người nhận |
| callee | String | Số người nhận |
| calleeName | String | Tên người nhận |
| typeCallee | String | Loại người nhận (Phone, Website_RTC, SIP, ...) |
| channelCallee | String | Channel ID người nhận |
| conferenceId | String | ID phòng hội nghị (nếu có) |
| telcoCode | String | Mã nhà mạng (VTL, VNP, VMS, ...) |
| disposition | String | Trạng thái cuộc gọi (ANSWER, NOANSWER, BUSY, ...) |
| hangupCause | String | Nguyên nhân kết thúc (NORMAL_CLEARING, ...) |
| sipCode | String | Mã SIP response (200, 486, ...) |
| endCall | String | Channel ID bên kết thúc cuộc gọi |
| hotline | String | Số hotline sử dụng |
| isIvr | Boolean | Cuộc gọi có qua IVR hay không |
| groupId | String | ID nhóm cuộc gọi |
| forwardBotIdEndCall | String | Bot ID nếu cuộc gọi được chuyển sang bot |
| paymentChannel | String | Kênh thanh toán (MONEY, ...) |
| postage | Double | Cước phí cuộc gọi |
| autoDialServiceCharge | Double | Phí dịch vụ gọi tự động |
| campaignTransId | String | Mã giao dịch chiến dịch (nếu có) |
| customerUid | String | UID khách hàng trong hệ thống |
| customerName | String | Tên khách hàng |
| firstQuestion | String | Câu hỏi đầu tiên (nếu có IVR) |
| externalCallId | String | Mã cuộc gọi từ hệ thống bên ngoài |
| groupMemberUid | String | UID nhóm thành viên |
manualCallRecording
| Tham số | Kiểu | Mô tả |
|---|---|---|
| transId | String | Mã giao dịch cuộc gọi |
| externalCallId | String | Mã cuộc gọi từ hệ thống bên ngoài |
| recordUrl | String | URL tải file ghi âm (yêu cầu Bearer token) |
MANUAL_CALL_LOG
Lịch sử 1 cuộc gọi thường vừa kết thúc. Payload là object phẳng với các trường giống manualCallLog ở trên.
MANUAL_CALL_RECORDING
File ghi âm cuộc gọi thường. Payload giống manualCallRecording ở trên.
MANUAL_CALL_AI_EXTRACTION
AI trích xuất dữ liệu từ cuộc gọi thường. Payload giống AUTO_CALL_AI_EXTRACTION.
Cuộc gọi tự động (Auto Call)
AUTO_CALL_COMPLETE
Gói đầy đủ khi cuộc gọi tự động hoàn tất, bao gồm lịch sử + AI trích xuất + ghi âm.
Cấu trúc payload:
| Phần | Kiểu | Mô tả |
|---|---|---|
| autoCallLog | Object | Thông tin chi tiết cuộc gọi (giống AUTO_CALL_LOG) |
| autoCallAIExtraction | Object | Dữ liệu AI trích xuất (giống AUTO_CALL_AI_EXTRACTION) |
| autoCallRecording | Object | Thông tin ghi âm (giống AUTO_CALL_RECORDING) |
AUTO_CALL_LOG
Lịch sử 1 cuộc gọi tự động vừa kết thúc. Payload là object phẳng:
| Tham số | Kiểu | Mô tả |
|---|---|---|
| phone | String | Số điện thoại khách hàng |
| duration | Int | Tổng thời lượng cuộc gọi (giây) |
| billsec | Int | Thời lượng tính cước (giây) |
| disposition | String | Trạng thái cuộc gọi (ANSWER, NOANSWER, BUSY, ...) |
| hotlineCode | String | Mã hotline |
| inputLog | String | Log tương tác DTMF |
| voiceText | String | Nội dung thoại chuyển văn bản (STT) |
| postage | Double | Cước phí cuộc gọi |
| serviceCharge | Double | Phí dịch vụ |
| memberName | String | Tên thành viên thực hiện |
| memberAccId | String | Account ID thành viên |
| answerAt | Long | Thời điểm nghe máy (Unix timestamp ms) |
| endCallAt | Long | Thời điểm kết thúc (Unix timestamp ms) |
| botId | String | ID của bot xử lý cuộc gọi |
| campaignName | String | Tên chiến dịch |
| campaignGroupName | String | Tên nhóm chiến dịch |
| templateScriptCode | String | Mã kịch bản template |
| templateScriptName | String | Tên kịch bản template |
| transId | String | Mã giao dịch cuộc gọi (duy nhất) |
| createAt | Long | Thời điểm tạo cuộc gọi (Unix timestamp ms) |
| postageService | Double | Cước dịch vụ bổ sung |
| postageBotService | Double | Cước dịch vụ bot |
| telcoCode | String | Mã nhà mạng (VTL, VNP, VMS, ...) |
| projectCode | String | Mã dự án |
| callNet | String | Loại cuộc gọi (OFFNET, ONNET) |
| metaData | String | Dữ liệu meta đầu vào kịch bản (JSON string) |
| metaDataDescription | String | Mô tả các trường meta (JSON string) |
| externalCallId | String | Mã cuộc gọi từ hệ thống bên ngoài |
| callCollectedData | String | Dữ liệu thu thập từ cuộc gọi (JSON string) |
AUTO_CALL_AI_EXTRACTION
AI trích xuất dữ liệu từ cuộc gọi tự động.
| Tham số | Kiểu | Mô tả |
|---|---|---|
| transId | String | Mã giao dịch cuộc gọi |
| externalCallId | String | Mã cuộc gọi từ hệ thống bên ngoài |
| callCollectedData | String | Dữ liệu AI trích xuất từ cuộc gọi (JSON string) |
callCollectedData là JSON string chứa mảng các trường dữ liệu đã trích xuất:
| Key trong item | Kiểu | Mô tả |
|---|---|---|
| cfkey | String | Mã trường |
| cfname | String | Tên hiển thị trường |
| cfvalue | String | Giá trị trích xuất |
| description | String | Mô tả trường |
AUTO_CALL_RECORDING
File ghi âm cuộc gọi tự động.
| Tham số | Kiểu | Mô tả |
|---|---|---|
| transId | String | Mã giao dịch cuộc gọi |
| externalCallId | String | Mã cuộc gọi từ hệ thống bên ngoài |
| recordUrl | String | URL tải file ghi âm (yêu cầu Bearer token) |
Cuộc gọi nội bộ (P2P)
P2P_CALL_LOG
Lịch sử cuộc gọi nội bộ (peer-to-peer). Payload có cấu trúc giống manualCallLog.
Cuộc gọi đến
IN_COMINGCALL
Thông báo realtime khi có cuộc gọi đang gọi vào hệ thống. Sự kiện này được gửi ngay khi cuộc gọi reo, trước khi được trả lời.
Sự kiện cũ (Deprecated)
Lưu ý
Các sự kiện dưới đây vẫn hoạt động nhưng sẽ ngừng hỗ trợ cập nhật. Vui lòng chuyển sang sử dụng sự kiện mới tương ứng.
| Mã sự kiện cũ | Sự kiện thay thế | Mô tả |
|---|---|---|
CAMPAIGN_CALL | AUTO_CALL_LOG | Lịch sử cuộc gọi tự động |
HISTORY_CALL | MANUAL_CALL_LOG | Lịch sử cuộc gọi thường |
HISTORY_CALL_PEERTOPEER | P2P_CALL_LOG | Lịch sử cuộc gọi nội bộ |
CAMPAIGN_CALL
Payload giống AUTO_CALL_LOG.
HISTORY_CALL / HISTORY_CALL_PEERTOPEER
| Tham số | Kiểu | Mô tả |
|---|---|---|
| hotline_number | String | Số hotline |
| date_create | String | Thời điểm tạo cuộc gọi |
| caller | Array | Danh sách thông tin người gọi |
| callee | Array | Danh sách thông tin người nhận |
| time_call | String | Thời lượng đàm thoại |
| duration_call | String | Tổng thời lượng cuộc gọi |
| type_call | String | Loại cuộc gọi (OUTCALL, INCALL) |
| group_id | String | ID nhóm cuộc gọi |
| disposition | String | Trạng thái cuộc gọi (ANSWER, NOANSWER, BUSY, ...) |
| external_call_id | String | Mã cuộc gọi từ hệ thống bên ngoài |
| record_file | Array | Danh sách URL file ghi âm |
Mỗi item trong caller / callee:
| Tham số | Kiểu | Mô tả |
|---|---|---|
| phone | String | Số điện thoại |
| vbot_id | String | VBot ID |
| date_create | String | Thời điểm |
| disposition | String | Trạng thái |
| time_call | String | Thời lượng đàm thoại |
| postage | Double | Cước phí |
| duration_call | Int | Thời lượng cuộc gọi (giây) |
| source | String | Nguồn cuộc gọi (App_SDK, Phone, SIP) |
| member_no | String | Số nhánh thành viên |