Telnyx

Authorizations

Authorization

string

header

required

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

Query Parameters

page

object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

sort

enum<string>

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Available options:

purchased_at,

phone_number,

connection_name,

usage_payment_method

Example:

"connection_name"

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[phone_number], filter[status], filter[country_iso_alpha2], filter[connection_id], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference], filter[number_type], filter[source]

Show child attributes

filter[tag]

string

Filter by phone number tags.

filter[without_tags]

enum<string>

When set to 'true', filters for phone numbers that do not have any tags applied. All other values are ignored.

Available options:

true,

false

filter[phone_number]

string

Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.

filter[status]

enum<string>

Filter by phone number status.

Available options:

purchase-pending,

purchase-failed,

port-pending,

active,

deleted,

port-failed,

emergency-only,

ported-out,

port-out-pending

Example:

"active"

filter[country_iso_alpha2]

Filter by phone number country ISO alpha-2 code. Can be a single value or an array of values.

Example:

"US"

filter[connection_id]

string

Filter by connection_id.

Example:

"1521916448077776306"

filter[voice.connection_name]

object

Filter by voice connection name pattern matching.

Show child attributes

filter[voice.connection_name][contains]

string

Filter contains connection name. Requires at least three characters.

Example:

"test"

filter[voice.connection_name][starts_with]

string

Filter starts with connection name. Requires at least three characters.

Example:

"test"

filter[voice.connection_name][ends_with]

string

Filter ends with connection name. Requires at least three characters.

Example:

"test"

filter[voice.connection_name][eq]

string

Filter by connection name.

Example:

"test"

filter[voice.usage_payment_method]

enum<string>

Filter by usage_payment_method.

Available options:

pay-per-minute,

channel

Example:

"channel"

filter[billing_group_id]

string

Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.

Example:

"62e4bf2e-c278-4282-b524-488d9c9c43b2"

filter[emergency_address_id]

string

Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.

Example:

"9102160989215728032"

filter[customer_reference]

string

Filter numbers via the customer_reference set.

filter[number_type]

object

Filter phone numbers by phone number type.

Show child attributes

filter[number_type][eq]

enum<string>

Filter phone numbers by phone number type.

Available options:

local,

national,

toll_free,

mobile,

shared_cost

filter[source]

enum<string>

Filter phone numbers by their source. Use 'ported' for numbers ported from other carriers, or 'purchased' for numbers bought directly from Telnyx.

Available options:

ported,

purchased

handle_messaging_profile_error

enum<string>

default:false

Although it is an infrequent occurrence, due to the highly distributed nature of the Telnyx platform, it is possible that there will be an issue when loading in Messaging Profile information. As such, when this parameter is set to true and an error in fetching this information occurs, messaging profile related fields will be omitted in the response and an error message will be included instead of returning a 503 error.

Available options:

true,

false

Example:

"false"

Response

Successful response with a list of phone numbers.

data

object[]

required

Show child attributes

data.id

string

required

Identifies the resource.

Example:

"1293384261075731499"

data.record_type

string

required

Identifies the type of the resource.

Example:

"phone_number"

data.phone_number

string

required

The +E.164-formatted phone number associated with this record.

data.country_iso_alpha2

string

required

The ISO 3166-1 alpha-2 country code of the phone number.

Example:

"US"

data.status

enum<string>

required

The phone number's current status.

Available options:

purchase-pending,

purchase-failed,

port-pending,

port-failed,

active,

deleted,

emergency-only,

ported-out,

port-out-pending,

requirement-info-pending,

requirement-info-under-review,

requirement-info-exception,

provision-pending

data.tags

string[]

required

A list of user-assigned tags to help manage the phone number.

data.external_pin

string | null

required

If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.

data.purchased_at

string

required

ISO 8601 formatted date indicating when the resource was purchased.

data.created_at

string<date-time>

required

ISO 8601 formatted date indicating when the resource was created.

data.phone_number_type

enum<string>

required

The phone number's type. Note: For numbers purchased prior to July 2023 or when fetching a number's details immediately after a purchase completes, the legacy values tollfree, shortcode or longcode may be returned instead.

Available options:

local,

toll_free,

mobile,

national,

shared_cost,

landline,

tollfree,

shortcode,

longcode

data.deletion_lock_enabled

boolean

required

Indicates whether deletion lock is enabled for this number. When enabled, this prevents the phone number from being deleted via the API or Telnyx portal.

data.connection_name

string | null

The user-assigned name of the connection to be associated with this phone number.

data.connection_id

string | null

Identifies the connection associated with the phone number.

data.customer_reference

string | null

A customer reference string for customer look ups.

Example:

"MY REF 001"

data.messaging_profile_id

string | null

Identifies the messaging profile associated with the phone number.

data.messaging_profile_name

string | null

The name of the messaging profile associated with the phone number.

Example:

"regional-customers"

data.billing_group_id

string | null

Identifies the billing group associated with the phone number.

data.emergency_enabled

boolean

Indicates whether emergency services are enabled for this number.

data.emergency_address_id

string | null

Identifies the emergency address associated with the phone number.

data.emergency_status

enum<string>

Indicates the status of the provisioning of emergency services for the phone number. This field contains information about activity that may be ongoing for a number where it either is being provisioned or deprovisioned but is not yet enabled/disabled.

Available options:

active,

deprovisioning,

disabled,

provisioning,

provisioning-failed

data.call_forwarding_enabled

boolean

default:true

Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.

data.cnam_listing_enabled

boolean

Indicates whether a CNAM listing is enabled for this number.

data.caller_id_name_enabled

boolean

Indicates whether caller ID is enabled for this number.

data.call_recording_enabled

boolean

Indicates whether call recording is enabled for this number.

data.t38_fax_gateway_enabled

boolean

Indicates whether T38 Fax Gateway for inbound calls to this number.

data.inbound_call_screening

enum<string>

default:disabled

The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it.

Available options:

disabled,

reject_calls,

flag_calls

data.source_type

enum<string> | null

Indicates if the phone number was purchased or ported in. For some numbers this information may not be available.

Available options:

number_order,

port_request

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List phone numbers

Authorizations

Query Parameters

Response