v2

latestOpenAPI 3.1.02026-08-05100545344.4 KB

chat

Start an outbound chat conversation

Create a new outbound WhatsApp or SMS conversation for a chat agent.

post/chat/outbound

Authorizationstring required

Bearer authentication

agent_idstring uuid required

The ID of the chat agent that will handle the conversation.

channel'sms' | 'whatsapp' required

Outbound messaging channel.

to_numberstring required

Recipient phone number in E.164 format.

from_numberstring required

Twilio sender phone number in E.164 format.

initial_messagestring

Freeform opening message. For WhatsApp, this is only valid within the 24-hour customer service window.

custom_variablesobject

Custom prompt variables to inject into the agent configuration for this conversation.

200

statusstring required

Whether the request was successful.