List STR messages

Lists outbound and inbound STR messages with optional filters and cursor-based pagination. The cursor is opaque — pass the nextCursor value from a previous response to continue. Filters can be combined freely; results are merged in the requested sort order.

GET /v1/str/messages

List STR messages

cURL

curl --request GET \
  --url https://spb.sandbox.lerian.net/v1/str/messages \
  --header 'Authorization: Bearer <token>'

200

{
  "correlationId": "<string>",
  "items": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "direction": "<string>",
      "messageType": "<string>",
      "nuOp": "<string>",
      "status": "<string>",
      "amount": "<string>",
      "controlNumber": "<string>",
      "mqMessageId": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "strStatus": "<string>"
    }
  ],
  "limit": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Query Parameters

cursor · string

Opaque pagination token from a previous response.

limit · integer<int64> · default: 20

Page size (default 20, max 100).

Required range: 1 <= x <= 100

sort_order · enum<string>

Sort order (default desc, most recent first).

Available options: asc, desc

message_type · string

Filter by STR message type (e.g. STR0004).

status · enum<string>

Filter by processing status.

Available options: SUBMITTED, DELIVERED, CONFIRMED, REJECTED, FAILED, RETURNED, CANCELED, RECEIVED

direction · enum<string>

Filter by message direction.

Available options: inbound, outbound

start_date · string

Lower bound for created_at (RFC3339 or YYYY-MM-DD).

end_date · string

Upper bound for created_at (RFC3339 or YYYY-MM-DD).

Response

200

application/json

OK

correlationId · string · required

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Example:

"req-7a3f9c2e"

items · object[] | null · required

Page of message summaries ordered most-recent-first.

Show child attributes

limit · integer<int64> · required

Page size applied to this response (number of items requested).

Example:

50

nextCursor · string

Opaque cursor for the next page; absent when there are no more results. Presence signals more results, absence signals end-of-list.

Example:

"eyJjcmVhdGVkQXQiOiIyMDI2LTA1LTA0VDE4OjMwOjAwWiIsImlkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIn0"

prevCursor · string

Opaque cursor for the previous page; reserved for future bidirectional cursoring, absent today.