Update FQDN Connection Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-update-fqdn-connection-request-schema.json",
  "title": "Update FQDN Connection Request",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-fqdn-connections-api-openapi.yml#/components/schemas/UpdateFqdnConnectionRequest",
  "properties": {
    "active": {
      "description": "Defaults to true",
      "type": "boolean"
    },
    "anchorsite_override": {
      "$ref": "#/$defs/AnchorsiteOverride"
    },
    "android_push_credential_id": {
      "$ref": "#/$defs/ConnectionAndroidPushCredentialId"
    },
    "call_cost_in_webhooks": {
      "default": false,
      "description": "Specifies if call cost webhooks should be sent for this connection.",
      "type": "boolean"
    },
    "connection_name": {
      "$ref": "#/$defs/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": "#/$defs/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": "#/$defs/EncryptedMedia"
    },
    "inbound": {
      "$ref": "#/$defs/InboundFqdn"
    },
    "ios_push_credential_id": {
      "$ref": "#/$defs/ConnectionIosPushCredentialId"
    },
    "jitter_buffer": {
      "$ref": "#/$defs/ConnectionJitterBuffer"
    },
    "noise_suppression": {
      "$ref": "#/$defs/ConnectionNoiseSuppression"
    },
    "noise_suppression_details": {
      "$ref": "#/$defs/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": "#/$defs/OutboundFqdn"
    },
    "rtcp_settings": {
      "$ref": "#/$defs/ConnectionRtcpSettings"
    },
    "tags": {
      "description": "Tags associated with the connection.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "transport_protocol": {
      "$ref": "#/$defs/FqdnConnectionTransportProtocol"
    },
    "webhook_api_version": {
      "$ref": "#/$defs/WebhookApiVersion"
    },
    "webhook_event_failover_url": {
      "$ref": "#/$defs/WebhookEventFailoverUrl"
    },
    "webhook_event_url": {
      "$ref": "#/$defs/WebhookEventUrl"
    },
    "webhook_timeout_secs": {
      "$ref": "#/$defs/WebhookTimeoutSecs"
    }
  },
  "type": "object",
  "$defs": {
    "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"
      ],
      "title": "Anchorsite Override",
      "type": "string"
    },
    "ConnectionAndroidPushCredentialId": {
      "default": null,
      "description": "The uuid of the push credential for Android",
      "title": "Android Push Credential Id",
      "type": [
        "string",
        "null"
      ]
    },
    "ConnectionIosPushCredentialId": {
      "default": null,
      "description": "The uuid of the push credential for Ios",
      "title": "Ios Push Credential Id",
      "type": [
        "string",
        "null"
      ]
    },
    "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.",
          "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.",
          "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.",
          "maximum": 400,
          "minimum": 40,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "ConnectionName": {
      "description": "A user-assigned name to help manage the connection.",
      "title": "Connection Name",
      "type": "string"
    },
    "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"
      ],
      "type": "string"
    },
    "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'.",
          "maximum": 100,
          "minimum": 0,
          "multipleOf": 10,
          "type": "integer"
        },
        "engine": {
          "default": "denoiser",
          "description": "The noise suppression engine to use. 'denoiser' is the default engine. 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with different performance characteristics. Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced noise suppression capabilities. 'quail_voice_focus' provides Quail-based voice focus noise suppression.",
          "enum": [
            "denoiser",
            "deep_filter_net",
            "deep_filter_net_large",
            "krisp_viva_tel",
            "krisp_viva_tel_lite",
            "krisp_viva_promodel",
            "krisp_viva_ss",
            "quail_voice_focus"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "ConnectionRtcpSettings": {
      "properties": {
        "capture_enabled": {
          "default": false,
          "description": "BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal.",
          "type": "boolean"
        },
        "port": {
          "default": "rtp+1",
          "description": "RTCP port by default is rtp+1, it can also be set to rtcp-mux",
          "enum": [
            "rtcp-mux",
            "rtp+1"
          ],
          "type": "string"
        },
        "report_frequency_secs": {
          "default": 5,
          "description": "RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds.",
          "type": "integer"
        }
      },
      "title": "Connection RTCP Settings",
      "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"
      ],
      "title": "DTMF Type",
      "type": "string"
    },
    "EncryptedMedia": {
      "description": "Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.",
      "enum": [
        "SRTP",
        null
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "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"
    },
    "InboundFqdn": {
      "properties": {
        "ani_number_format": {
          "default": "E.164-national",
          "description": "This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.",
          "enum": [
            "+E.164",
            "E.164",
            "+E.164-national",
            "E.164-national"
          ],
          "type": "string"
        },
        "channel_limit": {
          "default": null,
          "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection.",
          "type": [
            "integer",
            "null"
          ]
        },
        "codecs": {
          "default": [
            "G722",
            "G711U",
            "G711A",
            "G729",
            "OPUS",
            "H.264"
          ],
          "description": "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "default_primary_fqdn_id": {
          "default": null,
          "description": "The default primary FQDN to use for the number. Only settable if the connection is\nof FQDN type. Value must be the ID of an FQDN set on the connection.",
          "type": [
            "string",
            "null"
          ],
          "x-format": "int64"
        },
        "default_routing_method": {
          "default": "sequential",
          "description": "Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or null, other values are not allowed.",
          "enum": [
            "sequential",
            "round-robin",
            null
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "default_secondary_fqdn_id": {
          "default": null,
          "description": "The default secondary FQDN to use for the number. Only settable if the connection is\nof FQDN type. Value must be the ID of an FQDN set on the connection.",
          "type": [
            "string",
            "null"
          ],
          "x-format": "int64"
        },
        "default_tertiary_fqdn_id": {
          "default": null,
          "description": "The default tertiary FQDN to use for the number. Only settable if the connection is\nof FQDN type. Value must be the ID of an FQDN set on the connection.",
          "type": [
            "string",
            "null"
          ],
          "x-format": "int64"
        },
        "dnis_number_format": {
          "default": "e164",
          "enum": [
            "+e164",
            "e164",
            "national",
            "sip_username"
          ],
          "type": "string"
        },
        "generate_ringback_tone": {
          "default": false,
          "description": "Generate ringback tone through 183 session progress message with early media.",
          "type": "boolean"
        },
        "isup_headers_enabled": {
          "default": false,
          "description": "When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)",
          "type": "boolean"
        },
        "prack_enabled": {
          "default": false,
          "description": "Enable PRACK messages as defined in RFC3262.",
          "type": "boolean"
        },
        "shaken_stir_enabled": {
          "default": false,
          "description": "When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.",
          "type": "boolean"
        },
        "sip_compact_headers_enabled": {
          "default": true,
          "description": "Defaults to true.",
          "type": "boolean"
        },
        "sip_region": {
          "default": "US",
          "description": "Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used.",
          "enum": [
            "US",
            "Europe",
            "Australia"
          ],
          "type": "string"
        },
        "sip_subdomain": {
          "default": null,
          "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.",
          "type": [
            "string",
            "null"
          ]
        },
        "sip_subdomain_receive_settings": {
          "default": "from_anyone",
          "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).",
          "enum": [
            "only_my_connections",
            "from_anyone"
          ],
          "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": "Inbound FQDN",
      "type": "object"
    },
    "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"
          ],
          "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": "#/$defs/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"
          ],
          "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.\",",
          "type": "string"
        },
        "outbound_voice_profile_id": {
          "$ref": "#/$defs/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"
    },
    "WebhookApiVersion": {
      "default": "1",
      "description": "Determines which webhook format will be used, Telnyx API v1 or v2.",
      "enum": [
        "1",
        "2"
      ],
      "title": "Webhook API Version",
      "type": "string"
    },
    "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'.",
      "format": "uri",
      "title": "Webhook Event Failover URL",
      "type": [
        "string",
        "null"
      ]
    },
    "WebhookEventUrl": {
      "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.",
      "format": "uri",
      "title": "Webhook Event URL",
      "type": "string"
    },
    "WebhookTimeoutSecs": {
      "default": null,
      "description": "Specifies how many seconds to wait before timing out a webhook.",
      "maximum": 30,
      "minimum": 0,
      "title": "Webhook Timeout Secs",
      "type": [
        "integer",
        "null"
      ]
    },
    "connections_OutboundVoiceProfileId": {
      "description": "Identifies the associated outbound voice profile.",
      "title": "Outbound Voice Profile ID",
      "type": "string",
      "x-format": "int64"
    }
  }
}