Skip to main content

Calls

Following webhook events are supported for Calls.

call.initiated​

Triggered when a new call has been initiated.

Sample Payload​

{
    "event": "call.initiated",
    "account_id": uuid,
    "call_app_id": uuid,
    "data": {
        "call_id": uuid,
        "from": string,
        "to": string,
        "start_time": timestamp,
    }
}

call.ringing​

Triggered when a call has started ringing.

Sample Payload​

{
    "event": "call.ringing",
    "account_id": uuid,
    "call_app_id": uuid,
    "data": {
        "call_id": uuid,
        "from": string,
        "to": string,
    }
}

call.answered​

Triggered when a call has been answered.

Sample Payload​

{
    "event": "call.answered",
    "account_id": uuid,
    "call_app_id": uuid,
    "data": {
        "call_id": uuid,
        "from": string,
        "to": string,
        "answer_time": timestamp,
    }
}

call.completed​

Triggered when a call is completed.

Sample Payload​

{
    "event": "call.completed",
    "account_id": uuid,
    "call_app_id": uuid,
    "data": {
        "call_id": uuid,
        "from": string,
        "to": string,
        "duration": integer,
        "hangup_time": timestamp,
    }
}