Create Call Control Application Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-create-call-control-application-request-schema.json",
  "title": "Create Call Control Application Request",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-call-control-applications-api-openapi.yml#/components/schemas/CreateCallControlApplicationRequest",
  "properties": {
    "active": {
      "default": true,
      "description": "Specifies whether the connection can be used.",
      "type": "boolean"
    },
    "anchorsite_override": {
      "default": "Latency",
      "description": "<code>Latency</code> 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.\n",
      "enum": [
        "Latency",
        "Chicago, IL",
        "Ashburn, VA",
        "San Jose, CA",
        "London, UK",
        "Chennai, IN",
        "Amsterdam, Netherlands",
        "Toronto, Canada",
        "Sydney, Australia"
      ],
      "type": "string"
    },
    "application_name": {
      "description": "A user-assigned name to help manage the application.",
      "type": "string"
    },
    "call_cost_in_webhooks": {
      "default": false,
      "description": "Specifies if call cost webhooks should be sent for this Call Control Application.",
      "type": "boolean"
    },
    "dtmf_type": {
      "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"
      ],
      "type": "string"
    },
    "first_command_timeout": {
      "default": false,
      "description": "Specifies whether calls to phone numbers associated with this connection should hangup after timing out.",
      "type": "boolean"
    },
    "first_command_timeout_secs": {
      "default": 30,
      "description": "Specifies how many seconds to wait before timing out a dial command.",
      "type": "integer"
    },
    "inbound": {
      "$ref": "#/$defs/CallControlApplicationInbound"
    },
    "outbound": {
      "$ref": "#/$defs/CallControlApplicationOutbound"
    },
    "redact_dtmf_debug_logging": {
      "default": false,
      "description": "When enabled, DTMF digits entered by users will be redacted in debug logs to protect PII data entered through IVR interactions.",
      "type": "boolean"
    },
    "webhook_api_version": {
      "default": "1",
      "description": "Determines which webhook format will be used, Telnyx API v1 or v2.",
      "enum": [
        "1",
        "2"
      ],
      "type": "string"
    },
    "webhook_event_failover_url": {
      "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": "url",
      "type": [
        "string",
        "null"
      ]
    },
    "webhook_event_url": {
      "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.",
      "format": "url",
      "type": "string"
    },
    "webhook_timeout_secs": {
      "default": null,
      "description": "Specifies how many seconds to wait before timing out a webhook.",
      "maximum": 30,
      "minimum": 0,
      "type": [
        "integer",
        "null"
      ]
    }
  },
  "required": [
    "application_name",
    "webhook_event_url"
  ],
  "type": "object",
  "$defs": {
    "CallControlApplicationInbound": {
      "properties": {
        "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"
        },
        "shaken_stir_enabled": {
          "default": false,
          "description": "When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.",
          "type": "boolean"
        },
        "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"
        },
        "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"
        }
      },
      "title": "Call Control Application Inbound",
      "type": "object"
    },
    "CallControlApplicationOutbound": {
      "properties": {
        "channel_limit": {
          "default": null,
          "description": "When set, this will limit the total number of outbound calls to phone numbers associated with this connection.",
          "type": "integer"
        },
        "outbound_voice_profile_id": {
          "description": "Identifies the associated outbound voice profile.",
          "type": "string",
          "x-format": "int64"
        }
      },
      "title": "Call Control Application Outbound",
      "type": "object"
    }
  }
}