Send Flow with Message Template

post

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

When a WhatsApp Message Template includes a Static WhatsApp Flow, the Flow becomes an integral part of the template definition. It is delivered automatically whenever that message template is sent to an end user. This delivery method is designed for outbound communication scenarios, where the business initiates the interaction without relying on an active customer conversation window. From a sending perspective, the message template acts as the entry point, while the Flow represents the interactive experience that the user launches by selecting the template’s call-to-action (CTA) button. Once the CTA is tapped, WhatsApp renders the associated Flow directly within the chat.

Body Params

placeholders

object

Object that contains the personalized values assigned to each variable defined in the text header, body, or both.

templateName

string

Name of the Message Template created and approved 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

externalId

string

Alphanumeric identifier used for reporting purposes

callbacks

array of strings

Indicate one or more (separated by a comma) webhook URLs to notify about the status of the message delivery. That is, if you want to receive the status of the message you've sent to your subscribers, you need to specify your endpoint

Your endpoint must have an HTTP POST access method and receive a JSON body

The URL is the external callback where the events of the Email will be registered and published. Once an email is processed, its status will be posted to your callback URL

To view the full list and meaning of each status, please refer to the WhatsApp Status section.

callbacks

from

string

required

Phone number of the sender.

The 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).

Responses

202Message accepted for processing

400Bad Request

401unauthorized: malformed jwt

410gone: expired jwt

500Internal Server Error