Send Carousel Message Template

post

https://elastic.messangi.me/balerion/v3/messages

Once the WhatsApp carousel message template has been created via API and approved, the next step is sending the message template to the end users through the Messages API.

To know how to send a carousel message template go to the Sending a Carousel Message Template section.

Body Params

placeholders

object

Only applies if the 'BODY' type (Message Body) contains personalized fields (placeholders).

Object of personalized fields (placeholders) containing the message body.

From the 'placeholders' object, set as parameter the placeholder you configured that is inside double curly braces {{...}} when creating the message template. Then set the value of the placeholder parameter.

The placeholders must be correctly formatted in order of how the message template was created.

For example, for a message body like 'Here is your {{code}}', you would set the placeholder as 'code': '34871'.

templateName

string

Name of the template created in your WhatsApp Business Account.

templateLanguage

string

Template Language you set when creating the template.

Currently the API supports 3 Languages: English, Spanish and Portuguese. Required if you want to send templates in languages other than English.

English: 'en'

Spanish: 'es'

Portuguese: 'pt_BR', 'pt_PT'

from

string

required

Phone number of the sender.

Phone number provided during the WABA account setup will be used as the sender of the notification message.

Only accepts numeric characters. Do not include the '+' sign.

string

required

Determines the destination phone number for your template message. Numbers are specified in E.164 format → (‘+’ and a country code).

type

string

Specifies the type of message template being sent.

For carousel message templates, this value must be set to 'carousel'.

templateId

string

Unique identifier of the message template.

callbacks

array of strings

callbacks

cards

array of objects

Array that defines the content of each card in the carousel at send time.

Each object in this array corresponds to a card defined in the message template and must follow the same order.

cards

Responses

202Message accepted for processing

400Bad Request

401unauthorized: malformed jwt

410gone: expired jwt

500Internal Server Error