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

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

organizationIdstringrequired

Query parameters

limitinteger · min: 1 · max: 99 · default: 10optional

Limits the number of results to return

pageTokenstring · max: 8000optional

Pagination token that keeps of track of the current position in the list

countryCodesstring · iso3166-1[]optional

typesstring · enum[]optional

featuresstring · enum[]optional

prefixstring · min: 1 · max: 250optional

Used to filter for numbers beginning with the prefix.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organizations/{organizationId}/numbers-stock-items' \
  --header 'Authorization: Bearer JWT'

200

422

200

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

OK