Phone Numbers V1

Number operations

List all numbers

Returns a list of your numbers. Append .csv to the request URL to retrieve results in CSV format.

Request
query Parameters
filter_tag
string

Optional filtering parameter. If present, only numbers that have been tagged 　with the string given will be returned. Returns exact matches only.

filter_number_val
string

Optional filtering parameter. If present, only numbers that at least partially match the value given in their number will be returned. Requires at least three digits. Non-numerical characters should not be present in the filter and will result in no values being returned.

filter_status
integer

Optional filtering parameter. If present, only numbers that have the same status as specified will be returned.

Enum: 1 2 3 4 5
filter_emergency_status
string

Optional filtering parameter. If present, only numbers that have the same emergency_status as specified will be returned.

Enum: "disabled" "active" "provisioning" "deprovisioning"
filter_connection_name
string

Optional filtering parameter. If present, only numbers that have a connection that at least partially matches the string given will be returned. Matching is not case-sensitive. Requires at least three characters. Numbers without a connection will not be returned.

filter_usage_payment_method
string

Optional filtering parameter. If present, only numbers that have the usage_payment_method that at matches the string given will be returned. Matching is case-sensitive and only specified values are allowed.

Enum: "pay-per-minute" "channel"
filter_billing_group_id
string

Optional filtering parameter. If present, only numbers with a billing_group_id matching the string given will be returned. To search for only numbers that do not have a billing_group_id, specify the literal value "null".

order_by
string

Specify an ordering for the results. Optional parameter. If present, must be of a set number of values: "order_date", "phone_number", "connection", or "usage_payment_method". Other values are invalid and will result in the call failing. "order_date" will order numbers with the most recent purchases first, then older ones at the end. "phone_number" will sort by the phone number values. "connection" will order by the connection name with numbers not having a connection assigned yet at the end. "usage_payment_method" will put numbers with "pay-per-minute" first.

Enum: "order_date" "phone_number" "connection" "usage_payment_method"
sort_direction
string

The sort_direction specifies in which way the ordering of the connections is applied. If not present, ordering will be performed as described under the order_by parameter. You may invert this ordering by specifying "reverse" as the sort_direction. This parameter is optional.

Value: "reverse"
page
integer
Default: 1

Page number of results to load

per_page
integer <= 1000
Default: 100

Number of results per page

Responses
200

Number response

Response Schema: application/json
Array
id
required
string
connection_id
required
string
number_val_e164
required
string
primary_ip
required
string
secondary_ip
required
string
tertiary_ip
required
string
primary_port
required
integer
Default: 5060

port for the primary ip, defaults to 5060

secondary_port
required
integer
Default: 5060

port for the secondary ip, defaults to 5060

tertiary_port
required
integer
Default: 5060

port for the tertiary ip, defaults to 5060

primary_fqdn
required
string

the primary domain name for the number. Only relevant for numbers using a connection of FQDN-based authentication.

secondary_fqdn
required
string

the primary domain name for the number. Only relevant for numbers using a connection of FQDN-based authentication.

tertiary_fqdn
required
string

the primary domain name for the number. Only relevant for numbers using a connection of FQDN-based authentication.

primary_fqdn_port
required
integer

port for the primary FQDN

secondary_fqdn_port
required
integer

port for the secondary FQDN

tertiary_fqdn_port
required
integer

port for the tertiary FQDN

primary_fqdn_dns_record_type
required
string

the DNS record type for the primary FQDN for the number. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'.

Enum: "a" "srv"
secondary_fqdn_dns_record_type
required
string

the DNS record type for the secondary FQDN for the number. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'.

Enum: "a" "srv"
tertiary_fqdn_dns_record_type
required
string

the DNS record type for the tertiary FQDN for the number. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'.

Enum: "a" "srv"
ignore_tech_prefix
required
boolean
Default: true

DEPRECATED - Use enable_tech_prefix on API requests

enable_tech_prefix
required
boolean
Default: false
translated_number
required
string
forwards_to
required
string

the number that this number should be forwarded to; when this is set, forwarding_type must also be set

forwarding_type
required
string

sets when this number should have its calls forwarded; valid values are 'always' and 'on-failure'

tag_list
required
Array of strings
status
required
integer
Default: 1

Purchase Pending = 1, Purchase Failed = 2, Port Pending = 3, Active = 4, Deleted = 5, Port Failed = 6, Emergency Only = 7, Ported Out = 8, Port Out Pending = 9

purchase_failure_reason
required
string

reason(s) why the last attempt to purchase this number failed

e911_enabled
boolean
Default: false
e911_address_id
string
emergency_status
string
Default: "disabled"
Enum: "disabled" "active" "provisioning" "deprovisioning"
address_id
string

use this property to reference an Address record if required for a number record

usage_payment_method
required
string
Default: "pay-per-minute"

setting for whether a number is billed per minute or uses your concurrent channels

Enum: "pay-per-minute" "channel"
enable_rtp_auto_adjust
required
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_handling_mode
required
string
Default: "default"

default: media routed through Telnyx with transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media routed directly between origination and termination endpoints. Only Telnyx support may set a number to bypass mode.

Enum: "default" "proxy" "bypass"
cnam_listing_enabled
required
boolean
Default: false

Enable CNAM listings for this number. Requires cnam_listing_details to also be filled in.

cnam_listing_details
required
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.

external_pin
string

External PINs are used to ensure that phone numbers on your account cannot be ported to another carrier without your consent. This has an account level default but may also be specified per phone number. External PINs must be 4 numeric digits ('3456').

t38_fax_gateway_enabled
boolean
Default: false
accept_any_rtp_packets_enabled
boolean
Default: false
number_val
required
string

DEPRECATION WARNING! Please use number_val_e164 or contact support@telnyx.com if you depend on this key.

inbound_call_recording_enabled
required
boolean
Default: false

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

inbound_call_recording_format
required
string
Default: "wav"

The audio file format for calls being recorded.

Enum: "wav" "mp3"
inbound_call_recording_channels
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.

Enum: "single" "dual"
billing_group_id
string

The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).

401

Unauthorized

422

Unprocessable entity. Can be caused by invalid values for ordering or filtering. Check message field in response for details.

get/origination/numbers
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "connection_id": "string",
    • "number_val_e164": "string",
    • "primary_ip": "string",
    • "secondary_ip": "string",
    • "tertiary_ip": "string",
    • "primary_port": 5060,
    • "secondary_port": 5060,
    • "tertiary_port": 5060,
    • "primary_fqdn": "string",
    • "secondary_fqdn": "string",
    • "tertiary_fqdn": "string",
    • "primary_fqdn_port": 0,
    • "secondary_fqdn_port": 0,
    • "tertiary_fqdn_port": 0,
    • "primary_fqdn_dns_record_type": "a",
    • "secondary_fqdn_dns_record_type": "a",
    • "tertiary_fqdn_dns_record_type": "a",
    • "ignore_tech_prefix": true,
    • "enable_tech_prefix": false,
    • "translated_number": "string",
    • "forwards_to": "string",
    • "forwarding_type": "string",
    • "tag_list": [
      • "string"
      ],
    • "status": 1,
    • "purchase_failure_reason": "string",
    • "e911_enabled": false,
    • "e911_address_id": "string",
    • "emergency_status": "disabled",
    • "address_id": "string",
    • "usage_payment_method": "pay-per-minute",
    • "enable_rtp_auto_adjust": true,
    • "media_handling_mode": "default",
    • "cnam_listing_enabled": false,
    • "cnam_listing_details": "string",
    • "external_pin": "string",
    • "t38_fax_gateway_enabled": false,
    • "accept_any_rtp_packets_enabled": false,
    • "number_val": "string",
    • "inbound_call_recording_enabled": false,
    • "inbound_call_recording_format": "wav",
    • "inbound_call_recording_channels": "single",
    • "billing_group_id": "string"
    }
]
Retrieve a number
Retrieve the details of a number. The ID in the path can either be the telephone number (e.g. +12124567890) or object ID.


Request 
path Parameters
id
required
string
Telephone number (ex: +12124567890) or object ID of number to update


 
Responses 
200
Number updated


Response Schema: application/json
id
required
string
 
connection_id
required
string
 
number_val_e164
required
string
 
primary_ip
required
string
 
secondary_ip
required
string
 
tertiary_ip
required
string
 
primary_port
required
integer
 Default:  5060
port for the primary ip, defaults to 5060


 
secondary_port
required
integer
 Default:  5060
port for the secondary ip, defaults to 5060


 
tertiary_port
required
integer
 Default:  5060
port for the tertiary ip, defaults to 5060


 
primary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
secondary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
tertiary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
primary_fqdn_port
required
integer
port for the primary FQDN


 
secondary_fqdn_port
required
integer
port for the secondary FQDN


 
tertiary_fqdn_port
required
integer
port for the tertiary FQDN


 
primary_fqdn_dns_record_type
required
string
the DNS record type for the primary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
secondary_fqdn_dns_record_type
required
string
the DNS record type for the secondary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
tertiary_fqdn_dns_record_type
required
string
the DNS record type for the tertiary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
ignore_tech_prefix
required
boolean
 Default:  true
DEPRECATED - Use enable_tech_prefix on API requests


 
enable_tech_prefix
required
boolean
 Default:  false
 
translated_number
required
string
 
forwards_to
required
string
the number that this number should be forwarded to; when this is set,
            forwarding_type must also be set


 
forwarding_type
required
string
sets when this number should have its calls forwarded;
            valid values are 'always' and 'on-failure'


 
tag_list
required
Array of strings
 
status
required
integer
 Default:  1
Purchase Pending = 1, Purchase Failed = 2, Port Pending = 3, Active = 4, Deleted = 5, Port Failed = 6, Emergency Only = 7, Ported Out = 8, Port Out Pending = 9


 
purchase_failure_reason
required
string
reason(s) why the last attempt to purchase this number failed


 
e911_enabled
boolean
 Default:  false
 
e911_address_id
string
 
emergency_status
string
 Default:  "disabled"
 Enum: "disabled" "active" "provisioning" "deprovisioning"  
address_id
string
use this property to reference an Address record if required for a number record


 
usage_payment_method
required
string
 Default:  "pay-per-minute"
setting for whether a number is billed per minute or uses your concurrent channels


 Enum: "pay-per-minute" "channel"  
enable_rtp_auto_adjust
required
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_handling_mode
required
string
 Default:  "default"
default: media routed through Telnyx with
            transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media
            routed directly between origination and termination endpoints. Only Telnyx support may set a
            number to bypass mode.


 Enum: "default" "proxy" "bypass"  
cnam_listing_enabled
required
boolean
 Default:  false
Enable CNAM listings for this number. Requires cnam_listing_details to also
            be filled in.


 
cnam_listing_details
required
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.


 
external_pin
string
External PINs are used to ensure that phone numbers on your account cannot
          be ported to another carrier without your consent. This has an account level default but may
          also be specified per phone number. External PINs must be 4 numeric digits ('3456').


 
t38_fax_gateway_enabled
boolean
 Default:  false
 
accept_any_rtp_packets_enabled
boolean
 Default:  false
 
number_val
required
string
DEPRECATION WARNING! Please use number_val_e164 or contact support@telnyx.com if you depend on this key.


 
inbound_call_recording_enabled
required
boolean
 Default:  false
When enabled, any inbound call to this number will be recorded.


 
inbound_call_recording_format
required
string
 Default:  "wav"
The audio file format for calls being recorded.


 Enum: "wav" "mp3"  
inbound_call_recording_channels
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.


 Enum: "single" "dual"  
billing_group_id
string
The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).


 
400
Bad request


401
Unauthorized


404
Resource not found


get/origination/numbers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "connection_id": "string",
  • "number_val_e164": "string",
  • "primary_ip": "string",
  • "secondary_ip": "string",
  • "tertiary_ip": "string",
  • "primary_port": 5060,
  • "secondary_port": 5060,
  • "tertiary_port": 5060,
  • "primary_fqdn": "string",
  • "secondary_fqdn": "string",
  • "tertiary_fqdn": "string",
  • "primary_fqdn_port": 0,
  • "secondary_fqdn_port": 0,
  • "tertiary_fqdn_port": 0,
  • "primary_fqdn_dns_record_type": "a",
  • "secondary_fqdn_dns_record_type": "a",
  • "tertiary_fqdn_dns_record_type": "a",
  • "ignore_tech_prefix": true,
  • "enable_tech_prefix": false,
  • "translated_number": "string",
  • "forwards_to": "string",
  • "forwarding_type": "string",
  • "tag_list": [
    • "string"
    ],
  • "status": 1,
  • "purchase_failure_reason": "string",
  • "e911_enabled": false,
  • "e911_address_id": "string",
  • "emergency_status": "disabled",
  • "address_id": "string",
  • "usage_payment_method": "pay-per-minute",
  • "enable_rtp_auto_adjust": true,
  • "media_handling_mode": "default",
  • "cnam_listing_enabled": false,
  • "cnam_listing_details": "string",
  • "external_pin": "string",
  • "t38_fax_gateway_enabled": false,
  • "accept_any_rtp_packets_enabled": false,
  • "number_val": "string",
  • "inbound_call_recording_enabled": false,
  • "inbound_call_recording_format": "wav",
  • "inbound_call_recording_channels": "single",
  • "billing_group_id": "string"
}
Update a number
Updates the specified number with the values of the parameters passed. Any parameters not included in the request will be left unchanged. The ID in the path can either be the telephone number (e.g. +12124567890) or object ID.


Request 
path Parameters
id
required
string
Telephone number (ex: +12124567890) or object ID of number to update


 
Request Body schema: application/json
required
Updated number object


connection_id
string
 
primary_ip
string
 
secondary_ip
string
 
tertiary_ip
string
 
primary_port
integer
 Default:  5060
port for the primary ip, defaults to 5060


 
secondary_port
integer
 Default:  5060
port for the secondary ip, defaults to 5060


 
tertiary_port
integer
 Default:  5060
port for the tertiary ip, defaults to 5060


 
primary_fqdn
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
secondary_fqdn
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
tertiary_fqdn
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
primary_fqdn_port
integer
port for the primary FQDN


 
secondary_fqdn_port
integer
port for the secondary FQDN


 
tertiary_fqdn_port
integer
port for the tertiary FQDN


 
primary_fqdn_dns_record_type
string
the DNS record type for the primary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
secondary_fqdn_dns_record_type
string
the DNS record type for the secondary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
tertiary_fqdn_dns_record_type
string
the DNS record type for the tertiary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
enable_tech_prefix
boolean
 Default:  false
 
translated_number
string
 
forwards_to
string
the number that this number should be forwarded to; when this is set,
            forwarding_type must also be set


 
forwarding_type
string
sets when this number should have its calls forwarded;
            valid values are 'always' and 'on-failure'


 
enable_caller_id_name
boolean
 Default:  false
if true, enables sending of CNAM information for incoming calls to the number


 
usage_payment_method
string
 Default:  "pay-per_minute"
setting for whether a number is billed per minute or uses your concurrent channels


 Enum: "pay-per-minute" "channel"  
enable_rtp_auto_adjust
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_handling_mode
string
 Default:  "default"
default: media routed through Telnyx with
            transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media
            routed directly between origination and termination endpoints. Only Telnyx support may set a
            number to bypass mode.


 Enum: "default" "proxy" "bypass"  
routing_method
any
 Default:  "sequential"
The method for selecting the next connection IP address to use when dispatching
            calls for the number. This value has no effect for numbers that are not on a connection using
            IP authentication.


 Enum: "sequential" "round-robin"  
cnam_listing_enabled
boolean
 Default:  false
Enable CNAM listings for this number. Requires cnam_listing_details to also
            be filled in.


 
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.


 
external_pin
string
External PINs are used to ensure that phone numbers on your account cannot
          be ported to another carrier without your consent. This has an account level default, that may
          be overriden per phone number. External PINs must be 4 numeric digits ('3456').


 
t38_fax_gateway_enabled
boolean
 Default:  false
 
accept_any_rtp_packets_enabled
boolean
 Default:  false
 
tag_list
Array of strings
 
inbound_call_recording_enabled
boolean
 Default:  false
When enabled, any inbound call to this number will be recorded.


 
inbound_call_recording_format
string
 Default:  "wav"
The audio file format for calls being recorded.


 Enum: "wav" "mp3"  
inbound_call_recording_channels
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.


 Enum: "single" "dual"  
billing_group_id
string
The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).


 
Responses 
200
Number updated


Response Schema: application/json
id
required
string
 
connection_id
required
string
 
number_val_e164
required
string
 
primary_ip
required
string
 
secondary_ip
required
string
 
tertiary_ip
required
string
 
primary_port
required
integer
 Default:  5060
port for the primary ip, defaults to 5060


 
secondary_port
required
integer
 Default:  5060
port for the secondary ip, defaults to 5060


 
tertiary_port
required
integer
 Default:  5060
port for the tertiary ip, defaults to 5060


 
primary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
secondary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
tertiary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
primary_fqdn_port
required
integer
port for the primary FQDN


 
secondary_fqdn_port
required
integer
port for the secondary FQDN


 
tertiary_fqdn_port
required
integer
port for the tertiary FQDN


 
primary_fqdn_dns_record_type
required
string
the DNS record type for the primary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
secondary_fqdn_dns_record_type
required
string
the DNS record type for the secondary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
tertiary_fqdn_dns_record_type
required
string
the DNS record type for the tertiary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
ignore_tech_prefix
required
boolean
 Default:  true
DEPRECATED - Use enable_tech_prefix on API requests


 
enable_tech_prefix
required
boolean
 Default:  false
 
translated_number
required
string
 
forwards_to
required
string
the number that this number should be forwarded to; when this is set,
            forwarding_type must also be set


 
forwarding_type
required
string
sets when this number should have its calls forwarded;
            valid values are 'always' and 'on-failure'


 
tag_list
required
Array of strings
 
status
required
integer
 Default:  1
Purchase Pending = 1, Purchase Failed = 2, Port Pending = 3, Active = 4, Deleted = 5, Port Failed = 6, Emergency Only = 7, Ported Out = 8, Port Out Pending = 9


 
purchase_failure_reason
required
string
reason(s) why the last attempt to purchase this number failed


 
e911_enabled
boolean
 Default:  false
 
e911_address_id
string
 
emergency_status
string
 Default:  "disabled"
 Enum: "disabled" "active" "provisioning" "deprovisioning"  
address_id
string
use this property to reference an Address record if required for a number record


 
usage_payment_method
required
string
 Default:  "pay-per-minute"
setting for whether a number is billed per minute or uses your concurrent channels


 Enum: "pay-per-minute" "channel"  
enable_rtp_auto_adjust
required
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_handling_mode
required
string
 Default:  "default"
default: media routed through Telnyx with
            transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media
            routed directly between origination and termination endpoints. Only Telnyx support may set a
            number to bypass mode.


 Enum: "default" "proxy" "bypass"  
cnam_listing_enabled
required
boolean
 Default:  false
Enable CNAM listings for this number. Requires cnam_listing_details to also
            be filled in.


 
cnam_listing_details
required
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.


 
external_pin
string
External PINs are used to ensure that phone numbers on your account cannot
          be ported to another carrier without your consent. This has an account level default but may
          also be specified per phone number. External PINs must be 4 numeric digits ('3456').


 
t38_fax_gateway_enabled
boolean
 Default:  false
 
accept_any_rtp_packets_enabled
boolean
 Default:  false
 
number_val
required
string
DEPRECATION WARNING! Please use number_val_e164 or contact support@telnyx.com if you depend on this key.


 
inbound_call_recording_enabled
required
boolean
 Default:  false
When enabled, any inbound call to this number will be recorded.


 
inbound_call_recording_format
required
string
 Default:  "wav"
The audio file format for calls being recorded.


 Enum: "wav" "mp3"  
inbound_call_recording_channels
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.


 Enum: "single" "dual"  
billing_group_id
string
The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).


 
400
Bad request


401
Unauthorized


404
Resource not found


put/origination/numbers/{id}
Request samples 
application/json
{
  • "connection_id": "string",
  • "primary_ip": "string",
  • "secondary_ip": "string",
  • "tertiary_ip": "string",
  • "primary_port": 5060,
  • "secondary_port": 5060,
  • "tertiary_port": 5060,
  • "primary_fqdn": "string",
  • "secondary_fqdn": "string",
  • "tertiary_fqdn": "string",
  • "primary_fqdn_port": 0,
  • "secondary_fqdn_port": 0,
  • "tertiary_fqdn_port": 0,
  • "primary_fqdn_dns_record_type": "a",
  • "secondary_fqdn_dns_record_type": "a",
  • "tertiary_fqdn_dns_record_type": "a",
  • "enable_tech_prefix": false,
  • "translated_number": "string",
  • "forwards_to": "string",
  • "forwarding_type": "string",
  • "enable_caller_id_name": false,
  • "usage_payment_method": "pay-per-minute",
  • "enable_rtp_auto_adjust": true,
  • "media_handling_mode": "default",
  • "routing_method": "sequential",
  • "cnam_listing_enabled": false,
  • "cnam_listing_details": "string",
  • "external_pin": "string",
  • "t38_fax_gateway_enabled": false,
  • "accept_any_rtp_packets_enabled": false,
  • "tag_list": [
    • "string"
    ],
  • "inbound_call_recording_enabled": false,
  • "inbound_call_recording_format": "wav",
  • "inbound_call_recording_channels": "single",
  • "billing_group_id": "string"
}
Response samples 
application/json
{
  • "id": "string",
  • "connection_id": "string",
  • "number_val_e164": "string",
  • "primary_ip": "string",
  • "secondary_ip": "string",
  • "tertiary_ip": "string",
  • "primary_port": 5060,
  • "secondary_port": 5060,
  • "tertiary_port": 5060,
  • "primary_fqdn": "string",
  • "secondary_fqdn": "string",
  • "tertiary_fqdn": "string",
  • "primary_fqdn_port": 0,
  • "secondary_fqdn_port": 0,
  • "tertiary_fqdn_port": 0,
  • "primary_fqdn_dns_record_type": "a",
  • "secondary_fqdn_dns_record_type": "a",
  • "tertiary_fqdn_dns_record_type": "a",
  • "ignore_tech_prefix": true,
  • "enable_tech_prefix": false,
  • "translated_number": "string",
  • "forwards_to": "string",
  • "forwarding_type": "string",
  • "tag_list": [
    • "string"
    ],
  • "status": 1,
  • "purchase_failure_reason": "string",
  • "e911_enabled": false,
  • "e911_address_id": "string",
  • "emergency_status": "disabled",
  • "address_id": "string",
  • "usage_payment_method": "pay-per-minute",
  • "enable_rtp_auto_adjust": true,
  • "media_handling_mode": "default",
  • "cnam_listing_enabled": false,
  • "cnam_listing_details": "string",
  • "external_pin": "string",
  • "t38_fax_gateway_enabled": false,
  • "accept_any_rtp_packets_enabled": false,
  • "number_val": "string",
  • "inbound_call_recording_enabled": false,
  • "inbound_call_recording_format": "wav",
  • "inbound_call_recording_channels": "single",
  • "billing_group_id": "string"
}
Delete a number
Permanently deletes a number. The ID in the path can either be the telephone number (e.g. +12124567890) or object ID.


Request 
path Parameters
id
required
string
Telephone number (ex: +12124567890) or object ID of number to delete


 
Responses 
200
Number deleted


Response Schema: application/json
id
required
string
 
connection_id
required
string
 
number_val_e164
required
string
 
primary_ip
required
string
 
secondary_ip
required
string
 
tertiary_ip
required
string
 
primary_port
required
integer
 Default:  5060
port for the primary ip, defaults to 5060


 
secondary_port
required
integer
 Default:  5060
port for the secondary ip, defaults to 5060


 
tertiary_port
required
integer
 Default:  5060
port for the tertiary ip, defaults to 5060


 
primary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
secondary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
tertiary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
primary_fqdn_port
required
integer
port for the primary FQDN


 
secondary_fqdn_port
required
integer
port for the secondary FQDN


 
tertiary_fqdn_port
required
integer
port for the tertiary FQDN


 
primary_fqdn_dns_record_type
required
string
the DNS record type for the primary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
secondary_fqdn_dns_record_type
required
string
the DNS record type for the secondary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
tertiary_fqdn_dns_record_type
required
string
the DNS record type for the tertiary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
ignore_tech_prefix
required
boolean
 Default:  true
DEPRECATED - Use enable_tech_prefix on API requests


 
enable_tech_prefix
required
boolean
 Default:  false
 
translated_number
required
string
 
forwards_to
required
string
the number that this number should be forwarded to; when this is set,
            forwarding_type must also be set


 
forwarding_type
required
string
sets when this number should have its calls forwarded;
            valid values are 'always' and 'on-failure'


 
tag_list
required
Array of strings
 
status
required
integer
 Default:  1
Purchase Pending = 1, Purchase Failed = 2, Port Pending = 3, Active = 4, Deleted = 5, Port Failed = 6, Emergency Only = 7, Ported Out = 8, Port Out Pending = 9


 
purchase_failure_reason
required
string
reason(s) why the last attempt to purchase this number failed


 
e911_enabled
boolean
 Default:  false
 
e911_address_id
string
 
emergency_status
string
 Default:  "disabled"
 Enum: "disabled" "active" "provisioning" "deprovisioning"  
address_id
string
use this property to reference an Address record if required for a number record


 
usage_payment_method
required
string
 Default:  "pay-per-minute"
setting for whether a number is billed per minute or uses your concurrent channels


 Enum: "pay-per-minute" "channel"  
enable_rtp_auto_adjust
required
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_handling_mode
required
string
 Default:  "default"
default: media routed through Telnyx with
            transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media
            routed directly between origination and termination endpoints. Only Telnyx support may set a
            number to bypass mode.


 Enum: "default" "proxy" "bypass"  
cnam_listing_enabled
required
boolean
 Default:  false
Enable CNAM listings for this number. Requires cnam_listing_details to also
            be filled in.


 
cnam_listing_details
required
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.


 
external_pin
string
External PINs are used to ensure that phone numbers on your account cannot
          be ported to another carrier without your consent. This has an account level default but may
          also be specified per phone number. External PINs must be 4 numeric digits ('3456').


 
t38_fax_gateway_enabled
boolean
 Default:  false
 
accept_any_rtp_packets_enabled
boolean
 Default:  false
 
number_val
required
string
DEPRECATION WARNING! Please use number_val_e164 or contact support@telnyx.com if you depend on this key.


 
inbound_call_recording_enabled
required
boolean
 Default:  false
When enabled, any inbound call to this number will be recorded.


 
inbound_call_recording_format
required
string
 Default:  "wav"
The audio file format for calls being recorded.


 Enum: "wav" "mp3"  
inbound_call_recording_channels
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.


 Enum: "single" "dual"  
billing_group_id
string
The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).


 
401
Unauthorized


404
Resource not found


delete/origination/numbers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "connection_id": "string",
  • "number_val_e164": "string",
  • "primary_ip": "string",
  • "secondary_ip": "string",
  • "tertiary_ip": "string",
  • "primary_port": 5060,
  • "secondary_port": 5060,
  • "tertiary_port": 5060,
  • "primary_fqdn": "string",
  • "secondary_fqdn": "string",
  • "tertiary_fqdn": "string",
  • "primary_fqdn_port": 0,
  • "secondary_fqdn_port": 0,
  • "tertiary_fqdn_port": 0,
  • "primary_fqdn_dns_record_type": "a",
  • "secondary_fqdn_dns_record_type": "a",
  • "tertiary_fqdn_dns_record_type": "a",
  • "ignore_tech_prefix": true,
  • "enable_tech_prefix": false,
  • "translated_number": "string",
  • "forwards_to": "string",
  • "forwarding_type": "string",
  • "tag_list": [
    • "string"
    ],
  • "status": 1,
  • "purchase_failure_reason": "string",
  • "e911_enabled": false,
  • "e911_address_id": "string",
  • "emergency_status": "disabled",
  • "address_id": "string",
  • "usage_payment_method": "pay-per-minute",
  • "enable_rtp_auto_adjust": true,
  • "media_handling_mode": "default",
  • "cnam_listing_enabled": false,
  • "cnam_listing_details": "string",
  • "external_pin": "string",
  • "t38_fax_gateway_enabled": false,
  • "accept_any_rtp_packets_enabled": false,
  • "number_val": "string",
  • "inbound_call_recording_enabled": false,
  • "inbound_call_recording_format": "wav",
  • "inbound_call_recording_channels": "single",
  • "billing_group_id": "string"
}
Create a bulk number update request
Update multiple numbers at once with POST/origination/bulk_number_update_requests/.


Each number's status must be Active (4) or Port Pending (3).


Check the status of your bulk request and the error_messages property with GET/origination/bulk_number_update_requests/{id}.
Note that only the properties you specified are returned in the GET.


New bulk requests are created in Pending status (1).
They move to Complete status (2) after a period of time that varies with the
size of the request. If for some reason they can't be processed within 15
minutes then they are moved to Expired status (3).


PLEASE NOTE: Any changes made to a number while a bulk request is pending can and will be overwritten when the bulk request
is processed.


Additional note: All parameters are optional except for: ids_or_number_values. If you want to nullify a property
then you should send an empty value for it. If you want to leave a property unmodified then you should leave its
key out of the request.


Request 
Request Body schema: application/json
required
Bulk number update request


ids_or_number_vals
required
Array of strings
Array of number ids and/or number values to update


 
connection_id
string
 
primary_ip
string
 
secondary_ip
string
 
tertiary_ip
string
 
primary_port
integer
 Default:  5060
 
secondary_port
integer
 Default:  5060
 
tertiary_port
integer
 Default:  5060
 
forwards_to
string
 
forwarding_type
string
sets when this number should have its calls forwarded;
            valid values are 'always' and 'on-failure'


 
e911_enabled
boolean
 
e911_address_id
string
 
address_id
string
references an Address record


 
enable_tech_prefix
boolean
 
translated_number
string
 
usage_payment_method
string
 Default:  "pay-per-minute"
setting for whether a number is billed per minute or uses your concurrent channels


 Enum: "pay-per-minute" "channel"  
enable_rtp_auto_adjust
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_handling_mode
string
 Default:  "default"
default: media routed through Telnyx with
            transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media
            routed directly between origination and termination endpoints. Only Telnyx support may set a
            number to bypass mode.


 Enum: "default" "proxy" "bypass"  
tag_list
Array of strings
 
t38_fax_gateway_enabled
boolean
 Default:  false
 
cnam_listing_enabled
boolean
 Default:  false
Enable CNAM listings for this number. Requires cnam_listing_details to also
            be filled in.


 
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.


 
accept_any_rtp_packets_enabled
boolean
 Default:  false
 
inbound_call_recording_enabled
boolean
 Default:  false
When enabled, any inbound call to this number will be recorded.


 
inbound_call_recording_format
string
 Default:  "wav"
The audio file format for calls being recorded.


 Enum: "wav" "mp3"  
inbound_call_recording_channels
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.


 Enum: "single" "dual"  
Responses 
200
Bulk Number Update Request


Response Schema: application/json
id
required
string
 
status
required
integer
Pending = 1,
Complete = 2,
Expired = 3


 
error_messages
required
Array of strings
Array of any specific errors encountered while updating each number in the request


 
400
Bad request


401
Unauthorized


422
Unprocessable entity. Can be caused by invalid values.
             Check message field in response for details.


post/origination/bulk_number_update_requests
Request samples 
application/json
{
  • "ids_or_number_vals": [
    • "string"
    ],
  • "connection_id": "string",
  • "primary_ip": "string",
  • "secondary_ip": "string",
  • "tertiary_ip": "string",
  • "primary_port": 5060,
  • "secondary_port": 5060,
  • "tertiary_port": 5060,
  • "forwards_to": "string",
  • "forwarding_type": "string",
  • "e911_enabled": true,
  • "e911_address_id": "string",
  • "address_id": "string",
  • "enable_tech_prefix": true,
  • "translated_number": "string",
  • "usage_payment_method": "pay-per-minute",
  • "enable_rtp_auto_adjust": true,
  • "media_handling_mode": "default",
  • "tag_list": [
    • "string"
    ],
  • "t38_fax_gateway_enabled": false,
  • "cnam_listing_enabled": false,
  • "cnam_listing_details": "string",
  • "accept_any_rtp_packets_enabled": false,
  • "inbound_call_recording_enabled": false,
  • "inbound_call_recording_format": "wav",
  • "inbound_call_recording_channels": "single"
}
Response samples 
application/json
{
  • "id": "string",
  • "status": 0,
  • "error_messages": [
    • "string"
    ]
}
Retrieve a bulk number update request
Update multiple numbers at once with POST/origination/bulk_number_update_requests/.


Each number's status must be Active (4) or Port Pending (3).


Check the status of your bulk request and the error_messages property with GET/origination/bulk_number_update_requests/{id}.
Note that only the properties you specified are returned in the GET.


New bulk requests are created in Pending status (1).
They move to Complete status (2) after a period of time that varies with the
size of the request. If for some reason they can't be processed within 15
minutes then they are moved to Expired status (3).


PLEASE NOTE: Any changes made to a number while a bulk request is pending can and will be overwritten when the bulk request
is processed.


Additional note: All parameters are optional except for: ids_or_number_values. If you want to nullify a property
then you should send an empty value for it. If you want to leave a property unmodified then you should leave its
key out of the request.


Request 
path Parameters
id
required
string
ID of the bulk update request


 
Responses 
200
Bulk Number Update Request


Response Schema: application/json
ids_or_number_vals
required
Array of strings
Array of number ids and/or number values to update


 
connection_id
string
 
primary_ip
string
 
secondary_ip
string
 
tertiary_ip
string
 
primary_port
integer
 Default:  5060
 
secondary_port
integer
 Default:  5060
 
tertiary_port
integer
 Default:  5060
 
forwards_to
string
 
forwarding_type
string
sets when this number should have its calls forwarded;
            valid values are 'always' and 'on-failure'


 
e911_enabled
boolean
 
e911_address_id
string
 
address_id
string
references an Address record


 
enable_tech_prefix
boolean
 
translated_number
string
 
usage_payment_method
string
 Default:  "pay-per-minute"
setting for whether a number is billed per minute or uses your concurrent channels


 Enum: "pay-per-minute" "channel"  
enable_rtp_auto_adjust
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_handling_mode
string
 Default:  "default"
default: media routed through Telnyx with
            transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media
            routed directly between origination and termination endpoints. Only Telnyx support may set a
            number to bypass mode.


 Enum: "default" "proxy" "bypass"  
tag_list
Array of strings
 
t38_fax_gateway_enabled
boolean
 Default:  false
 
cnam_listing_enabled
boolean
 Default:  false
Enable CNAM listings for this number. Requires cnam_listing_details to also
            be filled in.


 
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.


 
accept_any_rtp_packets_enabled
boolean
 Default:  false
 
inbound_call_recording_enabled
boolean
 Default:  false
When enabled, any inbound call to this number will be recorded.


 
inbound_call_recording_format
string
 Default:  "wav"
The audio file format for calls being recorded.


 Enum: "wav" "mp3"  
inbound_call_recording_channels
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.


 Enum: "single" "dual"  
401
Unauthorized


404
Resource not found


422
Unprocessable entity. Can be caused by invalid values.
             Check message field in response for details.


get/origination/bulk_number_update_requests/{id}
Request samples 
Response samples 
application/json
{
  • "ids_or_number_vals": [
    • "string"
    ],
  • "connection_id": "string",
  • "primary_ip": "string",
  • "secondary_ip": "string",
  • "tertiary_ip": "string",
  • "primary_port": 5060,
  • "secondary_port": 5060,
  • "tertiary_port": 5060,
  • "forwards_to": "string",
  • "forwarding_type": "string",
  • "e911_enabled": true,
  • "e911_address_id": "string",
  • "address_id": "string",
  • "enable_tech_prefix": true,
  • "translated_number": "string",
  • "usage_payment_method": "pay-per-minute",
  • "enable_rtp_auto_adjust": true,
  • "media_handling_mode": "default",
  • "tag_list": [
    • "string"
    ],
  • "t38_fax_gateway_enabled": false,
  • "cnam_listing_enabled": false,
  • "cnam_listing_details": "string",
  • "accept_any_rtp_packets_enabled": false,
  • "inbound_call_recording_enabled": false,
  • "inbound_call_recording_format": "wav",
  • "inbound_call_recording_channels": "single"
}
Create a request to download all of your numbers in a CSV file
Create a request to download all of your numbers in a CSV file


Responses 
200
Created response


Response Schema: application/json
id
required
string
 
url
required
string
The URL where your CSV file will be uploaded shortly after we receive your request


 
status
required
integer
One of 'pending', 'complete', 'expired', or 'failed'


 
400
Bad request


401
Unauthorized


post/origination/number_csv_download_requests
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "url": "string",
  • "status": 0
}
Retrieve all of your number CSV download request
Retrieve all of your number CSV download requests


Request 
query Parameters
page
integer
 Default:  1
Page number of results to load


 
per_page
integer  <= 1000 
 Default:  100
Number of results per page


 
Responses 
200
Success


Response Schema: application/json
 Array 
id
required
string
 
url
required
string
The URL where your CSV file will be uploaded shortly after we receive your request


 
status
required
integer
One of 'pending', 'complete', 'expired', or 'failed'


 
401
Unauthorized


404
Resource not found


422
Unprocessable entity. Can be caused by invalid values.
              Check message field in response for details.


get/origination/number_csv_download_requests
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "url": "string",
    • "status": 0
    }
]
Retrieve a number CSV download request
Retrieve a number CSV download request


Request 
path Parameters
id
required
string
ID of the CSV download request


 
Responses 
200
Success


Response Schema: application/json
id
required
string
 
url
required
string
The URL where your CSV file will be uploaded shortly after we receive your request


 
status
required
integer
One of 'pending', 'complete', 'expired', or 'failed'


 
401
Unauthorized


404
Resource not found


422
Unprocessable entity. Can be caused by invalid values.
              Check message field in response for details.


get/origination/number_csv_download_requests/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "url": "string",
  • "status": 0
}
Enable E911 on a number
Enables E911 on a number. The ID supplied can be the telephone number (e.g. +12124567890) or object ID.


Request 
path Parameters
id
required
string
Telephone number (ex: +12124567890) or object ID of number to update


 
Request Body schema: application/json
required
Number E911 object


e911_enabled
required
boolean
 Default:  true
 
e911_address_id
required
string
 
Responses 
200
Number E911 enable


Response Schema: application/json
id
required
string
 
connection_id
required
string
 
number_val_e164
required
string
 
primary_ip
required
string
 
secondary_ip
required
string
 
tertiary_ip
required
string
 
primary_port
required
integer
 Default:  5060
port for the primary ip, defaults to 5060


 
secondary_port
required
integer
 Default:  5060
port for the secondary ip, defaults to 5060


 
tertiary_port
required
integer
 Default:  5060
port for the tertiary ip, defaults to 5060


 
primary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
secondary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
tertiary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
primary_fqdn_port
required
integer
port for the primary FQDN


 
secondary_fqdn_port
required
integer
port for the secondary FQDN


 
tertiary_fqdn_port
required
integer
port for the tertiary FQDN


 
primary_fqdn_dns_record_type
required
string
the DNS record type for the primary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
secondary_fqdn_dns_record_type
required
string
the DNS record type for the secondary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
tertiary_fqdn_dns_record_type
required
string
the DNS record type for the tertiary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
ignore_tech_prefix
required
boolean
 Default:  true
DEPRECATED - Use enable_tech_prefix on API requests


 
enable_tech_prefix
required
boolean
 Default:  false
 
translated_number
required
string
 
forwards_to
required
string
the number that this number should be forwarded to; when this is set,
            forwarding_type must also be set


 
forwarding_type
required
string
sets when this number should have its calls forwarded;
            valid values are 'always' and 'on-failure'


 
tag_list
required
Array of strings
 
status
required
integer
 Default:  1
Purchase Pending = 1, Purchase Failed = 2, Port Pending = 3, Active = 4, Deleted = 5, Port Failed = 6, Emergency Only = 7, Ported Out = 8, Port Out Pending = 9


 
purchase_failure_reason
required
string
reason(s) why the last attempt to purchase this number failed


 
e911_enabled
boolean
 Default:  false
 
e911_address_id
string
 
emergency_status
string
 Default:  "disabled"
 Enum: "disabled" "active" "provisioning" "deprovisioning"  
address_id
string
use this property to reference an Address record if required for a number record


 
usage_payment_method
required
string
 Default:  "pay-per-minute"
setting for whether a number is billed per minute or uses your concurrent channels


 Enum: "pay-per-minute" "channel"  
enable_rtp_auto_adjust
required
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_handling_mode
required
string
 Default:  "default"
default: media routed through Telnyx with
            transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media
            routed directly between origination and termination endpoints. Only Telnyx support may set a
            number to bypass mode.


 Enum: "default" "proxy" "bypass"  
cnam_listing_enabled
required
boolean
 Default:  false
Enable CNAM listings for this number. Requires cnam_listing_details to also
            be filled in.


 
cnam_listing_details
required
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.


 
external_pin
string
External PINs are used to ensure that phone numbers on your account cannot
          be ported to another carrier without your consent. This has an account level default but may
          also be specified per phone number. External PINs must be 4 numeric digits ('3456').


 
t38_fax_gateway_enabled
boolean
 Default:  false
 
accept_any_rtp_packets_enabled
boolean
 Default:  false
 
number_val
required
string
DEPRECATION WARNING! Please use number_val_e164 or contact support@telnyx.com if you depend on this key.


 
inbound_call_recording_enabled
required
boolean
 Default:  false
When enabled, any inbound call to this number will be recorded.


 
inbound_call_recording_format
required
string
 Default:  "wav"
The audio file format for calls being recorded.


 Enum: "wav" "mp3"  
inbound_call_recording_channels
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.


 Enum: "single" "dual"  
billing_group_id
string
The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).


 
202
Number Emergency Requested


Response Schema: application/json
id
required
string
 
connection_id
required
string
 
number_val_e164
required
string
 
primary_ip
required
string
 
secondary_ip
required
string
 
tertiary_ip
required
string
 
primary_port
required
integer
 Default:  5060
port for the primary ip, defaults to 5060


 
secondary_port
required
integer
 Default:  5060
port for the secondary ip, defaults to 5060


 
tertiary_port
required
integer
 Default:  5060
port for the tertiary ip, defaults to 5060


 
primary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
secondary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
tertiary_fqdn
required
string
the primary domain name for the number. Only relevant for numbers using a
            connection of FQDN-based authentication.


 
primary_fqdn_port
required
integer
port for the primary FQDN


 
secondary_fqdn_port
required
integer
port for the secondary FQDN


 
tertiary_fqdn_port
required
integer
port for the tertiary FQDN


 
primary_fqdn_dns_record_type
required
string
the DNS record type for the primary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
secondary_fqdn_dns_record_type
required
string
the DNS record type for the secondary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
tertiary_fqdn_dns_record_type
required
string
the DNS record type for the tertiary FQDN for the number. For cases where a port
            is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record
            type must be 'a'.


 Enum: "a" "srv"  
ignore_tech_prefix
required
boolean
 Default:  true
DEPRECATED - Use enable_tech_prefix on API requests


 
enable_tech_prefix
required
boolean
 Default:  false
 
translated_number
required
string
 
forwards_to
required
string
the number that this number should be forwarded to; when this is set,
            forwarding_type must also be set


 
forwarding_type
required
string
sets when this number should have its calls forwarded;
            valid values are 'always' and 'on-failure'


 
tag_list
required
Array of strings
 
status
required
integer
 Default:  1
Purchase Pending = 1, Purchase Failed = 2, Port Pending = 3, Active = 4, Deleted = 5, Port Failed = 6, Emergency Only = 7, Ported Out = 8, Port Out Pending = 9


 
purchase_failure_reason
required
string
reason(s) why the last attempt to purchase this number failed


 
e911_enabled
boolean
 Default:  false
 
e911_address_id
string
 
emergency_status
string
 Default:  "disabled"
 Enum: "disabled" "active" "provisioning" "deprovisioning"  
address_id
string
use this property to reference an Address record if required for a number record


 
usage_payment_method
required
string
 Default:  "pay-per-minute"
setting for whether a number is billed per minute or uses your concurrent channels


 Enum: "pay-per-minute" "channel"  
enable_rtp_auto_adjust
required
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_handling_mode
required
string
 Default:  "default"
default: media routed through Telnyx with
            transcode support. proxy: media routed through Telnyx with no transcode support. bypass: media
            routed directly between origination and termination endpoints. Only Telnyx support may set a
            number to bypass mode.


 Enum: "default" "proxy" "bypass"  
cnam_listing_enabled
required
boolean
 Default:  false
Enable CNAM listings for this number. Requires cnam_listing_details to also
            be filled in.


 
cnam_listing_details
required
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.


 
external_pin
string
External PINs are used to ensure that phone numbers on your account cannot
          be ported to another carrier without your consent. This has an account level default but may
          also be specified per phone number. External PINs must be 4 numeric digits ('3456').


 
t38_fax_gateway_enabled
boolean
 Default:  false
 
accept_any_rtp_packets_enabled
boolean
 Default:  false
 
number_val
required
string
DEPRECATION WARNING! Please use number_val_e164 or contact support@telnyx.com if you depend on this key.


 
inbound_call_recording_enabled
required
boolean
 Default:  false
When enabled, any inbound call to this number will be recorded.


 
inbound_call_recording_format
required
string
 Default:  "wav"
The audio file format for calls being recorded.


 Enum: "wav" "mp3"  
inbound_call_recording_channels
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.


 Enum: "single" "dual"  
billing_group_id
string
The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).


 
400
Bad request


401
Unauthorized


put/origination/numbers/{id}/e911_settings
Request samples 
application/json
{
  • "e911_enabled": true,
  • "e911_address_id": "string"
}
Response samples 
application/json
{
  • "id": "string",
  • "connection_id": "string",
  • "number_val_e164": "string",
  • "primary_ip": "string",
  • "secondary_ip": "string",
  • "tertiary_ip": "string",
  • "primary_port": 5060,
  • "secondary_port": 5060,
  • "tertiary_port": 5060,
  • "primary_fqdn": "string",
  • "secondary_fqdn": "string",
  • "tertiary_fqdn": "string",
  • "primary_fqdn_port": 0,
  • "secondary_fqdn_port": 0,
  • "tertiary_fqdn_port": 0,
  • "primary_fqdn_dns_record_type": "a",
  • "secondary_fqdn_dns_record_type": "a",
  • "tertiary_fqdn_dns_record_type": "a",
  • "ignore_tech_prefix": true,
  • "enable_tech_prefix": false,
  • "translated_number": "string",
  • "forwards_to": "string",
  • "forwarding_type": "string",
  • "tag_list": [
    • "string"
    ],
  • "status": 1,
  • "purchase_failure_reason": "string",
  • "e911_enabled": false,
  • "e911_address_id": "string",
  • "emergency_status": "disabled",
  • "address_id": "string",
  • "usage_payment_method": "pay-per-minute",
  • "enable_rtp_auto_adjust": true,
  • "media_handling_mode": "default",
  • "cnam_listing_enabled": false,
  • "cnam_listing_details": "string",
  • "external_pin": "string",
  • "t38_fax_gateway_enabled": false,
  • "accept_any_rtp_packets_enabled": false,
  • "number_val": "string",
  • "inbound_call_recording_enabled": false,
  • "inbound_call_recording_format": "wav",
  • "inbound_call_recording_channels": "single",
  • "billing_group_id": "string"
}