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

import requests

url = "https://api-ai.zixflow.com/api/data/messages/v1/delivery-report"

headers = {
    "x-api-key": "<x-api-key>",
    "x-workspace-id": "<x-workspace-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-workspace-id': '<x-workspace-id>'}
};

fetch('https://api-ai.zixflow.com/api/data/messages/v1/delivery-report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-ai.zixflow.com/api/data/messages/v1/delivery-report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-ai.zixflow.com/api/data/messages/v1/delivery-report"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-workspace-id", "<x-workspace-id>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("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>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-ai.zixflow.com/api/data/messages/v1/delivery-report")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-workspace-id"] = '<x-workspace-id>'

response = http.request(request)
puts response.read_body

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

{
  "success": false,
  "message": "Invalid request_id parameter"
}

{
  "success": false,
  "message": "Unauthorized. Please check your API key and workspace ID."
}

{
  "success": false,
  "message": "Delivery report not found for the given request_id"
}

{
  "success": false,
  "message": "Internal server error. Please try again later."
}

GET

api

data

messages

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

import requests

url = "https://api-ai.zixflow.com/api/data/messages/v1/delivery-report"

headers = {
    "x-api-key": "<x-api-key>",
    "x-workspace-id": "<x-workspace-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-workspace-id': '<x-workspace-id>'}
};

fetch('https://api-ai.zixflow.com/api/data/messages/v1/delivery-report', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-ai.zixflow.com/api/data/messages/v1/delivery-report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-ai.zixflow.com/api/data/messages/v1/delivery-report"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-workspace-id", "<x-workspace-id>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("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>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-ai.zixflow.com/api/data/messages/v1/delivery-report")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-workspace-id"] = '<x-workspace-id>'

response = http.request(request)
puts response.read_body

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

{
  "success": false,
  "message": "Invalid request_id parameter"
}

{
  "success": false,
  "message": "Unauthorized. Please check your API key and workspace ID."
}

{
  "success": false,
  "message": "Delivery report not found for the given request_id"
}

{
  "success": false,
  "message": "Internal server error. Please try again later."
}

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

string

required

Your API key for authentication.

string

required

Your workspace ID for authentication.

Query Parameters

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

boolean

Indicates whether the API call was successful.

string

Success or error message from the API.

object

The delivery report data containing the following fields:

string

The communication channel used (e.g., “whatsapp”, “sms”, “email”, “rcs”).

string

The unique identifier for the message.

string

The recipient’s contact information (phone number or email address).

string

The request ID that was used to query this report.

string

The current delivery status of the message.

string

Timestamp indicating when the status was last updated.

string

Additional remarks or notes about the delivery status.

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

{
  "success": false,
  "message": "Invalid request_id parameter"
}

{
  "success": false,
  "message": "Unauthorized. Please check your API key and workspace ID."
}

{
  "success": false,
  "message": "Delivery report not found for the given request_id"
}

{
  "success": false,
  "message": "Internal server error. Please try again later."
}

Send Email Template

Zixflow AI

Sendflow

Events

WhatsApp

RCS

SMS

Email

Delivery Report

Get Message Delivery Report

Description

Headers

Query Parameters

Response

​Description

​Headers

​Query Parameters

​Response

Description

Headers

Query Parameters

Response