Praecise Platform
Menu

Rivier/ Reference/ inbox

Inbox message get

get/messages/{id}

One message with its timeline of provider events, the plain cause of any error and what to do about it. The body of the message is never part of the log.

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:read
Graphql
Query.inboxMessageGet
Sdk
inbox.message.get
Cli
inbox message get

Parameters

  • idstring (uuid)required
    In the path

Responses

  • 200application/json
    Success
    • messageobjectrequired
      • idstring (uuid)required
      • channelstringrequired
        One of: email, sms, mms, whatsapp, voice, verify, lookup.
      • directionstringrequired
        One of: out, in.
      • providerstringrequired
      • providerIdstring or nullrequired
      • tostringrequired
      • fromstringrequired
      • statestringrequired
        One of: queued, accepted, sent, deferred, delivered, read, undelivered, failed, bounced, complained, suppressed, received, expired, canceled.
      • codestring or nullrequired
      • detailstring or nullrequired
      • unitsnumberrequired
      • createdAtstringrequired
      • updatedAtstringrequired
      • stateAtstringrequired
    • explanationobject or nullrequired
    • timelinelist of objectrequired
      • seqnumberrequired
      • 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
      • dataobjectrequired
      • explanationobject or nullrequired
  • 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