Rivier/ Reference/ voice

Voice phone status get

get/phone/status

Whether the phone account is live, in test mode or a mock, and the addresses the carrier calls back on.

Before you call

Credential
Authorization: Bearer $KEY
Scope
voice:read
Graphql
Query.voicePhoneStatusGet
Sdk
voice.phoneStatus.get
Cli
voice phone status get

Responses

  • 200application/json
    Success
    • modestringrequired
      One of: live, test, mock.
    • hooksobjectrequired
      • inboundstringrequired
      • statusstringrequired
    • notestringrequired
    • whatsappobjectrequired
      • connectedbooleanrequired
      • reasonstring or nullrequired
      • messagestring or nullrequired
      • senderslist of objectrequired
        • idstringrequired
        • kindstringrequired
          One of: number, alphanumeric, whatsapp.
        • valuestringrequired
        • countrieslist of stringrequired
        • statusstringrequired
          One of: active, pending, rejected, needs_owner.
        • notestringrequired
        • oneWaybooleanrequired
        • numberIdstring or nullrequired
        • createdAtstringrequired
  • 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