Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const availablePhoneNumbers = await client.availablePhoneNumbers.list(); console.log(availablePhoneNumbers.data);

{ "data": [ { "record_type": "available_phone_number", "phone_number": "+19705555098", "vanity_format": "", "best_effort": false, "quickship": true, "reservable": true, "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 } }

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const availablePhoneNumbers = await client.availablePhoneNumbers.list(); console.log(availablePhoneNumbers.data);

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[locality], filter[administrative_area], filter[country_code], filter[national_destination_code], filter[rate_center], filter[phone_number_type], filter[features], filter[limit], filter[best_effort], filter[quickship], filter[reservable], filter[exclude_held_numbers]

Show child attributes

filter[phone_number]

object

Filter phone numbers by pattern matching.

Show child attributes

filter[phone_number][starts_with]

string

Filter numbers starting with a pattern (excludes NDC if used with national_destination_code filter).

filter[phone_number][ends_with]

string

Filter numbers ending with a pattern (excludes NDC if used with national_destination_code filter).

filter[phone_number][contains]

string

Filter numbers containing a pattern (excludes NDC if used with national_destination_code filter).

filter[locality]

string

Filter phone numbers by city.

filter[administrative_area]

string

Find numbers in a particular US state or CA province.

filter[country_code]

string

Filter phone numbers by country.

filter[national_destination_code]

string

Filter by the national destination code of the number.

filter[rate_center]

string

Filter phone numbers by rate center. This filter is only applicable to USA and Canada numbers.

filter[phone_number_type]

enum<string>

Filter phone numbers by number type.

Available options:

local,

toll_free,

mobile,

national,

shared_cost

filter[features]

enum<string>[]

Filter phone numbers with specific features.

Available options:

sms,

mms,

voice,

fax,

emergency,

hd_voice,

international_sms,

local_calling

filter[limit]

integer

Limits the number of results.

filter[best_effort]

boolean

Filter to determine if best effort results should be included. Only available in USA/CANADA.

filter[quickship]

boolean

Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.

filter[reservable]

boolean

Filter to ensure only numbers that can be reserved are included in the results.

filter[exclude_held_numbers]

boolean

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

Response

Successful response with a list of available phone numbers.

data

object[]

Show child attributes

data.record_type

enum<string>

Available options:

available_phone_number

Example:

"available_phone_number"

data.phone_number

string

Example:

"+19705555098"

data.vanity_format

string

data.best_effort

boolean

Specifies whether the phone number is an exact match based on the search criteria or not.

Example:

false

data.quickship

boolean

Specifies whether the phone number can receive calls immediately after purchase or not.

Example:

true

data.reservable

boolean

Specifies whether the phone number can be reserved before purchase or not.

Example:

true

data.region_information

object[]

Show child attributes

data.region_information.region_type

enum<string>

Available options:

country_code,

rate_center,

state,

location

Example:

"country_code"

data.region_information.region_name

string

Example:

"US"

data.cost_information

object

Show child attributes

data.cost_information.upfront_cost

string

Example:

"3.21"

data.cost_information.monthly_cost

string

Example:

"6.54"

data.cost_information.currency

string

The ISO 4217 code for the currency.

Example:

"USD"

Example:

{
  "upfront_cost": "3.21",
  "monthly_cost": "6.54",
  "currency": "USD"
}

data.features

object[]

Show child attributes

data.features.name

string

Example:

"sms"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup