Get Sendflow Delivery Report

curl --request GET \
  --url https://api-ai.zixflow.com/api/data/sendflow/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/sendflow/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/sendflow/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/sendflow/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/sendflow/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/sendflow/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/sendflow/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": "Sendflow delivery report retrieved successfully",
  "data": {
    "request_id": "8cf12de6-0504-41f9-b576-cbdb20b3e275",
    "execution_id": "exec_123456789",
    "status": "completed",
    "statusAt": "2024-01-15T10:30:00Z",
    "email": "user@example.com",
    "phone": "919876543210",
    "remark": "Sendflow executed 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": "Sendflow delivery report not found for the given request_id"
}

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

GET

api

data

sendflow

delivery-report

Get Sendflow Delivery Report

curl --request GET \
  --url https://api-ai.zixflow.com/api/data/sendflow/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/sendflow/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/sendflow/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/sendflow/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/sendflow/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/sendflow/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/sendflow/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": "Sendflow delivery report retrieved successfully",
  "data": {
    "request_id": "8cf12de6-0504-41f9-b576-cbdb20b3e275",
    "execution_id": "exec_123456789",
    "status": "completed",
    "statusAt": "2024-01-15T10:30:00Z",
    "email": "user@example.com",
    "phone": "919876543210",
    "remark": "Sendflow executed 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": "Sendflow 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 execution status and details of a Sendflow workflow that was triggered. Use the request_id that was returned when you triggered the Sendflow to get the delivery report.

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 Sendflow was triggered. This ID is used to track the execution status of the workflow.

Response

boolean

Indicates whether the API call was successful.

string

Success or error message from the API.

object

The Sendflow delivery report data containing the following fields:

string

The request ID that was used to query this report.

string

The unique execution ID for this Sendflow workflow run.

string

The current execution status of the Sendflow workflow.

string

Timestamp indicating when the status was last updated.

string

The email address associated with this Sendflow execution (if applicable).

string

The phone number associated with this Sendflow execution (if applicable).

string

Additional remarks or notes about the execution status.

string

The workspace ID associated with this Sendflow execution.

{
  "success": true,
  "message": "Sendflow delivery report retrieved successfully",
  "data": {
    "request_id": "8cf12de6-0504-41f9-b576-cbdb20b3e275",
    "execution_id": "exec_123456789",
    "status": "completed",
    "statusAt": "2024-01-15T10:30:00Z",
    "email": "user@example.com",
    "phone": "919876543210",
    "remark": "Sendflow executed 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": "Sendflow delivery report not found for the given request_id"
}

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

Stop Sendflow Execution Events Introduction

Zixflow AI

Sendflow

Events

WhatsApp

RCS

SMS

Email

Delivery Report

Get Sendflow Delivery Report

Description

Headers

Query Parameters

Response

​Description

​Headers

​Query Parameters

​Response

Description

Headers

Query Parameters

Response