Sign in
Conversation

post/v1/conversation/whatsapp/outbound

Request body

phoneNumberstring required

The phone number to send the WhatsApp message to in E.164 format. If a customer ID is not provided, the customer will be looked up by phone number. If no customer is found, a new customer will be created.

initialMessagestring

The initial message to send to the customer. Required if contentSid is not provided.

brandIdstring

The ID of the brand to send the WhatsApp message from

customerIdstring

The ID of the customer to message. If not provided, the customer will be looked up by phone number. If no customer is found, a new customer will be created.

contentSidstring

The Twilio Content Template SID to use for outbound messages. Required for initiating conversations outside the 24-hour session window.

contentVariablesobject

Template variables as key-value pairs for the content template.

workflowIdstring

The ID of the workflow to use for generating the opening message. Required if neither initialMessage nor contentSid is provided.

channelConfigIdstring

The ID of the channel config to use for the WhatsApp message. If not provided, the first active WhatsApp channel config will be used.

inputDataobject

Input data to pass to the workflow when workflowId is provided.

Example request

{
  "phoneNumber": "+61400000000",
  "initialMessage": "Hi! This is a message from Acme Corp.",
  "contentSid": "HX1234567890abcdef1234567890abcdef",
  "contentVariables": {
    "1": "John",
    "2": "Order #123"
  }
}

Response

conversationIdstring required

The ID of the conversation that was created

Changes

Changed in 4 of the 52 revisions of this API.23