Create Texml Application Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-create-texml-application-request-schema.json",
  "title": "Create Texml Application Request",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-texml-applications-api-openapi.yml#/components/schemas/CreateTexmlApplicationRequest",
  "properties": {
    "active": {
      "$ref": "#/$defs/ConnectionActive"
    },
    "anchorsite_override": {
      "$ref": "#/$defs/AnchorsiteOverride"
    },
    "call_cost_in_webhooks": {
      "default": false,
      "description": "Specifies if call cost webhooks should be sent for this TeXML Application.",
      "type": "boolean"
    },
    "dtmf_type": {
      "$ref": "#/$defs/DtmfType"
    },
    "first_command_timeout": {
      "$ref": "#/$defs/FirstCommandTimeout"
    },
    "first_command_timeout_secs": {
      "$ref": "#/$defs/FirstCommandTimeoutSecs"
    },
    "friendly_name": {
      "$ref": "#/$defs/ApplicationName"
    },
    "inbound": {
      "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"
        }
      },
      "type": "object"
    },
    "outbound": {
      "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": {
          "$ref": "#/$defs/OutboundVoiceProfileId"
        }
      },
      "type": "object"
    },
    "status_callback": {
      "default": null,
      "description": "URL for Telnyx to send requests to containing information about call progress events.",
      "format": "uri",
      "type": "string"
    },
    "status_callback_method": {
      "default": "post",
      "description": "HTTP request method Telnyx should use when requesting the status_callback URL.",
      "enum": [
        "get",
        "post"
      ],
      "type": "string"
    },
    "tags": {
      "description": "Tags associated with the Texml Application.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "voice_fallback_url": {
      "default": null,
      "description": "URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.",
      "format": "uri",
      "type": "string"
    },
    "voice_method": {
      "default": "post",
      "description": "HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.",
      "enum": [
        "get",
        "post"
      ],
      "type": "string"
    },
    "voice_url": {
      "description": "URL to which Telnyx will deliver your XML Translator webhooks.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "friendly_name",
    "voice_url"
  ],
  "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"
    },
    "ApplicationName": {
      "description": "A user-assigned name to help manage the application.",
      "title": "Application Name",
      "type": "string"
    },
    "ConnectionActive": {
      "default": true,
      "description": "Specifies whether the connection can be used.",
      "title": "Connection Active",
      "type": "boolean"
    },
    "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"
    },
    "FirstCommandTimeout": {
      "default": false,
      "description": "Specifies whether calls to phone numbers associated with this connection should hangup after timing out.",
      "title": "First Command Timeout",
      "type": "boolean"
    },
    "FirstCommandTimeoutSecs": {
      "default": 30,
      "description": "Specifies how many seconds to wait before timing out a dial command.",
      "title": "First Command Timeout Secs",
      "type": "integer"
    },
    "OutboundVoiceProfileId": {
      "description": "Identifies the associated outbound voice profile.",
      "title": "Outbound Voice Profile ID",
      "type": "string"
    }
  }
}