Search Available Numbers

Search available numbers in stock that you can buy to setup an SMS, Voice or WhatsApp channel. You can filter by country, prefix, number type and number capabilities.

You can search available numbers using one of the following attributes:

• countryCode: 2 digit ISO code of the country, example: US for United States, we follow iso3166-1 standard.

• types: types of numbers your are searching for, Check API spec for allowed values.

• features: the capabilities of the number (sms, mms, voice, whatsapp). Check API spec for allowed values.

• prefix: the area code of the number, this have to be the area code only without country code, you need to pass the country code as well as the prefix if you're looking to filter for a specific area code.

List Organization Numbers Stock Items

GET/organizations/{organizationId}/numbers-stock-items

Path parameters

organizationId*string

Query parameters

Response

200422

OK

Body

application/json

results*array of Numbers_NumberStockItem (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/numbers-stock-items', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "countryCode": "text",
      "type": "local",
      "numberString": "text",
      "capabilities": {
        "voice": {
          "inbound": false,
          "outbound": false
        },
        "sms": {
          "inbound": false,
          "outbound": false
        },
        "mms": {
          "inbound": false,
          "outbound": false
        }
      },
      "monthlyPrice": {
        "currencyCode": "EUR",
        "amount": 0,
        "exponent": 0
      }
    }
  ],
  "nextPageToken": "text"
}