Outbound message via WhatsApp

POST

/v1/convai/whatsapp/outbound-message

Send an outbound message via WhatsApp

xi-api-keystringOptional

This endpoint expects an object.

whatsapp_phone_number_idstringRequired

whatsapp_user_idstringRequired

template_namestringRequired

template_language_codestringRequired

template_paramslist of objectsRequired

agent_idstringRequired

conversation_initiation_client_dataobjectOptional

Successful Response

conversation_idstring

1	from elevenlabs import ElevenLabs
2
3	client = ElevenLabs(
4	base_url="https://api.elevenlabs.io"
5	)
6
7	client.conversational_ai.whatsapp.outbound_message(
8	whatsapp_phone_number_id="whatsapp_phone_number_id",
9	whatsapp_user_id="whatsapp_user_id",
10	template_name="template_name",
11	template_language_code="template_language_code",
12	template_params=[
13	{
14	"type": "body",
15	"parameters": [
16	{
17	"text": "text"
18	}
19	]
20	}
21	],
22	agent_id="agent_id"
23	)

1	{
2	"conversation_id": "conversation_id"
3	}