Incoming Call Webhook

Incoming call webhooks are automated notifications sent from Alohaa to your specified server or endpoint whenever an incoming call event occurs.

Webhook Types

1. Dial on Agent: This webhook is triggered when a call is initiated.

2. Call Completion: This webhook is triggered when a call is completed.

Dial on Agent Payload

{
    "organisation_id": "89311a60-ee25-11ec-xxxxxx",
    "call_type": "incoming",
    "caller_number": "905293XXXX",
    "receiver_number": "967650XXXX",
    "did_number": "91806973XXXX",
    "received_at": "2023-02-28T06:48:01.000Z",
    "call_id": "65015fbd9c9a62XXXXXXX",
    "agent_name": "kumarxxxxx",
    "webhook_type": "dial_on_agent"
}

Call Completion Payload

{
    "organisation_id": "89311a60-ee25-11ec-xxxxxx",
    "call_type": "incoming",
    "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",
    "call_duration": "00:01:09",
    "call_recording_url": "https://doosra-ivr-voicemails.s3.ap-south-1.amazonaws.com/.....",
    "agent_name": "kumarxxxxx",
    "dtmfcodes": "1, 9, 2",
    "dtmfcode": "2",
    "total_ring_duration": 30,
    "hangup_cause": initiator_hangup
    "webhook_type": "call_completion"
}

Payload Fields Description

Field	Description
organisation_id	A unique identifier for the organisation within the Alohaa system.
call_type	Specifies the type of call, in this case "incoming".
caller_number	The phone number of the caller.
receiver_number	The phone number of the intended receiver within the organisation.
did_number	Direct Inward Dialing (DID) number associated with the call, which directly reaches a specific service.
received_at	The timestamp indicating when the call was received by the system.
ended_at	The timestamp indicating when the call was ended. Only present in the "Call Completion" payload.
call_id	A unique identifier assigned to the call session for tracking and reference.
call_status	The status of the call, such as "answered" or "notanswered". Only present in the "Call Completion" payload.
call_duration	The duration of the call in hours, minutes, and seconds format. Only present in the "Call Completion" payload.
call_recording_url	A URL to access the recording of the call, providing auditory records of the call.
agent_name	The name of the agent who handled or was assigned to the call.
dtmfcodes	The comma separated DTMF codes pressed by the caller.
dtmfcode	The latest DTMF code presses by the caller.
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)

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