Skip to navigation
OMIAWebhooks

Call result

Chat Bridge notifies the final status of each originated 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.

A SENT event is emitted when the call completes and includes the conversation duration, transcription, analysis results and collected data; a FAILED event is emitted when the call could not be initiated and includes the SIP termination code. Your endpoint must accept application/json and respond with a 2xx HTTP code; failed deliveries are retried automatically.

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 the conversation finished (includes the duration); FAILED when the call initiation failed (includes the SIP termination code).

Allowed values:
phone_numberstringOptional
agentstringOptional
Identifier of the agent that handled the call.
agent_namestringOptional
Name of the agent that handled the call.
operatorstringOptional
is_mobilebooleanOptional
typestring or nullOptional

Network type of the destination number according to the National Numbering Plan (for example MOVIL or FIJO).

sip_codeintegerOptional
SIP code returned by the voice platform when finishing.
sip_descriptionstringOptional

Human-readable description corresponding to the SIP code.

duration_minutesintegerOptional
Duration of the conversation in minutes, rounded up.
duration_secondsintegerOptional
Duration of the conversation in seconds.
dialed_atdatetime or nullOptional
Timestamp when the call was answered by the destination.
failed_atdatetime or nullOptional
Timestamp of the failure, when the call could not complete.
conversation_idstring or nullOptional

Identifier of the conversation on the voice platform. null when the call never reached the provider.

variablesmap from strings to strings or nullOptional
Variables used to originate the call.
analysislist of objects or nullOptional

Result of each evaluation criterion configured on the agent. Only present on SENT events, after the conversation was analyzed.

data_collection_resultsmap from strings to objects or nullOptional

Data collected during the conversation, keyed by variable. Only present on SENT events, after the conversation was analyzed.

transcriptionlist of objects or nullOptional

Transcription of the conversation in chronological order. null when no conversation took place.

Response

200
Event received and processed by the client.