COcollectwise

Get text delivery status

Changed on

Returns delivery status for a previously sent message. messageId is the value returned by the send endpoint. Delivery reports arrive asynchronously from the carrier, so poll after a short delay.

get/text/status/{messageId}

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/text/status/{messageId}
  • Auth
    API key in header collectwise_key

Path parameters

messageIdstring required

The messageId returned by the send endpoint.

Headers

x-cw-timestampstring

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

x-cw-signaturestring

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Response

Current delivery status.

messageIdstring required
statusstring required

Carrier status: Queued, Sent, Delivered, or Rejected / Failed / Undelivered on failure.

deliveredboolean required
failedboolean required
failureClassification'FATAL' | 'NON_FATAL' nullable

On failed messages: FATAL (do not retry), NON_FATAL (transient, retry may succeed), or null when the carrier reason is unrecognized.

retryRecommendedboolean

True when the failure is NON_FATAL and a retry may succeed.

createdAtstring date-time
updatedAtstring date-time

Changes

  • 95fad0d2f369Revision changes
    • breaking

      the response property became optional for the status

    • info

      added the new optional header request parameter x-cw-signature

    • info

      added the new optional header request parameter x-cw-timestamp