Numbers

List ordering options

GET
/v1/numbers/options

The countries, products and durations this account can order.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Response Body

Success

application/json
  1. response

Success

countries*array<>
products*

The durations and largest order each product allows, by product

inboundVoice*boolean

Whether numbers are on offer where incoming calls are transcribed and delivered as messages; nothing can be answered or dialled

curl -X GET "https://example.com/v1/numbers/options"
{  "countries": [    "GB",    "US"  ],  "products": {    "any_service": {      "durations": [        "12h",        "1d",        "7d",        "30d"      ],      "maxQuantity": 10    },    "single_service": {      "durations": [        "7d",        "30d"      ],      "maxQuantity": 1    }  },  "inboundVoice": true}