ListMessagesResponse

Paginated list of messages.

messages object[]required

Messages matching filters.

Array [

attemptsinteger<int32>required

Number of delivery attempts made.

Example: 1

categorystring | nullnullable

Event category.

Example: transactional

channelstring | nullnullable

Channel dispatched or selected.

Example: sms

cost_micro_usdinteger<int64>required

Cost incurred in micro-USD ($0.000001).

Example: 5000

created_atstring<date-time>required

Ingestion timestamp.

error_codestring | nullnullable

Error code if delivery failed.

error_detailstring | nullnullable

Human-readable error detail if delivery failed.

event_idstringrequired

Public event ID (evt_<hex>).

Example: evt_018e123456787abc8def0123456789ab

event_namestringrequired

Event name originally triggered.

Example: order.confirmed

events object[]

Chronological delivery timeline events.

Array [

detail

Additional provider or failure details.

occurred_atstring<date-time>required

Timestamp when this event step occurred.

providerstring | nullnullable

Provider executing this step.

Example: termii

seqinteger<int64>required

Monotonic sequence number.

Example: 1

statusstringrequired

Step status (queued, sent, delivered, failed).

Example: delivered

]

priorityinteger<int32>required

Priority level (0 = Critical, 1 = High, 2 = Normal, 3 = Low).

Example: 1

providerstring | nullnullable

Downstream provider that handled or attempted delivery.

Example: termii

provider_message_idstring | nullnullable

Provider's external message ID.

Example: msg_ext_778899

statusstringrequired

Current delivery status (TRIGGERED, DELIVERED, FAILED, etc.).

Example: DELIVERED

subscriber_idstringrequired

Target subscriber identifier.

Example: usr_prod_9921

test_modebooleanrequired

True if triggered using a test API key.

Example: false

updated_atstring<date-time>required

Last update timestamp.

variables_keysstring[]required

Keys of variables supplied in the payload. Raw values are not stored.

Example: ["order_id","amount"]

]

next_cursorstring | nullnullable

Cursor for fetching the next page, or omitted if at the end.

ListMessagesResponse

{
  "messages": [
    {
      "attempts": 1,
      "category": "transactional",
      "channel": "sms",
      "cost_micro_usd": 5000,
      "created_at": "2024-07-29T15:51:28.071Z",
      "error_code": "string",
      "error_detail": "string",
      "event_id": "evt_018e123456787abc8def0123456789ab",
      "event_name": "order.confirmed",
      "events": "Unknown Type: array,null",
      "priority": 1,
      "provider": "termii",
      "provider_message_id": "msg_ext_778899",
      "status": "DELIVERED",
      "subscriber_id": "usr_prod_9921",
      "test_mode": false,
      "updated_at": "2024-07-29T15:51:28.071Z",
      "variables_keys": [
        "order_id",
        "amount"
      ]
    }
  ],
  "next_cursor": "string"
}