Call result | Chat Bridge

Chat Bridge notifies the final status of each launched call through an HTTP POST request (webhook).

To enable notifications you must provide the Voices team with the destination URL, which is configured in your App-Key. Optionally, you can define HTTP headers with constant values (for example, an authorization token) that will be sent with each webhook.

If the call performs a transfer, separate events are emitted for the initial call and for the transfer (call_type = transfer). Your endpoint must accept application/json and respond with a 2xx HTTP code.

Payload

The payload of this webhook request is an object.

message_idstringOptional

Unique identifier of the call generated when it is created.

statusenumOptional

Overall status of the call. SENT when it finishes successfully (sip_code = 200); TO_REDIAL when the attempt failed with a redialable SIP code and the call will be retried automatically (only when retry was configured and attempts remain); FAILED for the final failure.

Allowed values:

operatorstringOptional

is_mobilebooleanOptional

outbound_routestringOptional

phone_numberstringOptional

sip_codeintegerOptional

SIP code returned by the phone platform when finishing.

sip_descriptionstringOptional

Human-readable description corresponding to the SIP code.

call_typeenumOptional

Call type. initial for the main call; transfer when it corresponds to a transfer.

Allowed values:

duration_minutesintegerOptional

duration_secondsintegerOptional

Response

200

Event received and processed by the client.