API to send a WhatsApp templated message to recipient
Note:
WhatsApp template messages can be sent only to regular WhatsApp users. In other words, you can't send the template message to a business account on WhatsApp. If you are testing WhatsApp templated message API please use your personal WhatsApp phone number instead of your business phone number on Connectly.
Select the WhatsApp number you want to send from
The endpoint supports an optional sender field in the body. If you have multiple WhatsApp phone numbers with Connectly you can choose which one you want to send the message from. The payload needs to contain the optional sender
key specifying the phone number.
{
"sender": "+14151111234",
"number": "+1(604) 585 2331",
"templateName": "tempalte",
"language": "en",
"parameters": []
}
How to use template parameters
The template parameters is a list of objects in the following format:
"parameters": [
{
"name": "body_1",
"value": "YOUR_VALUE"
}, {
"name": "body_2",
"value": "YOUR_VALUE"
}, {
"name": "body_3",
"value": "YOUR_VALUE"
]
The available options for name
keys
name
keysHeader
header_text
- indicates text in the headerheader_image
- indicates image in the header. Thevalue
must be a valid URL with an imageheader_video
- indicates video in the header. Thevalue
must be a valid URL with a video
Body
body_1
- indicates text in the bodybody_2
- indicates text in the bodybody_3
- indicates text in the bodybody_4
- indicates text in the bodybody_5
- indicates text in the bodybody_6
- indicates text in the bodybody_7
- indicates text in the bodybody_8
- indicates text in the bodybody_9
- indicates text in the bodybody_10
- indicates text in the bodybody_11
- indicates text in the bodybody_12
- indicates text in the bodybody_13
- indicates text in the bodybody_14
- indicates text in the bodybody_15
- indicates text in the body
Buttons
button_1_url
- indicates URL link in the button. Thevalue
must be a valid URLbutton_2_url
- indicates URL link in the button. Thevalue
must be a valid URLbutton_3_url
- indicates URL link in the button. Thevalue
must be a valid URLbutton_1_payload
- indicates Payload in the buttonbutton_2_payload
- indicates Payload in the buttonbutton_3_payload
- indicates Payload in the button
Supported template languages
Please see https://developers.facebook.com/docs/whatsapp/api/messages/message-templates/#message-templates for all supported template languages. Your template MUST be approved first for the language variation before you can start using it.
How to create a template
Please see the instructions here https://www.facebook.com/business/help/2055875911147364?id=2129163877102343.