Telnyx

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[has_bundle], filter[tag], filter[connection_id], filter[phone_number], filter[status], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference]

Show child attributes

filter[has_bundle]

string

Filter by phone number that have bundles.

filter[tag]

string

Filter by phone number tags.

filter[connection_id]

string

Filter by connection_id.

Example:

"1521916448077776306"

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[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.

Body

application/json

phone_numbers

string[]

required

Array of phone number ids and/or phone numbers in E164 format to update. This parameter is required if no filter parameters are provided. If you want to update specific numbers rather than all numbers matching a filter, you must use this parameter. Each item must be either a valid phone number ID or a phone number in E164 format (e.g., '+13127367254').

tags

string[]

A list of user-assigned tags to help organize phone numbers.

external_pin

string

If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we 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.

customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

connection_id

string

Identifies the connection associated with the phone number.

billing_group_id

string

Identifies the billing group associated with the phone number.

hd_voice_enabled

boolean

Indicates whether to enable or disable HD Voice on each phone number. HD Voice is a paid feature and may not be available for all phone numbers, more details about it can be found in the Telnyx support documentation.

deletion_lock_enabled

boolean

Indicates whether to enable or disable the deletion lock on each phone number. When enabled, this prevents the phone number from being deleted via the API or Telnyx portal.

voice

object

Show child attributes

voice.tech_prefix_enabled

boolean

default:false

Controls whether a tech prefix is enabled for this phone number.

voice.translated_number

string

This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed.

voice.caller_id_name_enabled

boolean

default:false

Controls whether the caller ID name is enabled for this phone number.

voice.call_forwarding

object

The call forwarding settings for a phone number.

Show child attributes

voice.call_forwarding.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.

Example:

true

voice.call_forwarding.forwards_to

string

The phone number to which inbound calls to this number are forwarded. Inbound calls will not be forwarded if this field is left blank. If set, must be a +E.164-formatted phone number.

voice.call_forwarding.forwarding_type

enum<string>

Call forwarding type. 'forwards_to' must be set for this to have an effect.

Available options:

always,

on-failure

Example:

"always"

Example:

{
  "call_forwarding_enabled": true,
  "forwards_to": "+13035559123",
  "forwarding_type": "always"
}

voice.cnam_listing

object

The CNAM listing settings for a phone number.

Show child attributes

voice.cnam_listing.cnam_listing_enabled

boolean

default:false

Enables CNAM listings for this number. Requires cnam_listing_details to also be set.

voice.cnam_listing.cnam_listing_details

string

The CNAM listing details for this number. Must be alphanumeric characters or spaces with a maximum length of 15. Requires cnam_listing_enabled to also be set to true.

Example:

{
  "cnam_listing_enabled": true,
  "cnam_listing_details": "example"
}

voice.usage_payment_method

enum<string>

default:pay-per-minute

Controls whether a number is billed per minute or uses your concurrent channels.

Available options:

pay-per-minute,

channel

voice.media_features

object

The media features settings for a phone number.

Show child attributes

voice.media_features.rtp_auto_adjust_enabled

boolean

default:true

When RTP Auto-Adjust is enabled, the destination RTP address port will be automatically changed to match the source of the incoming RTP packets.

voice.media_features.accept_any_rtp_packets_enabled

boolean

default:false

When enabled, Telnyx will accept RTP packets from any customer-side IP address and port, not just those to which Telnyx is sending RTP.

voice.media_features.t38_fax_gateway_enabled

boolean

default:false

Controls whether Telnyx will accept a T.38 re-INVITE for this phone number. Note that Telnyx will not send a T.38 re-INVITE; this option only controls whether one will be accepted.

Example:

{
  "rtp_auto_adjust_enabled": true,
  "accept_any_rtp_packets_enabled": true,
  "t38_fax_gateway_enabled": true
}

voice.call_recording

object

The call recording settings for a phone number.

Show child attributes

voice.call_recording.inbound_call_recording_enabled

boolean

default:false

When enabled, any inbound call to this number will be recorded.

voice.call_recording.inbound_call_recording_format

enum<string>

default:wav

The audio file format for calls being recorded.

Available options:

wav,

mp3

voice.call_recording.inbound_call_recording_channels

enum<string>

default:single

When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.

Available options:

single,

dual

Example:

{
  "inbound_call_recording_enabled": true,
  "inbound_call_recording_format": "wav",
  "inbound_call_recording_channels": "single"
}

voice.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

Example:

{
  "tech_prefix_enabled": true,
  "translated_number": "+13035559999",
  "caller_id_name_enabled": true,
  "call_forwarding": {
    "call_forwarding_enabled": true,
    "forwards_to": "+13035559123",
    "forwarding_type": "always"
  },
  "cnam_listing": {
    "cnam_listing_enabled": true,
    "cnam_listing_details": "example"
  },
  "usage_payment_method": "pay-per-minute",
  "media_features": {
    "rtp_auto_adjust_enabled": true,
    "accept_any_rtp_packets_enabled": true,
    "t38_fax_gateway_enabled": true
  },
  "call_recording": {
    "inbound_call_recording_enabled": true,
    "inbound_call_recording_format": "wav",
    "inbound_call_recording_channels": "single"
  },
  "inbound_call_screening": "disabled"
}

Response

Phone numbers job update phone numbers requested.

data

object

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

"42587e44-3a3e-46de-9255-0c9a7a1d1ec7"

data.record_type

string

Identifies the type of the resource.

Example:

"phone_numbers_job"

data.status

enum<string>

default:pending

Indicates the completion status of the background update.

Available options:

pending,

in_progress,

completed,

failed,

expired

Example:

"pending"

data.type

enum<string>

Identifies the type of the background job.

Available options:

update_emergency_settings,

delete_phone_numbers,

update_phone_numbers

Example:

"update_emergency_settings"

data.etc

string<date-time>

ISO 8601 formatted date indicating when the estimated time of completion of the background job.

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

data.phone_numbers

object[]

Show child attributes

data.phone_numbers.phone_number

string

The phone number in e164 format.

Example:

"+19705555000"

data.phone_numbers.id

string

The phone number's ID

data.successful_operations

object[]

Show child attributes

data.successful_operations.phone_number

string

The phone number in e164 format.

data.successful_operations.id

string

The phone number's ID

data.pending_operations

object[]

Show child attributes

data.pending_operations.phone_number

string

The phone number in e164 format.

data.pending_operations.id

string

The phone number's ID

data.failed_operations

object[]

Show child attributes

data.failed_operations.phone_number

string

The phone number in e164 format.

data.failed_operations.id

string

The phone number's ID

data.failed_operations.errors

object[]

Show child attributes

data.failed_operations.errors.code

string

Example:

"10007"

data.failed_operations.errors.title

string

Example:

"Unexpected error"

data.failed_operations.errors.detail

string

Example:

"An unexpected error occured."

data.failed_operations.errors.source

object

Show child attributes

data.failed_operations.errors.source.pointer

string

JSON pointer (RFC6901) to the offending entity.

Example:

"/base"

data.failed_operations.errors.source.parameter

string

Indicates which query parameter caused the error.

data.failed_operations.errors.meta

object

Show child attributes

data.failed_operations.errors.meta.url

string

URL with additional information on the error.

Example:

"https://developers.telnyx.com/docs/overview/errors/10015"

Example:

{
  "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
  "record_type": "phone_numbers_job",
  "status": "pending",
  "type": "update_emergency_settings",
  "etc": "2020-10-30T18:10:00.000Z",
  "created_at": "2020-10-23T18:10:00.000Z",
  "updated_at": "2020-10-23T18:10:01.000Z",
  "phone_numbers": [
    { "id": "2637816387126861836" },
    { "phone_number": "+19715555098" },
    { "phone_number": "+19705555099" },
    { "id": "3388768018273" }
  ],
  "successful_operations": [
    {
      "id": "2637816387126861836",
      "phone_number": "+19705555098"
    },
    {
      "id": "33081887126861836",
      "phone_number": "+19715555098"
    }
  ],
  "pending_operations": [
    {
      "id": "2637816387126861837",
      "phone_number": "+19705555099"
    }
  ],
  "failed_operations": [
    {
      "id": "3388768018273",
      "phone_number": "+19705551234",
      "errors": [
        {
          "code": "10015",
          "title": "Bad Request",
          "detail": "The field is invalid.",
          "source": { "pointer": "/emergency_address_id" }
        }
      ]
    }
  ]
}

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Update a batch of numbers

Authorizations

Query Parameters

Body

Response