Initiate AI Call Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-initiate-aicall-request-schema.json",
  "title": "Initiate AI Call Request",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-texml-rest-commands-api-openapi.yml#/components/schemas/InitiateAICallRequest",
  "properties": {
    "AIAssistantDynamicVariables": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Key-value map of dynamic variables to pass to the AI assistant.",
      "type": "object"
    },
    "AIAssistantId": {
      "description": "The ID of the AI assistant to use for the call.",
      "type": "string"
    },
    "AIAssistantVersion": {
      "description": "The version of the AI assistant to use.",
      "type": "string"
    },
    "AsyncAmd": {
      "default": false,
      "description": "Select whether to perform answering machine detection in the background. By default execution is blocked until Answering Machine Detection is completed.",
      "type": "boolean"
    },
    "AsyncAmdStatusCallback": {
      "description": "URL destination for Telnyx to send AMD callback events to for the call.",
      "type": "string"
    },
    "AsyncAmdStatusCallbackMethod": {
      "default": "POST",
      "description": "HTTP request type used for `AsyncAmdStatusCallback`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "CallerId": {
      "description": "To be used as the caller id name (SIP From Display Name) presented to the destination (`To` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and `-_~!.+` special characters. If omitted, the display name will be the same as the number in the `From` field.",
      "type": "string"
    },
    "ConversationCallback": {
      "description": "URL destination for Telnyx to send conversation callback events to.",
      "type": "string"
    },
    "ConversationCallbackMethod": {
      "default": "POST",
      "description": "HTTP request type used for `ConversationCallback`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "ConversationCallbacks": {
      "description": "An array of URL destinations for conversation callback events.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "CustomHeaders": {
      "description": "Custom HTTP headers to be sent with the call. Each header should be an object with 'name' and 'value' properties.",
      "items": {
        "properties": {
          "name": {
            "description": "The name of the custom header",
            "type": "string"
          },
          "value": {
            "description": "The value of the custom header",
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "DetectionMode": {
      "default": "Regular",
      "description": "Allows you to choose between Premium and Standard detections.",
      "enum": [
        "Premium",
        "Regular"
      ],
      "type": "string"
    },
    "From": {
      "description": "The phone number of the party initiating the call. Phone numbers are formatted with a `+` and country code.",
      "type": "string"
    },
    "MachineDetection": {
      "default": "Disable",
      "description": "Enables Answering Machine Detection.",
      "enum": [
        "Enable",
        "Disable",
        "DetectMessageEnd"
      ],
      "type": "string"
    },
    "MachineDetectionSilenceTimeout": {
      "default": 3500,
      "description": "If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used.",
      "type": "integer"
    },
    "MachineDetectionSpeechEndThreshold": {
      "default": 800,
      "description": "Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used.",
      "type": "integer"
    },
    "MachineDetectionSpeechThreshold": {
      "default": 3500,
      "description": "Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used.",
      "type": "integer"
    },
    "MachineDetectionTimeout": {
      "default": 30000,
      "description": "Maximum timeout threshold in milliseconds for overall detection.",
      "maximum": 60000,
      "minimum": 500,
      "type": "integer"
    },
    "Passports": {
      "description": "A string of passport identifiers to associate with the call.",
      "type": "string"
    },
    "PreferredCodecs": {
      "description": "The list of comma-separated codecs to be offered on a call.",
      "type": "string"
    },
    "Record": {
      "description": "Whether to record the entire participant's call leg. Defaults to `false`.",
      "type": "boolean"
    },
    "RecordingChannels": {
      "description": "The number of channels in the final recording. Defaults to `mono`.",
      "enum": [
        "mono",
        "dual"
      ],
      "type": "string"
    },
    "RecordingStatusCallback": {
      "description": "The URL the recording callbacks will be sent to.",
      "type": "string"
    },
    "RecordingStatusCallbackEvent": {
      "description": "The changes to the recording's state that should generate a call to `RecordingStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.",
      "type": "string"
    },
    "RecordingStatusCallbackMethod": {
      "description": "HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "RecordingTimeout": {
      "default": 0,
      "description": "The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. The minimum value is 0. The default value is 0 (infinite).",
      "type": "integer"
    },
    "RecordingTrack": {
      "description": "The audio track to record for the call. The default is `both`.",
      "enum": [
        "inbound",
        "outbound",
        "both"
      ],
      "type": "string"
    },
    "SendRecordingUrl": {
      "$ref": "#/$defs/SendRecordingUrl"
    },
    "SipAuthPassword": {
      "description": "The password to use for SIP authentication.",
      "type": "string"
    },
    "SipAuthUsername": {
      "description": "The username to use for SIP authentication.",
      "type": "string"
    },
    "SipRegion": {
      "default": "US",
      "description": "Defines the SIP region to be used for the call.",
      "enum": [
        "US",
        "Europe",
        "Canada",
        "Australia",
        "Middle East"
      ],
      "type": "string"
    },
    "StatusCallback": {
      "description": "URL destination for Telnyx to send status callback events to for the call.",
      "type": "string"
    },
    "StatusCallbackEvent": {
      "default": "completed",
      "description": "The call events for which Telnyx should send a webhook. Multiple events can be defined when separated by a space. Valid values: initiated, ringing, answered, completed.",
      "type": "string"
    },
    "StatusCallbackMethod": {
      "default": "POST",
      "description": "HTTP request type used for `StatusCallback`.",
      "enum": [
        "GET",
        "POST"
      ],
      "type": "string"
    },
    "StatusCallbacks": {
      "description": "An array of URL destinations for Telnyx to send status callback events to for the call.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "TimeLimit": {
      "default": 14400,
      "description": "The maximum duration of the call in seconds. The minimum value is 30 and the maximum value is 14400 (4 hours). Default is 14400 seconds.",
      "maximum": 14400,
      "minimum": 30,
      "type": "integer"
    },
    "Timeout": {
      "default": 30,
      "description": "The number of seconds to wait for the called party to answer the call before the call is canceled. The minimum value is 5 and the maximum value is 120. Default is 30 seconds.",
      "maximum": 120,
      "minimum": 5,
      "type": "integer",
      "x-stainless-param": "timeout_seconds"
    },
    "To": {
      "description": "The phone number of the called party. Phone numbers are formatted with a `+` and country code.",
      "type": "string"
    },
    "Trim": {
      "description": "Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`.",
      "enum": [
        "trim-silence",
        "do-not-trim"
      ],
      "type": "string"
    }
  },
  "required": [
    "From",
    "To",
    "AIAssistantId"
  ],
  "type": "object",
  "$defs": {
    "SendRecordingUrl": {
      "default": true,
      "description": "Whether to send RecordingUrl in webhooks.",
      "type": "boolean"
    }
  }
}