List available phone number blocks

GET 
/available_phone_number_blocks

List available phone number blocks

Request

Query Parameters

filter[locality] string

Filter phone numbers by city.

Examples:

• US
• CA
• AU

Example: Chicago

Example: Toronto

Example: Canberra

filter[country_code] string

Filter phone numbers by ISO alpha-2 country code.

filter[national_destination_code] string

Filter by the national destination code of the number. This filter is only applicable to North American numbers.

Examples:

• US
• CA
• AU

Example: 312

Example: 437

Example: 0251

filter[number_type] string

Possible values: [toll-free]

Filter phone numbers by number type.

Responses

200: Successful response with a list of available phone numbers blocks.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

Possible values: [available_phone_number_block]

starting_number string

range integer

region_information

RegionInformation[]

Array [

region_type string

Possible values: [country_code, rate_center, state, location]

region_name string

]

cost_information

object

upfront_cost string

monthly_cost string

currency string

The ISO 4217 code for the currency.

features

Feature[]

Array [

name string

]

]

meta

object

total_results integer

best_effort_results integer

{
  "data": [
    {
      "record_type": "available_phone_number_block",
      "phone_number": "+19705555000",
      "range": 10,
      "region_information": [
        {
          "region_type": "country_code",
          "region_name": "US"
        }
      ],
      "cost_information": {
        "upfront_cost": "3.21",
        "monthly_cost": "6.54",
        "currency": "USD"
      },
      "features": [
        {
          "name": "sms"
        },
        {
          "name": "voice"
        }
      ]
    }
  ],
  "meta": {
    "total_results": 100,
    "best_effort_results": 50
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

URL with additional information on the error.

]

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Loading...