Webhook gọi tự động

Webhook sự kiện cuộc gọi

Đối tác cung cấp một POST API kèm phương thức xác thực (Authorization key) để nhận sự kiện cuộc gọi từ Alohub. Mỗi khi có thay đổi trạng thái cuộc gọi, hệ thống sẽ tự động đẩy dữ liệu sang endpoint của đối tác theo thời gian thực.

Lưu ý: Đối tác cần tự cung cấp URL webhook và Authorization key cho Alohub để thiết lập kết nối. Liên hệ Alohub để được hỗ trợ cấu hình.

POST `https://{{webhook-url-doi-tac}}`

Alohub sẽ gửi một HTTP POST request tới URL webhook của đối tác với body JSON như bên dưới.

Header request

Header	Kiểu	Mô tả
`Authorization`	string	Authorization key do đối tác cung cấp cho Alohub
`Content-Type`	string	Luôn là `application/json`

Body request

Tham số	Kiểu	Mô tả
`call_id`	string	Mã định danh cuộc gọi tự động
`call_status`	string	Trạng thái cuộc gọi (ví dụ: `answered`, `missed`)
`direction`	string	Hướng cuộc gọi: `inbound` (gọi vào) hoặc `outbound` (gọi ra)
`caller_number`	string	Số điện thoại khách hàng được gọi tự động
`destination_number`	string	Số extension của tư vấn viên
`starttime`	string	Thời gian bắt đầu cuộc gọi (định dạng `YYYY-MM-DD HH:mm:ss`)
`answertime`	string	Thời gian tư vấn viên trả lời cuộc gọi
`endtime`	string	Thời gian kết thúc cuộc gọi
`hangup_by`	string	Bên kết thúc cuộc gọi: `customer`, `agent` hoặc `system`
`hotline`	string	Số hotline (nếu có)
`total_duration`	string	Tổng thời lượng cuộc gọi (giây)
`holding_duration`	string	Thời lượng giữ máy (giây)
`recording_url`	string	URL file ghi âm cuộc gọi
`objectId`	integer	Mặc định là `1`
`transactionID`	string	Transaction ID được truyền vào khi tạo chiến dịch Auto Call
`userName`	string	Tên tài khoản tư vấn viên thực hiện hoặc tiếp nhận cuộc gọi
`eventType`	string	Mặc định là `call`

Ví dụ payload Alohub gửi sang đối tác

{
  "call_id": "20240113150030xxxxxx",
  "call_status": "answered",
  "direction": "outbound",
  "caller_number": "03899xxx",
  "destination_number": "888",
  "starttime": "2024-01-13 15:00:30",
  "answertime": "2024-01-13 15:00:35",
  "endtime": "",
  "hangup_by": "",
  "hotline": "",
  "total_duration": "",
  "holding_duration": "",
  "recording_url": "",
  "objectId": 1,
  "transactionID": "TRANSID_1111",
  "userName": "adminxxx",
  "eventType": "call"
}

Phản hồi mong đợi từ đối tác

Sau khi nhận được webhook, endpoint của đối tác cần phản hồi HTTP status 200 OK để xác nhận đã nhận thành công. Nếu không nhận được phản hồi hoặc nhận mã lỗi, Alohub có thể thử gửi lại.