Retrieve a phone number with voice settings
GET/phone_numbers/:id/voice
Retrieve a phone number with voice settings
Request
Path Parameters
Identifies the resource.
Responses
200: Successful response with details about a phone number including voice settings.
- application/json
- Schema
- Example (from schema)
Schema
data
object
Identifies the type of resource.
Identifies the type of the resource.
The phone number in +E164 format.
Identifies the connection associated with this phone number.
A customer reference string for customer look ups.
Controls whether a tech prefix is enabled for this phone number.
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.
call_forwarding
object
The call forwarding settings for a phone number.
Default value: 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.
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.
Possible values: [always
, on_failure
]
Call forwarding type. 'forwards_to' must be set for this to have an effect.
The call forwarding settings for a phone number.
cnam_listing
object
The CNAM listing settings for a phone number.
Enables CNAM listings for this number. Requires cnam_listing_details to also be set.
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.
The CNAM listing settings for a phone number.
emergency
object
The emergency services settings for a phone number.
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.
Identifies the address to be used with emergency services.
Possible values: [disabled
, active
, provisioning
, deprovisioning
]
Default value: disabled
Represents the state of the number regarding emergency activation.
The emergency services settings for a phone number.
Possible values: [pay-per-minute
, channel
]
Default value: pay-per-minute
Controls whether a number is billed per minute or uses your concurrent channels.
media_features
object
The media features settings for a phone number.
Default value: 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.
When enabled, Telnyx will accept RTP packets from any customer-side IP address and port, not just those to which Telnyx is sending RTP.
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.
The media features settings for a phone number.
call_recording
object
The call recording settings for a phone number.
When enabled, any inbound call to this number will be recorded.
Possible values: [wav
, mp3
]
Default value: wav
The audio file format for calls being recorded.
Possible values: [single
, dual
]
Default value: 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.
The call recording settings for a phone number.
Possible values: [disabled
, reject_calls
, flag_calls
]
Default value: 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.
{
"data": {
"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"
},
"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"
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
meta
object
URL with additional information on the error.
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "string"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}