v53

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB

FQDN Connections

Update an FQDN connection

Updates settings of an existing FQDN connection.

patch/fqdn_connections/{id}

Path parameters

idstring required

Example:1293384261075731499

Identifies the resource.

Request body

activeboolean

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.

android_push_credential_idstring nullable

The uuid of the push credential for Android

call_cost_in_webhooksboolean

Specifies if call cost webhooks should be sent for this connection.

connection_namestring

A user-assigned name to help manage the connection.

default_on_hold_comfort_noise_enabledboolean

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.

dtmf_type'RFC 2833' | 'Inband' | 'SIP INFO'

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.

encode_contact_header_enabledboolean

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

encrypted_media'SRTP' | 'null' nullable

Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.

ios_push_credential_idstring nullable

The uuid of the push credential for Ios

noise_suppression'inbound' | 'outbound' | 'both' | 'disabled'

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.

onnet_t38_passthrough_enabledboolean

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.

tagsstring[]

Tags associated with the connection.

transport_protocol'UDP' | 'TCP' | 'TLS'

One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.

webhook_api_version'1' | '2'

Determines which webhook format will be used, Telnyx API v1 or v2.

webhook_event_failover_urlstring uri nullable

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

webhook_event_urlstring uri

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secsinteger nullable

Specifies how many seconds to wait before timing out a webhook.

Example request

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

Response

Successful response with details about an FQDN connection.

Example response

{
  "data": {
    "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
  }
}