Telnyx · Schema

Conference Gather Using Audio Request

CommunicationsCPaaSVoiceSMSIoTTelecommunicationsMessagingArtificial IntelligenceMCPVoice AIPhone NumbersInference

Properties

Name	Type	Description
audio_url	string	The URL of the audio file to play as the gather prompt. Must be WAV or MP3 format.
call_control_id	string	Unique identifier and token for controlling the call leg that will receive the gather prompt.
client_state	string	Use this field to add state to every subsequent webhook. Must be a valid Base-64 encoded string.
gather_id	string	Identifier for this gather command. Will be included in the gather ended webhook. Maximum 100 characters.
initial_timeout_millis	integer	Duration in milliseconds to wait for the first digit before timing out.
inter_digit_timeout_millis	integer	Duration in milliseconds to wait between digits.
invalid_audio_url	string	URL of audio file to play when invalid input is received.
invalid_media_name	string	Name of media file to play when invalid input is received.
maximum_digits	integer	Maximum number of digits to gather.
maximum_tries	integer	Maximum number of times to play the prompt if no input is received.
media_name	string	The name of the media file uploaded to the Media Storage API to play as the gather prompt.
minimum_digits	integer	Minimum number of digits to gather.
stop_playback_on_dtmf	boolean	Whether to stop the audio playback when a DTMF digit is received.
terminating_digit	string	Digit that terminates gathering.
timeout_millis	integer	Duration in milliseconds to wait for input before timing out.
valid_digits	string	Digits that are valid for gathering. All other digits will be ignored.

View JSON Schema on GitHub

JSON Schema

{
  "$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"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/telnyx-conference-gather-using-audio-request"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.