Rivier/ Reference/ inbox

The message event stream from a cursor

get/message-events

The message event stream from a cursor: every state change on every channel, oldest first.

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:read
Graphql
Query.inboxMessageEventList
Sdk
inbox.messageEvent.list
Cli
inbox message event list

Parameters

  • afterinteger
    In the query
  • limitinteger
    In the query
  • channelstring
    In the query
  • statestring
    In the query

Responses

  • 200application/json
    Success
    • eventslist of objectrequired
      • seqnumberrequired
      • messageIdstring (uuid)required
      • channelstringrequired
        One of: email, sms, mms, whatsapp, voice, verify, lookup.
      • directionstringrequired
        One of: out, in.
      • tostringrequired
      • fromstringrequired
      • statestringrequired
        One of: queued, accepted, sent, deferred, delivered, read, undelivered, failed, bounced, complained, suppressed, received, expired, canceled.
      • providerstringrequired
      • atstringrequired
      • codestring or nullrequired
      • detailstring or nullrequired
      • appliedbooleanrequired
      • skippedstring or nullrequired
    • nextnumberrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown