Rivier/ Reference/ voice

Requests to buy a number and how each ended

get/phone/purchases

Before you call

Credential
Authorization: Bearer $KEY
Scope
voice:read
Graphql
Query.voicePhonePurchaseList
Sdk
voice.phonePurchase.list
Cli
voice phone purchase list

Responses

  • 200application/json
    Success
    • purchaseslist of objectrequired
      • idstringrequired
      • numberstringrequired
      • countrystringrequired
      • typestringrequired
      • labelstringrequired
      • quoteMicrosnumber or nullrequired
      • currencystringrequired
      • requirementslist of objectrequired
        • kindstringrequired
        • titlestringrequired
        • blocksPurchasebooleanrequired
      • statestringrequired
        One of: pending, confirmed, bought, declined, expired, failed.
      • requestedBystringrequired
      • decidedBystring or nullrequired
      • numberIdstring or nullrequired
      • notestringrequired
      • createdAtstringrequired
      • expiresAtstringrequired
  • 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