ComRaidComRaid Docs
API referenceMessages

List Deliveries for a Message

Cursor-paged Deliveries for one Message. Order is `created_at ASC, id ASC`. Pass `next_cursor` from a previous response as `cursor` to continue. Filter by Delivery `status` and Endpoint `platform` when set.

GET
/messages/{id}/deliveries

Cursor-paged Deliveries for one Message. Order is created_at ASC, id ASC. Pass next_cursor from a previous response as cursor to continue. Filter by Delivery status and Endpoint platform when set.

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Project API key (cr_sk_...)

Path Parameters

id*string
Formatuuid

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
cursor?string

Opaque cursor from a previous next_cursor

status?string

Customer-facing Delivery outcome. sent means the Provider accepted the handoff; delivered means the device acknowledged receipt; opened is open/action ACK. failed is tried and could not complete; skipped was never offered to the Provider (cancel, Inactive, Opted out, preference block, invalid token, contact mismatch, and equivalents).

Value in"queued""processing""sent""delivered""opened""failed""skipped"
platform?string
Value in"android""ios"

Response Body

Page of Deliveries

application/json
  1. response
deliveries*array<>
next_cursor?string

Present when another page is available; pass as cursor on the next request

Example Request
curl -X GET 'https://api.comraid.io/messages/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries'
Example Response
{  "deliveries": [    {      "delivery_id": "9892f438-d31c-4ff2-bc84-146525b292ff",      "channel": "string",      "provider": "string",      "platform": "string",      "model": "string",      "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",      "external_user_id": "string",      "status": "queued",      "attempt_count": 0,      "provider_message_id": "string",      "queued_at": "2019-08-24T14:15:22Z",      "sent_at": "2019-08-24T14:15:22Z",      "delivered_at": "2019-08-24T14:15:22Z",      "opened_at": "2019-08-24T14:15:22Z",      "failed_at": "2019-08-24T14:15:22Z",      "error_code": "string",      "error_message": "string",      "action_id": "string",      "action_clicked_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}