Search the message log across email, SMS, WhatsApp and voice

Before you call

Credential

Authorization: Bearer $KEY

Scope

inbox:read

Graphql

Query.inboxMessageList

Sdk

inbox.message.list

Cli

inbox message list

Parameters

• qstring
  In the query
• channelstring
  In the query
• statestring
  In the query
• codestring
  In the query
• directionstring
  In the query
• sincestring
  In the query
• untilstring
  In the query
• failedstring
  In the query
• limitinteger
  In the query
• cursorstring
  In the query

Responses

• 200application/json
  Success
  • messageslist of objectrequired
    • 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
  • nextstring 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