Campaign Report
Get Whatsapp Message Report
API Documentation
Multi-Channel Message
Whatsapp Campaign
RCS Campaign
SMS Campaign
Email Campaign
Attributes
- Attribute Options
- Attribute Status
- GETGet List Of Attributes
- GETGet Attribute By ID
- POSTCreate Custom Attribute
- PATCHUpdate Custom Attribute
- DELDelete Custom Attribute
Collection Records
List Entries
Activity / Task
Workspace Members
Campaign Report
Get Whatsapp Message Report
GET
/
api
/
v1
/
campaign
/
report
/
whatsapp
/
{messageId}
Copy
curl --request GET \
--url https://api.zixflow.com/api/v1/campaign/report/whatsapp/{messageId} \
--header 'Authorization: Bearer <token>'
Copy
{
"status": true,
"message": "Successfully fetched",
"data": {
"accountId": "652e5068c33fe15059e5s020",
"messageId": "66e120d1b9ee33b6ba00fsd7",
"campaignId": "66e120d1b9eht5059e5e01d",
"status": "DELIVERED",
"statusAt": "2024-09-11T04:47:16.000Z",
"destination": "919090909090",
"remark": ""
}
}
Path Params
Enter the message ID that you received when sending the campaign.
Response
Indicates whether the call was successful. true if successful, false if not.
success or error response message
The contents of uploaded file
It refers to your account ID or workspace ID.
It refers to your message ID
It refers to your campaign ID.
It refers to report status (SENT, DELIVERED, FAILED, READ)
It refers to last status time
It refers to the recipient’s phone number where the message was sent.
It refers to failed reason for message if it failed or undelivered.
Copy
curl --request GET \
--url https://api.zixflow.com/api/v1/campaign/report/whatsapp/{messageId} \
--header 'Authorization: Bearer <token>'
Copy
{
"status": true,
"message": "Successfully fetched",
"data": {
"accountId": "652e5068c33fe15059e5s020",
"messageId": "66e120d1b9ee33b6ba00fsd7",
"campaignId": "66e120d1b9eht5059e5e01d",
"status": "DELIVERED",
"statusAt": "2024-09-11T04:47:16.000Z",
"destination": "919090909090",
"remark": ""
}
}