GET /available_phone_numbers

telnyx.com

Summary: List available phone numbers
Operation ID: listAvailablePhoneNumbers
Auth: unknown

Parameters (15)

filter[administrative_area] (string, query, optional)

Filter phone numbers by US state/CA province.

filter[best_effort] (boolean, query, optional)

Filter to determine if best effort results should be included.

filter[country_code] (string, query, optional)

Filter phone numbers by ISO alpha-2 country code.

filter[exclude_held_numbers] (boolean, query, optional)

Filter to exclude phone numbers that are currently on hold for your account.

filter[features] (array, query, optional)

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

filter[limit] (integer, query, optional)

Limits the number of results.

filter[locality] (string, query, optional)

Filter phone numbers by city.

filter[national_destination_code] (string, query, optional)

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

filter[number_type] (string, query, optional)

Filter phone numbers by number type.

Constraints: {'enum': ['toll-free', 'national', 'mobile', 'local']}

filter[phone_number][contains] (string, query, optional)

Filter numbers containing a pattern.

filter[phone_number][ends_with] (string, query, optional)

Filter numbers ending with a pattern.

filter[phone_number][starts_with] (string, query, optional)

Filter numbers starting with a pattern (meant to be used after `national_destination_code` filter has been set).

filter[quickship] (boolean, query, optional)

Filter to exclude phone numbers that need additional time after to purchase to receive phone calls.

filter[rate_center] (string, query, optional)

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

filter[reservable] (boolean, query, optional)

Filter to exclude phone numbers that cannot be reserved before purchase.

No probe data for this endpoint yet.