{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-conference-gather-using-audio-request-schema.json",
  "title": "Conference Gather Using Audio Request",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-conference-commands-api-openapi.yml#/components/schemas/ConferenceGatherUsingAudioRequest",
  "properties": {
    "audio_url": {
      "description": "The URL of the audio file to play as the gather prompt. Must be WAV or MP3 format.",
      "type": "string"
    },
    "call_control_id": {
      "description": "Unique identifier and token for controlling the call leg that will receive the gather prompt.",
      "type": "string"
    },
    "client_state": {
      "description": "Use this field to add state to every subsequent webhook. Must be a valid Base-64 encoded string.",
      "type": "string"
    },
    "gather_id": {
      "description": "Identifier for this gather command. Will be included in the gather ended webhook. Maximum 100 characters.",
      "maxLength": 100,
      "type": "string"
    },
    "initial_timeout_millis": {
      "description": "Duration in milliseconds to wait for the first digit before timing out.",
      "type": "integer"
    },
    "inter_digit_timeout_millis": {
      "default": 5000,
      "description": "Duration in milliseconds to wait between digits.",
      "type": "integer"
    },
    "invalid_audio_url": {
      "description": "URL of audio file to play when invalid input is received.",
      "type": "string"
    },
    "invalid_media_name": {
      "description": "Name of media file to play when invalid input is received.",
      "type": "string"
    },
    "maximum_digits": {
      "default": 128,
      "description": "Maximum number of digits to gather.",
      "minimum": 1,
      "type": "integer"
    },
    "maximum_tries": {
      "default": 3,
      "description": "Maximum number of times to play the prompt if no input is received.",
      "minimum": 1,
      "type": "integer"
    },
    "media_name": {
      "description": "The name of the media file uploaded to the Media Storage API to play as the gather prompt.",
      "type": "string"
    },
    "minimum_digits": {
      "default": 1,
      "description": "Minimum number of digits to gather.",
      "minimum": 1,
      "type": "integer"
    },
    "stop_playback_on_dtmf": {
      "default": true,
      "description": "Whether to stop the audio playback when a DTMF digit is received.",
      "type": "boolean"
    },
    "terminating_digit": {
      "default": "#",
      "description": "Digit that terminates gathering.",
      "type": "string"
    },
    "timeout_millis": {
      "default": 60000,
      "description": "Duration in milliseconds to wait for input before timing out.",
      "type": "integer"
    },
    "valid_digits": {
      "default": "0123456789#*",
      "description": "Digits that are valid for gathering. All other digits will be ignored.",
      "type": "string"
    }
  },
  "required": [
    "call_control_id"
  ],
  "type": "object"
}