Telnyx

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Identifies the resource.

Example:

"1293384261075731499"

Body

application/json

Updated voice settings for the phone number.

tech_prefix_enabled

boolean

default:false

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

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.

caller_id_name_enabled

boolean

default:false

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

call_forwarding

object

The call forwarding settings for a phone number.

Show child attributes

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

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.

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"
}

cnam_listing

object

The CNAM listing settings for a phone number.

Show child attributes

cnam_listing.cnam_listing_enabled

boolean

default:false

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

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"
}

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

media_features

object

The media features settings for a phone number.

Show child attributes

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.

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.

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
}

call_recording

object

The call recording settings for a phone number.

Show child attributes

call_recording.inbound_call_recording_enabled

boolean

default:false

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

call_recording.inbound_call_recording_format

enum<string>

default:wav

The audio file format for calls being recorded.

Available options:

wav,

mp3

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"
}

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

Response

Successful response with details about a phone number including voice settings.

data

object

Show child attributes

data.id

string

Identifies the type of resource.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"voice_settings"

data.phone_number

string

The phone number in +E164 format.

Example:

"+13035551234"

data.connection_id

string

Identifies the connection associated with this phone number.

Example:

"1d0e6cb8-8668-462e-94c6-49ae0f0ed48b"

data.customer_reference

string

A customer reference string for customer look ups.

Example:

"MY REF 001"

data.tech_prefix_enabled

boolean

default:false

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

Example:

false

data.translated_number

string

default:""

Example:

"+13035559999"

data.call_forwarding

object

The call forwarding settings for a phone number.

Show child attributes

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

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

data.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"
}

data.cnam_listing

object

The CNAM listing settings for a phone number.

Show child attributes

data.cnam_listing.cnam_listing_enabled

boolean

default:false

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

data.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"
}

data.emergency

object

The emergency services settings for a phone number.

Show child attributes

data.emergency.emergency_enabled

boolean

default:false

Allows you to enable or disable emergency services on the phone number. In order to enable emergency services, you must also set an emergency_address_id.

data.emergency.emergency_address_id

string

Identifies the address to be used with emergency services.

data.emergency.emergency_status

enum<string>

default:disabled

Represents the state of the number regarding emergency activation.

Available options:

disabled,

active,

provisioning,

deprovisioning,

provisioning-failed

Example:

{
  "emergency_enabled": true,
  "emergency_address_id": "1315261609962112019",
  "emergency_status": "active"
}

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

Example:

"pay-per-minute"

data.media_features

object

The media features settings for a phone number.

Show child attributes

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

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

data.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
}

data.call_recording

object

The call recording settings for a phone number.

Show child attributes

data.call_recording.inbound_call_recording_enabled

boolean

default:false

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

data.call_recording.inbound_call_recording_format

enum<string>

default:wav

The audio file format for calls being recorded.

Available options:

wav,

mp3

data.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"
}

data.inbound_call_screening

enum<string>

default:disabled

Available options:

disabled,

reject_calls,

flag_calls

Example:

{
  "id": "1293384261075731499",
  "record_type": "voice_settings",
  "connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b",
  "customer_reference": "customer-reference",
  "tech_prefix_enabled": false,
  "translated_number": "+13035559999",
  "call_forwarding": {
    "call_forwarding_enabled": true,
    "forwards_to": "+13035559123",
    "forwarding_type": "always"
  },
  "cnam_listing": {
    "cnam_listing_enabled": true,
    "cnam_listing_details": "example"
  },
  "emergency": {
    "emergency_enabled": true,
    "emergency_address_id": "1315261609962112019",
    "emergency_status": "active"
  },
  "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"
}

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

Update a phone number with voice settings

Authorizations

Path Parameters

Body

Response