Skip to main content
POST
https://api.zixflow.com
/
api
/
v1
/
campaign
/
rcs
/
message
/
document
Send Document Message
curl --request POST \
  --url https://api.zixflow.com/api/v1/campaign/rcs/message/document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>",
  "botId": "<string>",
  "fileUrl": "<string>",
  "suggestions": [
    {
      "type": "<string>",
      "text": "<string>",
      "postback": "<string>",
      "url": "<string>",
      "phoneNumber": "<string>",
      "label": "<string>",
      "latitude": 123,
      "longitude": 123,
      "title": "<string>",
      "description": "<string>",
      "startTime": "<string>",
      "endTime": "<string>"
    }
  ],
  "source": "<string>",
  "linkWithRecord": true,
  "reportURL": "<string>",
  "submissionStatus": true
}
'
{
  "status": true,
  "message": "Message sent successfully"
}

​
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:
​
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
{
  "status": true,
  "message": "Message sent successfully"
}