Skip to main content

List available phone number blocks

GET 

/available_phone_number_blocks

List available phone number blocks

Request

Query Parameters

    filter[phone_number][starts_with] string

    Filter number blocks that start with a pattern (meant to be used after national_destination_code filter has been set).

    filter[phone_number][ends_with] string

    Filter numbers ending with a pattern.

    filter[phone_number][contains] string

    Filter numbers containing a pattern.

    filter[locality] string

    Filter phone numbers by city.

    Examples:

    Example: Chicago

    filter[administrative_area] string

    Filter phone numbers by US state/CA province.

    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:

    Example: 312

    filter[rate_center] string

    Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers.

    filter[number_type] string

    Possible values: [toll-free]

    Filter phone numbers by number type.

    filter[features] string[]

    Possible values: [sms, mms, voice, fax, emergency]

    Filter if the phone number should be used for voice, fax, mms, sms, emergency.

    filter[minimum_block_size] integer

    Filter number blocks by minimum blocks size

    filter[limit] integer

    Limits the number of results.

Responses

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

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

default: Unexpected error

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.

  • ]

Loading...