Sending WhatsApp messages
In order to send a WhatsApp message, you must have an active WhatsApp channel and perform a HTTP request to the following endpoint with a valid access key
Send a message
Send a message to a channel
The ID of the workspace
The ID for a channel
A reference to the message. This can be used to identify the message in the channel.
"my-own-identifier"
If set to true, the frequency capping settings of the platform will be used
to either allow or reject the message to a contact. Can only be set to true
if the message is sent to a contact and .meta.extraInformation.useCase
is marketing
.
If set to true and message is a test/campaign message, web tracking parameters will be appended to the links in the message.
If set to true, quiet hours settings will be ignored and the message will be sent as soon as possible.
Do not check if the recipient is part of global holdout. To be used to send transactional messages.
Tags to associate with the message. Tags are converted to lower case and tags that do not exist are automatically created. You can view your created tags in the UI. You can specify up to 10 tags per message.
SMS link shortening options. When using templates, please refer to
the template level shortLinks
instead.
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When
set, the message status will be scheduled
until it's sent. Messages scheduled
for a time in the past or within 10 minutes of the request may be sent
immediately. Messages scheduled farther than 35 days will be rejected.
Validity determines for how many seconds a message is valid. If none is provided, the channel message type will be used to determine it. A promotional, conversational or transactional channel message is valid for 36 hours (129600 seconds). A message sent from a 2FA channel is valid for 10 minutes (600 seconds).
Message was accepted for processing
A reference to the message. This can be used to identify the message in the channel.
"my-own-identifier"
This field is used to store additional information related to the message status.
Tags to associate with the message. Tags are converted to lower case and tags that do not exist are automatically created. You can view your created tags in the UI. You can specify up to 10 tags per message.
SMS link shortening options. When using templates, please refer to
the template level shortLinks
instead.
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When
set, the message status will be scheduled
until it's sent. Messages scheduled
for a time in the past or within 10 minutes of the request may be sent
immediately. Messages scheduled farther than 35 days will be rejected.
When sending outbound messages as well as setting the receiver information you must set message body field in all cases except for sending a message template when you must only set the template field
Body
Template
Get channel details for a contact
Retrieve channel information for a given contact.
The ID of the workspace
The ID for a channel
The ID for a contact
OK
The Channels API supports many of the features of WhatsApp, however due to the omni channel nature of the API there may be some differences between the Channels API message and the native WhatsApp API. Here is an overview of the WhatsApp messages types and Channels API message types:
text
image / sticker
audio / document / video
location
reaction
-
interactive - quick reply button
interactive - list
interactive - multi product message
-
interactive - product
-
contacts
-
replies
template
Outbound messages
Except for the template section all examples below must be set in the body field.
Text
Text Message
Text message with reply buttons
Text message with postback actions
Text message with reply and postback actions
Text message with location request
Image
Single image message
Single image message with text
Multiple image message
Single image message with postback actions
Single image message with label and reply actions
Single image message with label, postback and reply actions
Multiple images message with labels and postback actions
Multiple images message with reply actions
Multiple images message with labels, postback and reply actions
File
Single file message
Single file message with postback and reply actions
Multiple files message
Multiple files message with filename
Multiple files message with two postback actions and a reply action
Location
List
List message without sections
List message with sections
List message with sections and custom button label
ReplyTo
You can send any outbound message as a reply to a previous message by setting the replyTo object as shown below. The replyTo.id should be set to the id of a received message and the replyTo.type should be set to "message"
ReplyTo with a text message
ReplyTo with an image message
ReplyTo with text message with postback actions
Template
Text template with variable
Image template with button and variables
Image with a variable in a button
Last updated