Start an outbound chat conversation

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

agent_idstringRequiredformat: "uuid"

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

channelenumRequired

Outbound messaging channel.

Allowed values:

to_numberstringRequired

Recipient phone number in E.164 format.

from_numberstringRequired

Twilio sender phone number in E.164 format.

initial_messagestringOptional

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

templateobjectOptional

Approved Twilio Content Template for WhatsApp outbound messages. Required outside the 24-hour customer service window, optional within it.

custom_variablesmap from strings to anyOptional

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

200

statusstring

Whether the request was successful.

responseobject

400

Bad Request Error

1	import requests
2
3	url = "https://api.synthflow.ai/v2/chat/outbound"
4
5	payload = {
6	"agent_id": "2a886b7d-d52d-4f8b-8ea0-19d3edc79214",
7	"channel": "whatsapp",
8	"to_number": "+15559876543",
9	"from_number": "+15551234567",
10	"initial_message": "Hi! How can I help you today?"
11	}
12	headers = {
13	"Authorization": "Bearer <token>",
14	"Content-Type": "application/json"
15	}
16
17	response = requests.post(url, json=payload, headers=headers)
18
19	print(response.json())

1	{
2	"status": "ok",
3	"response": {
4	"conversation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5	}
6	}