Voice API Webhook

Initiate Voice API Webhooks provide notifications related to the status of Voice API campaigns within the Alohaa.

Payload

Here is an example payload that you would receive for a Voice API event:

{
    "campaign_id": "6566ce01a46d4ce5dc6e22c2",
    "call_id": "6566ce99a46d4ce5dc6e2385",
    "status": "ANSWERED",
    "dtmf_key": "1"
}

Payload Fields Description

Field	Description
campaign_id	Unique identifier for the Voice API campaign.
call_id	Unique identifier for the individual call within the campaign.
status	Status of the call, e.g., "ANSWERED", "UNANSWERED" etc.
dtmf_key	The key pressed by the call recipient.