Dispatch messages info

GET

/v1/api/dispatch/{dispatchId}

It returns details of a specific dispatch. The response includes an array of individual messages that have been processed, along with a pendingCount property indicating the quantity of messages that remain in the processing queue.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Responses

🟢200

application/json

Body

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v1/api/dispatch/' \
--header 'X-API-Key: <api-key>'

Response Example

200 - Example 1

{
    "dispatchId": "string",
    "scheduleDate": "2019-08-24T14:15:22.123Z",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "messages": [
        {
            "messageId": "string",
            "sender": "string",
            "channelIdentifier": "string",
            "channel": "RCS",
            "part": 0,
            "totalParts": 0,
            "status": "DISPATCHED",
            "statusDate": "2019-08-24T14:15:22.123Z",
            "metadata": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "pendingCount": 0
}

Modified at 2026-01-24 07:01:45

Request a message dispatch

Cancel a message dispatch