Send Text Message Template

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

Once the whatsApp text message template has been created via UI or API and approved, the next step is sending the template to the end users through the Messages API.

To know how to send a text message template go to the Sending a Text Message Template section.

Body Params

placeholders

object

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

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

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

For example, for a text 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).

templateId

string

Unique identifier of the template.

Responses

Response body

object

meta

object

timestamp

int64

required

Transaction's date in timestamp

transactionId

string

required

Id for the current transaction (Endpoint's call)

explain

string

Explain string in case of failure

data

object

Data contained in the Message object.

string

Unique identifier of the WhatsApp message.

body

string

Content of the text template message that will be sent to the end user.

Emojis and markdown are supported. Maximum length: 1024 characters.

from

string

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

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

date

date-time

Date when the message has been sent.

statusDate

date-time

Date when the last update or status change.

externalId

string

Alphanumeric identifier used for reporting purposes.

owner

string

Owner or creator of the message.

operator

string

User who is a member of the owner or creator’s space.

status

string

When a Message is sent, the system assigns one of the following possible statuses to an WhatsApp message:

´CODE_NOT_ALLOWED´: Messangi suggests that the WhatsApp Business Account (WABA) used is either not activated on the platform or lacks the capability to message the recipient. Additionally, it could be because the owner does not have a WABA assigned , which is required to send the message.
Contact our support team to verify the WABA.

´INCOMPLETE´: Messangi indicates that a personalized WhatsApp message was sent without the necessary placeholder data filled in.
Please note, personalized messages are those that feature dynamic fields—like ´Name´, ´Phone Number´, ´Last Name´, and similar—which need to be populated before sending.
´BLACKLISTED´: Messangi indicates that the intended recipient's phone number is on a blacklist, preventing any messages from being sent to that number.

When a number is blacklisted, it is essentially blocked from receiving any further communications from the sender's number or campaign, ensuring that no messages are delivered to that recipient.

´QUOTA_EXCEEDED´: The WhatsApp Business Account (WABA) has surpassed the allowed limit for sending messages within a specified period, as defined by WhatsApp's messaging policies or limits.
´SENT´: Indicates that the message has been successfully dispatched from our system and is en route to META. This status means that the message is on its way to the recipient but does not confirm that the message has been delivered to the end user. It signifies a successful handoff to the next stage in the message delivery process.
´DELIVERED´: Messangi has received confirmation of message delivery from META.
The message has successfully reached the recipient's device. This status confirms that the message not only was sent and processed by META but also was received by the intended recipient's WhatsApp application, ensuring that the communication was successfully completed.
´READ´: Indicates that the recipient has opened and seen the message.
´FAILED´: Indicates that META could not deliver the message to the recipient's device.

providerId

string

Unique identifier of the provider. The support team provides this Id once the account has been approved.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://elastic.messangi.me/balerion/v3/messages \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Message accepted for processing

400Bad Request

401unauthorized: malformed jwt

410gone: expired jwt

500Internal Server Error