Rivier/ Reference/ inbox

Inbox message error explain

get/messages/errors/{code}

The plain cause and fix for one code (a mail status such as 5.1.1 or a phone-network code).

Before you call

Credential
Authorization: Bearer $KEY
Scope
inbox:read
Graphql
Query.inboxMessageErrorExplain
Sdk
inbox.messageError.explain
Cli
inbox message error explain

Parameters

  • codestringrequired
    In the path
  • channelstring
    In the query

Responses

  • 200application/json
    Success
    • codestringrequired
    • channelslist of stringrequired
    • causestringrequired
    • fixstringrequired
    • retryablebooleanrequired
  • 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