POST
/
api
/
v1
/
campaign
/
whatsapp
/
message
/
send
curl --request POST \
  --url https://api.zixflow.com/api/v1/campaign/whatsapp/message/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "to": "<string>",
  "phoneId": "<string>",
  "type": "<string>",
  "image": {
    "link": "<string>",
    "caption": "<string>"
  },
  "source": "<string>",
  "linkWithRecord": true,
  "reportURL": "<string>",
  "submissionStatus": true
}'
{
  "status": true,
  "message": "Message sent successfully"
}

You can send messages only if the user session is already active; otherwise, the messages will fail. We recommend sending a approved template message the first time you contact users. Once the session is open, you can send unlimited messages via these APIs. For more info click here

​
Body

​
to
string
required

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

​
phoneId
string
required

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

​
type
string
default:"image"
required

To send image messages keep message type as “image”

​
image
object
required

A Image Object consists of 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

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"
}