Skip to main content
POST
Send Template Message

Send RCS Template Message

This API enables you to send RCS template messages to users who have a live session. Only approved templates are supported for message sending.

Request Body Parameters

string
required
Specifies the recipient’s phone number in international format (e.g., “1xxxxxxxxxx”).
string
required
This is the unique identifier associated with the RCS bot. Find the BOT ID on the Zixflow RCS Settings page. RCS Settings
string
required
The name of the approved template for sending RCS messages.
object
(Optional) An object with key-value pairs to populate template placeholders.
string
default:"API"
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.”
string
(Optional) Specify the URL where the user’s report and deliveries should be delivered.
boolean
(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

boolean
Indicates if the API call was successful. Returns true if successful, false otherwise.
string
Provides a message indicating success or details of any error.

Response Examples