Speech-to-speech (EVI)Chat Webhooks

Chat Started

Sent when an EVI chat is started.

Payload

The payload of this webhook request is an object.
caller_numberstring or nullRequired

Phone number of the caller in E.164 format (e.g., +12223333333). This field is included only if the Chat was created via the Twilio phone calling integration.

chat_group_idstringRequired

Unique ID of the Chat Group associated with the Chat session.

chat_idstringRequired

Unique ID of the Chat session.

chat_start_typeenumRequired

Indicates whether the chat is the first in a new Chat Group (new_chat_group) or the continuation of an existing chat group (resumed_chat_group).

Allowed values:
config_idstring or nullRequired

Unique ID of the EVI Config used for the session.

custom_session_idstring or nullRequired

User-defined session ID. Relevant only when employing a custom language model in the EVI Config.

start_timeintegerRequired

Unix timestamp (in milliseconds) indicating when the session started.

twilio_metadatamap from strings to strings or nullRequired
Twilio metadata associated with the chat. This field is included only if the Chat was created via the [Twilio phone calling](/docs/empathic-voice-interface-evi/phone-calling) integration. Fields may include `call_sid`, `account_sid`, `from_number`, `to_number`, `caller_name`, `caller_number`, `from_city`, `from_state`, `from_zip`, `from_country`, `to_city`, `to_state`, `to_zip`, and `to_country`. If a specific metadata is not available, this field will be set to an empty string.
event_name"chat_started"Optional

Always chat_started.

Response

200
any
Return a 200 status to indicate that the data was received successfully.