Outgoing Call Webhook

Outgoing call webhooks are automated notifications sent from Alohaa to your specified server or endpoint after completion of an outgoing call event.

Payload

Here is an example payload that you would receive for a outgoing call event:

{
    "organisation_id": "89311a60-ee25-11ec-xxxxxx",
    "call_type": "outgoing",
    "caller_number": "905293XXXX",
    "receiver_number": "967650XXXX",
    "did_number": "91806973XXXX",
    "received_at": "2023-02-28T06:48:01.000Z",
    "ended_at": "2023-02-28T06:49:10.000Z",
    "call_id": "65015fbd9c9a62XXXXXXX",
    "call_status": "answered", // or "notanswered"
    "call_duration": 30,
    "call_recording_url": "https://doosra-ivr-voicemails.s3.ap-south-1.amazonaws.com/.....",
    "agent_name": "kumarxxxxx",
    "initiator_ring_duration": 2,
    "receiver_ring_duration": 24,
    "total_ring_duration": 26,
    "hangup_cause": "initiator_disconnected",
    "external_id": "sohdinvs733882-wihzxjoxjs-usndjdi83"
}

Payload Fields Description

Field	Description
organisation_id	Unique identifier for the organisation within the Alohaa system.
call_type	Specifies the type of call, here "outgoing", indicating that the call was made from the organisation.
caller_number	The phone number of the agent or system making the call.
receiver_number	The phone number of the call recipient.
did_number	Direct Inward Dialing number associated with the outgoing call.
received_at	Timestamp when the call was initiated.
ended_at	Timestamp when the call was completed.
call_id	Unique identifier for the call session.
call_status	Indicates whether the call was answered or not answered. (Possible values can be "answered" or "notanswered")
call_duration	Total duration of the call in seconds.
call_recording_url	URL to access the recording of the call.
agent_name	Name of the agent who made the call.
initiator_ring_duration	Duration (in seconds) that the call initiator's phone rang before the call was answered or timed out.
receiver_ring_duration	Duration (in seconds) that the receiver's phone rang before they answered or the call was missed.
total_ring_duration	Total ring duration (in seconds), combining both the initiator's and receiver's ring times before the call was connected or missed.
hangup_cause	The reason why the call ended (Possible values outlined below)
external_id	A string value returned in the webhook callback. It maps directly to the uniqueId provided in the iframe request, enabling end-to-end correlation between request and response.

Hangup Cause:

SCENARIO	INITIATOR STATUS	RECEIVER STATUS
No Answer (Not answered, Not hangup)	initiator_disconnected	receiver_disconnected
Disconnect	initiator_disconnected	receiver_disconnected
Switch Off	network_error	network_error
Wrong Number	network_error	network_error
Flight Mode	network_error	network_error
Busy	initiator_disconnected	receiver_disconnected
Block	initiator_disconnected	receiver_disconnected
Answer - Hangup	initiator_hangup	receiver_hangup