Create External Connection Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-create-external-connection-request-schema.json",
  "title": "Create External Connection Request",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-external-connections-api-openapi.yml#/components/schemas/CreateExternalConnectionRequest",
  "properties": {
    "active": {
      "$ref": "#/$defs/ConnectionActive"
    },
    "external_sip_connection": {
      "$ref": "#/$defs/ExternalSipConnectionZoomOnly"
    },
    "inbound": {
      "properties": {
        "channel_limit": {
          "default": null,
          "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.",
          "type": "integer"
        },
        "outbound_voice_profile_id": {
          "description": "The ID of the outbound voice profile to use for inbound calls.",
          "type": "string"
        }
      },
      "required": [
        "outbound_voice_profile_id"
      ],
      "type": "object"
    },
    "outbound": {
      "properties": {
        "channel_limit": {
          "default": null,
          "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.",
          "type": "integer"
        },
        "outbound_voice_profile_id": {
          "$ref": "#/$defs/external-voice-integrations_OutboundVoiceProfileId"
        }
      },
      "type": "object"
    },
    "tags": {
      "description": "Tags associated with the connection.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "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": "uri",
      "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": "uri",
      "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": [
    "external_sip_connection",
    "outbound"
  ],
  "type": "object",
  "$defs": {
    "ConnectionActive": {
      "default": true,
      "description": "Specifies whether the connection can be used.",
      "title": "Connection Active",
      "type": "boolean"
    },
    "ExternalSipConnectionZoomOnly": {
      "default": "zoom",
      "description": "The service that will be consuming this connection.",
      "enum": [
        "zoom"
      ],
      "title": "External SIP Connection",
      "type": "string"
    },
    "external-voice-integrations_OutboundVoiceProfileId": {
      "description": "Identifies the associated outbound voice profile.",
      "title": "Outbound Voice Profile ID",
      "type": "string",
      "x-format": "int64"
    }
  }
}