Nifteem

Dispatch messages info

GET /v1/api/dispatch/{dispatchId}
X api key

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.

Path parameters

  • dispatchId string Required

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • dispatchId string Required
    • scheduleDate string(date-time) Required
    • metadata object Required
      Hide metadata attribute Show metadata attribute object
      • * string Additional properties
    • messages array[object] Required
      Hide messages attributes Show messages attributes object
      • messageId string Required
      • sender string Required
      • channelIdentifier string Required
      • channel string Required

        Values are RCS, SMS, or WHATSAPP.

      • part integer(int32) Required
      • totalParts integer(int32) Required
      • status string Required

        Values are DISPATCHED, NOSENT, SENT, FAILED, DELIVERED, READ, or DELETED.

      • statusDate string(date-time)
    • pendingCount integer(int64) Required
  • 401

    Unauthorized

  • 403

    Forbidden

  • 400

    Bad Request

  • 500

    Internal Server Error

GET /v1/api/dispatch/{dispatchId} 
curl \
 --request GET 'https://api.nifteem.com/v1/api/dispatch/{dispatchId}' \
 --header "X-API-Key: $API_KEY"
Response examples (200) 
{
  "dispatchId": "string",
  "scheduleDate": "2025-05-04T09:42:00Z",
  "metadata": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "messages": [
    {
      "messageId": "string",
      "sender": "string",
      "channelIdentifier": "string",
      "channel": "RCS",
      "part": 42,
      "totalParts": 42,
      "status": "DISPATCHED",
      "statusDate": "2025-05-04T09:42:00Z"
    }
  ],
  "pendingCount": 42
}