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. Find the Phone ID on the Zixflow WhatsApp Settings page next to
the number. Whatsapp
Settings
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.
If the “linkWithRecord” is set to true, the source from which the WhatsApp
message is sent should be mentioned; otherwise, it defaults to API.
Specify whether to associate the current message with a record and display it
in the inbox. Set it to “true” for linking with a record; otherwise, it
defaults to “false.”
(Optional) Specify the URL where the user’s report and deliveries should be
delivered.
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 astype | sample value |
---|---|
IMAGE_URL | <image-url> |
VIDEO_URL | <video-url> |
DOCUMENT_URL | <document-url> |
TEXT | <text> |
OTP | <otp> |