> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Message Delivery Report

> Retrieves a single message delivery report by request_id

#### 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

<ParamField header="x-api-key" type="string" required placeholder="Enter your API key">
  Your API key for authentication.
</ParamField>

<ParamField header="x-workspace-id" type="string" required placeholder="Enter your workspace ID">
  Your workspace ID for authentication.
</ParamField>

#### Query Parameters

<ParamField query="request_id" type="string" required placeholder="Enter request ID">
  The unique request ID that was returned when the message was sent. This ID is used to track the delivery status of the message.
</ParamField>

#### Response

<ResponseField name="success" type="boolean">
  Indicates whether the API call was successful.
</ResponseField>

<ResponseField name="message" type="string">
  Success or error message from the API.
</ResponseField>

<ResponseField name="data" type="object">
  The delivery report data containing the following fields:
</ResponseField>

<ResponseField name="data.channel" type="string">
  The communication channel used (e.g., "whatsapp", "sms", "email", "rcs").
</ResponseField>

<ResponseField name="data.message_id" type="string">
  The unique identifier for the message.
</ResponseField>

<ResponseField name="data.recipient" type="string">
  The recipient's contact information (phone number or email address).
</ResponseField>

<ResponseField name="data.request_id" type="string">
  The request ID that was used to query this report.
</ResponseField>

<ResponseField name="data.status" type="string">
  The current delivery status of the message.
</ResponseField>

<ResponseField name="data.statusAt" type="string">
  Timestamp indicating when the status was last updated.
</ResponseField>

<ResponseField name="data.remark" type="string">
  Additional remarks or notes about the delivery status.
</ResponseField>

<ResponseField name="data.workspace_id" type="string">
  The workspace ID associated with this message.
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "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"
    }
  }
  ```

  ```json 400-Bad Request theme={null}
  {
    "success": false,
    "message": "Invalid request_id parameter"
  }
  ```

  ```json 401-Unauthorized theme={null}
  {
    "success": false,
    "message": "Unauthorized. Please check your API key and workspace ID."
  }
  ```

  ```json 404-Not Found theme={null}
  {
    "success": false,
    "message": "Delivery report not found for the given request_id"
  }
  ```

  ```json 500-Internal Server Error theme={null}
  {
    "success": false,
    "message": "Internal server error. Please try again later."
  }
  ```
</ResponseExample>
