openapi: 3.1.0
info:
contact:
email: support@telnyx.com
description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform.
title: Telnyx Access Tokens FQDN Connections API
version: 2.0.0
x-endpoint-cost: light
servers:
- description: Version 2.0.0 of the Telnyx API
url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: FQDN connection operations
name: FQDN Connections
paths:
/fqdn_connections:
get:
description: Returns a list of your FQDN connections.
operationId: ListFqdnConnections
parameters:
- $ref: '#/components/parameters/connections_FilterConsolidated'
- $ref: '#/components/parameters/connections_PageConsolidated'
- $ref: '#/components/parameters/connections_SortConnection'
responses:
'200':
$ref: '#/components/responses/ListFqdnConnectionsResponse'
'400':
$ref: '#/components/responses/connections_BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
summary: List FQDN connections
tags:
- FQDN Connections
x-endpoint-cost: medium
x-group-parameters: 'true'
x-latency-category: responsive
post:
description: Creates a FQDN connection.
operationId: CreateFqdnConnection
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFqdnConnectionRequest'
description: Parameters that can be defined during FQDN connection creation
required: true
responses:
'201':
$ref: '#/components/responses/FqdnConnectionResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
'422':
$ref: '#/components/responses/connections_UnprocessableEntityResponse'
summary: Create an FQDN connection
tags:
- FQDN Connections
x-endpoint-cost: medium
x-latency-category: responsive
/fqdn_connections/{id}:
delete:
description: Deletes an FQDN connection.
operationId: DeleteFqdnConnection
parameters:
- $ref: '#/components/parameters/connections_id'
responses:
'200':
$ref: '#/components/responses/FqdnConnectionResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
'422':
$ref: '#/components/responses/connections_UnprocessableEntityResponse'
summary: Delete an FQDN connection
tags:
- FQDN Connections
x-latency-category: responsive
get:
description: Retrieves the details of an existing FQDN connection.
operationId: RetrieveFqdnConnection
parameters:
- $ref: '#/components/parameters/connections_id'
responses:
'200':
$ref: '#/components/responses/FqdnConnectionResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
'422':
$ref: '#/components/responses/connections_UnprocessableEntityResponse'
summary: Retrieve an FQDN connection
tags:
- FQDN Connections
x-latency-category: responsive
patch:
description: Updates settings of an existing FQDN connection.
operationId: UpdateFqdnConnection
parameters:
- $ref: '#/components/parameters/connections_id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFqdnConnectionRequest'
description: Parameters that can be updated in a FQDN connection
required: true
responses:
'200':
$ref: '#/components/responses/FqdnConnectionResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
'422':
$ref: '#/components/responses/connections_UnprocessableEntityResponse'
summary: Update an FQDN connection
tags:
- FQDN Connections
x-latency-category: responsive
components:
schemas:
FqdnConnectionTransportProtocol:
default: UDP
description: One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.
enum:
- UDP
- TCP
- TLS
type: string
UpdateFqdnConnectionRequest:
example:
active: true
anchorsite_override: Latency
android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e
call_cost_in_webhooks: true
connection_name: string
default_on_hold_comfort_noise_enabled: true
dtmf_type: RFC 2833
encode_contact_header_enabled: true
encrypted_media: SRTP
inbound:
ani_number_format: +E.164
channel_limit: 10
codecs:
- G722
dnis_number_format: +e164
generate_ringback_tone: true
isup_headers_enabled: true
prack_enabled: true
shaken_stir_enabled: true
sip_compact_headers_enabled: true
sip_region: US
sip_subdomain: string
sip_subdomain_receive_settings: only_my_connections
timeout_1xx_secs: 10
timeout_2xx_secs: 10
ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836
jitter_buffer:
enable_jitter_buffer: true
jitterbuffer_msec_max: 200
jitterbuffer_msec_min: 60
noise_suppression: both
noise_suppression_details:
attenuation_limit: 80
engine: deep_filter_net
onnet_t38_passthrough_enabled: true
rtcp_settings:
capture_enabled: true
port: rtcp-mux
report_frequency_secs: 10
tags:
- tag1
- tag2
transport_protocol: UDP
webhook_api_version: '1'
webhook_event_failover_url: https://failover.example.com
webhook_event_url: https://example.com
webhook_timeout_secs: 25
properties:
active:
description: Defaults to true
type: boolean
anchorsite_override:
$ref: '#/components/schemas/AnchorsiteOverride'
android_push_credential_id:
$ref: '#/components/schemas/ConnectionAndroidPushCredentialId'
call_cost_in_webhooks:
default: false
description: Specifies if call cost webhooks should be sent for this connection.
type: boolean
connection_name:
$ref: '#/components/schemas/ConnectionName'
default_on_hold_comfort_noise_enabled:
default: true
description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
type: boolean
dtmf_type:
$ref: '#/components/schemas/DtmfType'
encode_contact_header_enabled:
default: false
description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
type: boolean
encrypted_media:
$ref: '#/components/schemas/EncryptedMedia'
inbound:
$ref: '#/components/schemas/InboundFqdn'
ios_push_credential_id:
$ref: '#/components/schemas/ConnectionIosPushCredentialId'
jitter_buffer:
$ref: '#/components/schemas/ConnectionJitterBuffer'
noise_suppression:
$ref: '#/components/schemas/ConnectionNoiseSuppression'
noise_suppression_details:
$ref: '#/components/schemas/ConnectionNoiseSuppressionDetails'
onnet_t38_passthrough_enabled:
default: false
description: Enable on-net T38 if you prefer that the sender and receiver negotiate T38 directly when both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call according to each leg's settings.
type: boolean
outbound:
$ref: '#/components/schemas/OutboundFqdn'
rtcp_settings:
$ref: '#/components/schemas/ConnectionRtcpSettings'
tags:
description: Tags associated with the connection.
example:
- tag1
- tag2
items:
type: string
type: array
transport_protocol:
$ref: '#/components/schemas/FqdnConnectionTransportProtocol'
webhook_api_version:
$ref: '#/components/schemas/WebhookApiVersion'
webhook_event_failover_url:
$ref: '#/components/schemas/WebhookEventFailoverUrl'
webhook_event_url:
$ref: '#/components/schemas/WebhookEventUrl'
webhook_timeout_secs:
$ref: '#/components/schemas/WebhookTimeoutSecs'
title: Update FQDN Connection Request
type: object
DtmfType:
default: RFC 2833
description: Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
enum:
- RFC 2833
- Inband
- SIP INFO
example: Inband
title: DTMF Type
type: string
connections_PaginationMeta:
properties:
page_number:
example: 2
type: integer
page_size:
example: 25
type: integer
total_pages:
example: 3
type: integer
total_results:
example: 55
type: integer
title: Pagination Meta
type: object
EncryptedMedia:
description: Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.
enum:
- SRTP
- null
example: SRTP
type:
- string
- 'null'
OutboundFqdn:
properties:
ani_override:
description: Set a phone number as the ani_override value to override caller id number on outbound calls.
title: ANI override type
type: string
x-format: E.164
ani_override_type:
default: always
description: Specifies when we should apply your ani_override setting. Only applies when ani_override is not blank.
enum:
- always
- normal
- emergency
example: normal
title: ANI override type
type: string
call_parking_enabled:
default: false
description: Forces all SIP calls originated on this connection to be \"parked\" instead of \"bridged\" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next.
type:
- boolean
- 'null'
channel_limit:
description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
type: integer
encrypted_media:
$ref: '#/components/schemas/EncryptedMedia'
generate_ringback_tone:
default: false
description: Generate ringback tone through 183 session progress message with early media.
type: boolean
instant_ringback_enabled:
default: false
description: When set, ringback will not wait for indication before sending ringback tone to calling party.
type: boolean
ip_authentication_method:
default: ip-authentication
enum:
- credential-authentication
- ip-authentication
example: credential-authentication
type: string
ip_authentication_token:
type: string
localization:
default: US
description: A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.",
example: US
type: string
outbound_voice_profile_id:
$ref: '#/components/schemas/connections_OutboundVoiceProfileId'
t38_reinvite_source:
default: customer
description: This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite. By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite.
enum:
- telnyx
- customer
- disabled
- passthru
- caller-passthru
- callee-passthru
type: string
tech_prefix:
description: Numerical chars only, exactly 4 characters.
type: string
timeout_1xx_secs:
default: 3
description: Time(sec) before aborting if connection is not made.
maximum: 120
minimum: 1
type: integer
timeout_2xx_secs:
default: 90
description: 'Time(sec) before aborting if call is unanswered (min: 1, max: 600).'
maximum: 600
minimum: 1
type: integer
title: Connection Outbound Settings
type: object
ErrorResponse:
properties:
errors:
items:
properties:
code:
type: string
detail:
type: string
meta:
properties:
url:
format: uri
type: string
type: object
source:
properties:
pointer:
type: string
type: object
title:
type: string
type: object
type: array
type: object
ConnectionNoiseSuppression:
description: Controls when noise suppression is applied to calls. When set to 'inbound', noise suppression is applied to incoming audio. When set to 'outbound', it's applied to outgoing audio. When set to 'both', it's applied in both directions. When set to 'disabled', noise suppression is turned off.
enum:
- inbound
- outbound
- both
- disabled
example: both
type: string
ConnectionAndroidPushCredentialId:
default: null
description: The uuid of the push credential for Android
example: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e
title: Android Push Credential Id
type:
- string
- 'null'
WebhookEventUrl:
description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
example: https://example.com
format: uri
title: Webhook Event URL
type: string
FqdnConnection:
example:
active: true
anchorsite_override: Latency
android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e
call_cost_in_webhooks: false
connection_name: string
created_at: '2018-02-02T22:25:27.521Z'
default_on_hold_comfort_noise_enabled: true
dtmf_type: RFC 2833
encode_contact_header_enabled: true
encrypted_media: SRTP
id: '1293384261075731499'
inbound:
ani_number_format: +E.164
channel_limit: 10
codecs:
- G722
dnis_number_format: +e164
generate_ringback_tone: true
isup_headers_enabled: true
prack_enabled: true
shaken_stir_enabled: true
sip_compact_headers_enabled: true
sip_region: US
sip_subdomain: string
sip_subdomain_receive_settings: only_my_connections
timeout_1xx_secs: 10
timeout_2xx_secs: 10
ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836
jitter_buffer:
enable_jitter_buffer: true
jitterbuffer_msec_max: 200
jitterbuffer_msec_min: 60
noise_suppression: both
noise_suppression_details:
attenuation_limit: 80
engine: deep_filter_net
onnet_t38_passthrough_enabled: true
outbound:
ani_override: string
ani_override_type: always
call_parking_enabled: true
channel_limit: 10
generate_ringback_tone: true
instant_ringback_enabled: true
ip_authentication_method: credential-authentication
ip_authentication_token: string
localization: string
outbound_voice_profile_id: '1293384261075731499'
t38_reinvite_source: customer
tech_prefix: string
record_type: fqdn_connection
rtcp_settings:
capture_enabled: true
port: rtcp-mux
report_frequency_secs: 10
tags:
- tag1
- tag2
transport_protocol: UDP
updated_at: '2018-02-02T22:25:27.521Z'
webhook_api_version: '1'
webhook_event_failover_url: https://failover.example.com
webhook_event_url: https://example.com
webhook_timeout_secs: 25
properties:
active:
description: Defaults to true
type: boolean
adjust_dtmf_timestamp:
description: Indicates whether DTMF timestamp adjustment is enabled.
type: boolean
anchorsite_override:
$ref: '#/components/schemas/AnchorsiteOverride'
android_push_credential_id:
$ref: '#/components/schemas/ConnectionAndroidPushCredentialId'
call_cost_enabled:
description: Indicates whether call cost calculation is enabled.
type: boolean
call_cost_in_webhooks:
default: false
description: Specifies if call cost webhooks should be sent for this connection.
type: boolean
connection_name:
$ref: '#/components/schemas/ConnectionName'
created_at:
$ref: '#/components/schemas/CreatedAt'
default_on_hold_comfort_noise_enabled:
default: true
description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
type: boolean
dtmf_type:
$ref: '#/components/schemas/DtmfType'
encode_contact_header_enabled:
default: false
description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
type: boolean
encrypted_media:
$ref: '#/components/schemas/EncryptedMedia'
id:
description: Identifies the resource.
example: '1293384261075731499'
type: string
x-format: int64
ignore_dtmf_duration:
description: Indicates whether DTMF duration should be ignored.
type: boolean
ignore_mark_bit:
description: Indicates whether the mark bit should be ignored.
type: boolean
inbound:
$ref: '#/components/schemas/InboundFqdn'
ios_push_credential_id:
$ref: '#/components/schemas/ConnectionIosPushCredentialId'
jitter_buffer:
$ref: '#/components/schemas/ConnectionJitterBuffer'
microsoft_teams_sbc:
default: false
description: The connection is enabled for Microsoft Teams Direct Routing.
type: boolean
noise_suppression:
$ref: '#/components/schemas/ConnectionNoiseSuppression'
noise_suppression_details:
$ref: '#/components/schemas/ConnectionNoiseSuppressionDetails'
onnet_t38_passthrough_enabled:
default: false
description: Enable on-net T38 if you prefer that the sender and receiver negotiate T38 directly when both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call according to each leg's settings.
type: boolean
outbound:
$ref: '#/components/schemas/OutboundFqdn'
password:
description: The password for the FQDN connection.
type: string
record_type:
description: Identifies the type of the resource.
example: fqdn_connection
type: string
rtcp_settings:
$ref: '#/components/schemas/ConnectionRtcpSettings'
rtp_pass_codecs_on_stream_change:
description: Defines if codecs should be passed on stream change.
type: boolean
send_normalized_timestamps:
description: Indicates whether normalized timestamps should be sent.
type: boolean
tags:
description: Tags associated with the connection.
example:
- tag1
- tag2
items:
type: string
type: array
third_party_control_enabled:
description: Indicates whether third-party control is enabled.
type: boolean
transport_protocol:
$ref: '#/components/schemas/FqdnConnectionTransportProtocol'
txt_name:
description: The name for the TXT record associated with the FQDN connection.
type: string
txt_ttl:
description: The time to live for the TXT record associated with the FQDN connection.
type: integer
txt_value:
description: The value for the TXT record associated with the FQDN connection.
type: string
updated_at:
$ref: '#/components/schemas/UpdatedAt'
user_name:
description: The username for the FQDN connection.
type: string
webhook_api_version:
$ref: '#/components/schemas/WebhookApiVersion'
webhook_event_failover_url:
$ref: '#/components/schemas/WebhookEventFailoverUrl'
webhook_event_url:
$ref: '#/components/schemas/WebhookEventUrl'
webhook_timeout_secs:
$ref: '#/components/schemas/WebhookTimeoutSecs'
required:
- connection_name
title: FQDN Connection
type: object
WebhookApiVersion:
default: '1'
description: Determines which webhook format will be used, Telnyx API v1 or v2.
enum:
- '1'
- '2'
example: '1'
title: Webhook API Version
type: string
AnchorsiteOverride:
default: Latency
description: '`Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user''s connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.'
enum:
- Latency
- Chicago, IL
- Ashburn, VA
- San Jose, CA
- Sydney, Australia
- Amsterdam, Netherlands
- London, UK
- Toronto, Canada
- Vancouver, Canada
- Frankfurt, Germany
example: Amsterdam, Netherlands
title: Anchorsite Override
type: string
UpdatedAt:
description: ISO 8601 formatted date indicating when the resource was updated.
example: '2020-02-03T22:25:27.521Z'
title: Updated At
type: string
ConnectionIosPushCredentialId:
default: null
description: The uuid of the push credential for Ios
example: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836
title: Ios Push Credential Id
type:
- string
- 'null'
CreatedAt:
description: ISO 8601 formatted date indicating when the resource was created.
example: '2020-02-02T22:25:27.521Z'
title: Created At
type: string
CreateFqdnConnectionRequest:
example:
active: true
anchorsite_override: Latency
android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e
call_cost_in_webhooks: false
connection_name: string
default_on_hold_comfort_noise_enabled: true
dtmf_type: RFC 2833
encode_contact_header_enabled: true
encrypted_media: SRTP
inbound:
ani_number_format: +E.164
channel_limit: 10
codecs:
- G722
dnis_number_format: +e164
generate_ringback_tone: true
isup_headers_enabled: true
prack_enabled: true
shaken_stir_enabled: true
sip_compact_headers_enabled: true
sip_region: US
sip_subdomain: string
sip_subdomain_receive_settings: only_my_connections
timeout_1xx_secs: 10
timeout_2xx_secs: 10
ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836
jitter_buffer:
enable_jitter_buffer: true
jitterbuffer_msec_max: 200
jitterbuffer_msec_min: 60
noise_suppression: both
noise_suppression_details:
attenuation_limit: 80
engine: deep_filter_net
onnet_t38_passthrough_enabled: true
outbound:
ani_override: '+1234567890'
ani_override_type: always
call_parking_enabled: true
channel_limit: 10
encrypted_media: SRTP
generate_ringback_tone: true
instant_ringback_enabled: true
ip_authentication_method: credential-authentication
ip_authentication_token: aBcD1234
localization: string
outbound_voice_profile_id: '1293384261075731499'
t38_reinvite_source: customer
tech_prefix: '0123'
timeout_1xx_secs: 10
timeout_2xx_secs: 10
rtcp_settings:
capture_enabled: true
port: rtcp-mux
report_frequency_secs: 10
tags:
- tag1
- tag2
transport_protocol: UDP
webhook_api_version: '1'
webhook_event_failover_url: https://failover.example.com
webhook_event_url: https://example.com
webhook_timeout_secs: 25
properties:
active:
default: true
description: Defaults to true
type: boolean
anchorsite_override:
$ref: '#/components/schemas/AnchorsiteOverride'
android_push_credential_id:
$ref: '#/components/schemas/ConnectionAndroidPushCredentialId'
call_cost_in_webhooks:
default: false
description: Specifies if call cost webhooks should be sent for this connection.
type: boolean
connection_name:
$ref: '#/components/schemas/ConnectionName'
default_on_hold_comfort_noise_enabled:
default: true
description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
type: boolean
dtmf_type:
$ref: '#/components/schemas/DtmfType'
encode_contact_header_enabled:
default: false
description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
type: boolean
encrypted_media:
$ref: '#/components/schemas/EncryptedMedia'
inbound:
$ref: '#/components/schemas/InboundFqdn'
ios_push_credential_id:
$ref: '#/components/schemas/ConnectionIosPushCredentialId'
jitter_buffer:
$ref: '#/components/schemas/ConnectionJitterBuffer'
microsoft_teams_sbc:
default: false
description: When enabled, the connection will be created for Microsoft Teams Direct Routing. A *.mstsbc.telnyx.tech FQDN will be created for the connection automatically.
type: boolean
noise_suppression:
$ref: '#/components/schemas/ConnectionNoiseSuppression'
noise_suppression_details:
$ref: '#/components/schemas/ConnectionNoiseSuppressionDetails'
onnet_t38_passthrough_enabled:
default: false
description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
type: boolean
outbound:
$ref: '#/components/schemas/OutboundFqdn'
rtcp_settings:
$ref: '#/components/schemas/ConnectionRtcpSettings'
tags:
description: Tags associated with the connection.
example:
- tag1
- tag2
items:
type: string
type: array
transport_protocol:
$ref: '#/components/schemas/FqdnConnectionTransportProtocol'
webhook_api_version:
$ref: '#/components/schemas/WebhookApiVersion'
webhook_event_failover_url:
$ref: '#/components/schemas/WebhookEventFailoverUrl'
webhook_event_url:
$ref: '#/components/schemas/WebhookEventUrl'
webhook_timeout_secs:
$ref: '#/components/schemas/WebhookTimeoutSecs'
required:
- connection_name
title: Create FQDN Connection Request
type: object
ConnectionJitterBuffer:
description: Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled. You may define min and max values in msec for customized buffering behaviors. Larger values add latency but tolerate more jitter, while smaller values reduce latency but are more sensitive to jitter and reordering.
properties:
enable_jitter_buffer:
default: false
description: Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled.
example: true
type: boolean
jitterbuffer_msec_max:
default: 200
description: The maximum jitter buffer size in milliseconds. Must be between 40 and 400. Has no effect if enable_jitter_buffer is not true.
example: 200
maximum: 400
minimum: 40
type: integer
jitterbuffer_msec_min:
default: 60
description: The minimum jitter buffer size in milliseconds. Must be between 40 and 400. Has no effect if enable_jitter_buffer is not true.
example: 60
maximum: 400
minimum: 40
type: integer
type: object
WebhookEventFailoverUrl:
default: ''
description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
example: https://failover.example.com
format: uri
title: Webhook Event Failover URL
type:
- string
- 'null'
ConnectionNoiseSuppressionDetails:
description: Configuration options for noise suppression. These settings are stored regardless of the noise_suppression value, but only take effect when noise_suppression is not 'disabled'. If you disable noise suppression and later re-enable it, the previously configured settings will be used.
properties:
attenuation_limit:
description: 'The attenuation limit value for the selected engine. Default values vary by engine: 0 for ''denoiser'', 80 for ''deep_filter_net'', ''deep_filter_net_large'', and all Krisp engines (''krisp_viva_tel'', ''krisp_viva_tel_lite'', ''krisp_viva_promodel'', ''krisp_viva_ss''), 100 for ''quail_voice_focus''.'
example: 80
maximum: 100
minimum: 0
multipleOf: 10
type: integer
engine:
default: denoiser
descri
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/openapi/telnyx-fqdn-connections-api-openapi.yml