Send Whatsapp Message
curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/whatsapp/send' \
--header 'Authorization: Bearer {{zixflow_api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"to": "13023895111",
"phoneId": "104898309288724",
"templateName": "marketing_sample_2",
"language": "en",
"variables": {
"video":"http://techslides.com/demos/sample-videos/small.mp4"
},
"submissionStatus": true
}'
{
"status": true,
"message": "Message sent successfully"
}
Body
Specifies the recipient’s phone number in international format (e.g., “1xxxxxxxxxx”).
This is the unique identifier associated with the sender’s phone number given by WhatsApp.
Refers to the name of the template to be used for the WhatsApp message. In this case, it is set to “hello_world.” You can obtain it from the template list screen.
Specifies the language of the message, with “en_US” representing American English. You can get it from the template list screen.
Custom variables used for the template. Please provide a JSON object with the required data.
Indicates whether to wait for the submission status. Set it to “true” if you want to wait for the submission status; otherwise, it defaults to “false.”
Response
Indicates whether the call was successful. true if successful, false if not.
success or error response message
Variables
To know all required variable and their keys for selected template, use above Get Template Variable API. It will return response as
{
"status": true,
"message": "Success",
"data": [
{
"label": "Header Image",
"keyName": "image",
"type": "IMAGE_URL"
},
{
"label": "Body 1",
"keyName": "body_1",
"type": "TEXT"
}
]
}
| type | sample value |
|---|---|
| IMAGE_URL | <image-url> |
| VIDEO_URL | <video-url> |
| DOCUMENT_URL | <document-url> |
| TEXT | <text> |
For above variable response the varibales value will be
{
variables:{
"image": "<image-url>",
"body_1": "<variable-text>"
....
[keyName]:"<variable-value>"
}
}
curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/whatsapp/send' \
--header 'Authorization: Bearer {{zixflow_api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"to": "13023895111",
"phoneId": "104898309288724",
"templateName": "marketing_sample_2",
"language": "en",
"variables": {
"video":"http://techslides.com/demos/sample-videos/small.mp4"
},
"submissionStatus": true
}'
{
"status": true,
"message": "Message sent successfully"
}