Automatic Call Webhook

Call Event Webhook

The partner provides a POST API along with an authentication method (Authorization key) to receive call events from Alohub. Whenever there is a change in the call status, the system will automatically push data to the partner's endpoint in real-time.

Note: The partner needs to provide the webhook URL and Authorization key for Alohub to establish the connection. Contact Alohub for configuration support.

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

Alohub will send an HTTP POST request to the partner's webhook URL with the JSON body as below.

Header request

Header	Type	Description
`Authorization`	string	Authorization key provided by the partner to Alohub
`Content-Type`	string	Always `application/json`

Body request

Parameter	Type	Description
`call_id`	string	Automatic call identifier
`call_status`	string	Call status (e.g.: `answered`, `missed`)
`direction`	string	Call direction: `inbound`(incoming) or `outbound`(outgoing)
`caller_number`	string	Customer's phone number called automatically
`destination_number`	string	Extension number of the consultant
`starttime`	string	Call start time (format `YYYY-MM-DD HH:mm:ss`)
`answertime`	string	Time the consultant answered the call
`endtime`	string	Call end time
`hangup_by`	string	Side that ended the call: `customer`, `agent`or `system`
`hotline`	string	Hotline number (if any)
`total_duration`	string	Total call duration (seconds)
`holding_duration`	string	Hold duration (seconds)
`recording_url`	string	URL of the call recording file
`objectId`	integer	Default is `1`
`transactionID`	string	Transaction ID passed when creating the Auto Call campaign
`userName`	string	Name of the consultant account making or receiving the call
`eventType`	string	Default is `call`

Example payload Alohub sends to the partner

{
  "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"
}

Expected response from the partner

After receiving the webhook, the partner's endpoint needs to respond with HTTP status 200 OKto confirm successful receipt. If no response is received or an error code is received, Alohub may attempt to resend.