Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
Messages

Send Flow with Message Template

When a WhatsApp Message Template includes a Static WhatsApp Flow, the Flow becomes an integral part of the message 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 message template’s call-to-action (CTA) button. Once the CTA is tapped, WhatsApp renders the associated Flow directly within the chat.

post/v3/messages

Request body

placeholdersobject

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

templateNamestring

Name of the Message Template created and approved in your WhatsApp Business Account.

templateLanguagestring
<p>Message Template Language you set when creating the message template.</p>Currently the API supports 3 Languages: English, Spanish and Portuguese. Required if you want to send message templates in languages other than English.<p></p><p><b>English</b>: <code>´en´</code></p><p><b>Spanish</b>: <code>´es´</code></p><p><b>Portuguese</b>: <code>´pt_BR´</code>, <code>´pt_PT</code></p>
externalIdstring

Alphanumeric identifier used for reporting purposes

callbacksstring[]
<p>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 contacts, you need to specify your endpoint</p> <p>Your endpoint must have an <b>HTTP POST</b> access method and receive a JSON body</p> <p>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</p> <p>To view the full list and meaning of each status, please refer to the <a href=https://docs.messangi.com/docs/whatsapp-status target=´_blank´> WhatsApp Status</a> section.</p>
fromstring required
<p>Phone number of the sender.</p> <p>The phone number provided during the WABA account setup will be used as the sender of the notification message.</p> <p><b>Only accepts numeric characters. Do not include the ´+´ sign.</b></p>
tostring required

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

Response

Message accepted for processing

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  }
}
All 71 operations