Send Text Message
Body
Specifies the recipient’s phone number in international format (e.g., “1xxxxxxxxxx”).
This is the unique identifier associated with the RCS bot. Find the BOT ID on the Zixflow RCS Settings page. RCS Settings
text messages which need to send. Maximum length: 4096 characters.
A Suggestions Object includes the following fields and formatting options:
Suggestion Type Options: “reply”, “open-url”, “dialer”, “location”, “calendar-event”
Displayed as button text to the end user.
(Optional) Used to track user interactions. When clicked, a unique postback event is triggered on the webhook.
Required if type is “open-url”. Must be a valid URL. Example: https://google.com
Required for “dialer” type. Must be a valid phone number with country code and ”+” prefix. Example: +919876543210
Required for “location” type. Label for the location. Example: “Office Location”
Required for “location” type. Latitude value in numeric format. Example: 12.9363301
Required for “location” type. Longitude value in numeric format. Example: 77.6084231
Required for “calendar-event” type. Event title. Example: “Zixflow Appointment”
Required for “calendar-event” type. Event description. Example: “Appointment with Zixflow team to understand their application.”
Required for “calendar-event” type. Start date and time in ISO format. Example: “2024-11-30T14:00:00Z”
Required for “calendar-event” type. End date and time in ISO format. Example: “2024-11-30T15:00:00Z”
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.
(Optional) 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