POST
/
api
/
v1
/
campaign
/
rcs
/
message
/
document

Body

to
string
required

Specifies the recipient’s phone number in international format (e.g., “1xxxxxxxxxx”).

botId
string
required

This is the unique identifier associated with the RCS bot. Find the BOT ID on the Zixflow RCS Settings page. RCS Settings

fileUrl
string
required

Document url which need to send

suggestions
array
required

A Suggestions Object includes the following fields and formatting options:

type
string
default: "reply"required

Suggestion Type Options: “reply”, “open-url”, “dialer”, “location”, “calendar-event”

text
string
required

Displayed as button text to the end user.

postback
string

(Optional) Used to track user interactions. When clicked, a unique postback event is triggered on the webhook.

url
string

Required if type is “open-url”. Must be a valid URL. Example: https://google.com

phoneNumber
string

Required for “dialer” type. Must be a valid phone number with country code and ”+” prefix. Example: +919876543210

label
string

Required for “location” type. Label for the location. Example: “Office Location”

latitude
number

Required for “location” type. Latitude value in numeric format. Example: 12.9363301

longitude
number

Required for “location” type. Longitude value in numeric format. Example: 77.6084231

title
string

Required for “calendar-event” type. Event title. Example: “Zixflow Appointment”

description
string

Required for “calendar-event” type. Event description. Example: “Appointment with Zixflow team to understand their application.”

startTime
string

Required for “calendar-event” type. Start date and time in ISO format. Example: “2024-11-30T14:00:00Z”

endTime
string

Required for “calendar-event” type. End date and time in ISO format. Example: “2024-11-30T15:00:00Z”

source
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.

linkWithRecord
boolean

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.”

reportURL
string

(Optional) Specify the URL where the user’s report and deliveries should be delivered.

submissionStatus
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

status
boolean

Indicates whether the call was successful. true if successful, false if not.

message
string

success or error response message