Create an FQDN connection
Creates a FQDN connection.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Parameters that can be defined during FQDN connection creation
A user-assigned name to help manage the connection.
"office-connection"
Defaults to true
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.
Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany "Amsterdam, Netherlands"
One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.
UDP, TCP, TLS 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.
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.
RFC 2833, Inband, SIP INFO "Inband"
Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.
SRTP, "SRTP"
When enabled, the connection will be created for Microsoft Teams Direct Routing. A *.mstsbc.telnyx.tech FQDN will be created for the connection automatically.
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.
Tags associated with the connection.
["tag1", "tag2"]The uuid of the push credential for Ios
"ec0c8e5d-439e-4620-a0c1-9d9c8d02a836"
The uuid of the push credential for Android
"06b09dfd-7154-4980-8b75-cebf7a9d4f8e"
The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
"https://example.com"
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'.
"https://failover.example.com"
Determines which webhook format will be used, Telnyx API v1 or v2.
1, 2 "1"
Specifies if call cost webhooks should be sent for this connection.
Specifies how many seconds to wait before timing out a webhook.
0 <= x <= 3025
{
"port": "rtcp-mux",
"capture_enabled": true,
"report_frequency_secs": 10
}{
"ani_number_format": "+E.164",
"dnis_number_format": "+e164",
"codecs": ["G722"],
"default_routing_method": "sequential",
"default_primary_fqdn_id": "1293384261075731497",
"default_secondary_fqdn_id": "1293384261075731498",
"default_tertiary_fqdn_id": "1293384261075731499",
"channel_limit": 10,
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "test",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 20,
"shaken_stir_enabled": true
}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.
inbound, outbound, both, disabled "both"
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.
Response
Successful response with details about an FQDN connection.
{
"id": "1293384261075731499",
"record_type": "fqdn_connection",
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"transport_protocol": "UDP",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"onnet_t38_passthrough_enabled": true,
"ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836",
"android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e",
"webhook_event_url": "https://example.com",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_api_version": "1",
"webhook_timeout_secs": 25,
"call_cost_in_webhooks": false,
"tags": ["tag1", "tag2"],
"rtcp_settings": {
"port": "rtcp-mux",
"capture_enabled": true,
"report_frequency_secs": 10
},
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z",
"inbound": {
"ani_number_format": "+E.164",
"dnis_number_format": "+e164",
"codecs": ["G722"],
"default_routing_method": "sequential",
"channel_limit": 10,
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_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,
"shaken_stir_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"
},
"noise_suppression": "both",
"noise_suppression_details": {
"engine": "deep_filter_net",
"attenuation_limit": 80
}
}