Skip to main content
GET
https://api-ai.zixflow.com
/
api
/
data
/
messages
/
v1
/
delivery-report
Get Message Delivery Report
curl --request GET \
  --url https://api-ai.zixflow.com/api/data/messages/v1/delivery-report \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "success": true,
  "message": "Delivery report retrieved successfully",
  "data": {
    "channel": "whatsapp",
    "message_id": "wamid.XXX",
    "recipient": "919876543210",
    "request_id": "66e120d1b9eht5059e5e01d",
    "status": "delivered",
    "statusAt": "2024-01-15T10:30:00Z",
    "remark": "Message delivered successfully",
    "workspace_id": "workspace_123"
  }
}

​
Description

This endpoint allows you to retrieve the delivery status and details of a message that was sent through any channel (WhatsApp, SMS, Email, RCS) by providing the request_id that was returned when the message was sent.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Query Parameters

​
request_id
string
required
The unique request ID that was returned when the message was sent. This ID is used to track the delivery status of the message.

​
Response

​
success
boolean
Indicates whether the API call was successful.
​
message
string
Success or error message from the API.
​
data
object
The delivery report data containing the following fields:
​
data.channel
string
The communication channel used (e.g., “whatsapp”, “sms”, “email”, “rcs”).
​
data.message_id
string
The unique identifier for the message.
​
data.recipient
string
The recipient’s contact information (phone number or email address).
​
data.request_id
string
The request ID that was used to query this report.
​
data.status
string
The current delivery status of the message.
​
data.statusAt
string
Timestamp indicating when the status was last updated.
​
data.remark
string
Additional remarks or notes about the delivery status.
​
data.workspace_id
string
The workspace ID associated with this message.
{
  "success": true,
  "message": "Delivery report retrieved successfully",
  "data": {
    "channel": "whatsapp",
    "message_id": "wamid.XXX",
    "recipient": "919876543210",
    "request_id": "66e120d1b9eht5059e5e01d",
    "status": "delivered",
    "statusAt": "2024-01-15T10:30:00Z",
    "remark": "Message delivered successfully",
    "workspace_id": "workspace_123"
  }
}