Telnyx Conference Commands API

openapi: 3.2.0
info:
  contact:
    email: support@telnyx.com
  description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform.
  title: Telnyx Conference Commands API
  version: 2.0.0
  x-endpoint-cost: light
servers:
- description: Version 2.0.0 of the Telnyx API
  url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: Conference command operations
  name: Conference Commands
paths:
  /conferences:
    get:
      description: Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by `expires_at`.
      operationId: ListConferences
      parameters:
      - $ref: '#/components/parameters/ConferenceRegion'
      - $ref: '#/components/parameters/call-control_FilterConsolidated'
      - $ref: '#/components/parameters/call-control_PageConsolidated'
      responses:
        '200':
          $ref: '#/components/responses/ListConferencesResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: List conferences
      tags:
      - Conference Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
    post:
      description: 'Create a conference from an existing call leg using a `call_control_id` and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.


        **Expected Webhooks:**


        - `conference.created`

        - `conference.participant.joined`

        - `conference.participant.left`

        - `conference.ended`

        - `conference.recording.saved`

        - `conference.floor.changed`

        '
      operationId: CreateConference
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConferenceRequest'
        description: Create a conference
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Create conference
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{conference_id}/participants:
    get:
      description: Lists conference participants
      operationId: ListConferenceParticipants
      parameters:
      - description: Uniquely identifies the conference by id
        in: path
        name: conference_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ConferenceRegion'
      - $ref: '#/components/parameters/call-control_PageConsolidated'
      - description: 'Consolidated filter parameter (deepObject style). Originally: filter[muted], filter[on_hold], filter[whispering]'
        explode: true
        in: query
        name: filter
        schema:
          properties:
            muted:
              description: If present, participants will be filtered to those who are/are not muted
              type: boolean
            on_hold:
              description: If present, participants will be filtered to those who are/are not put on hold
              type: boolean
            whispering:
              description: If present, participants will be filtered to those who are whispering or are not
              type: boolean
          type: object
        style: deepObject
      responses:
        '200':
          $ref: '#/components/responses/ListParticipantsResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: List conference participants
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}:
    get:
      description: Retrieve an existing conference
      operationId: RetrieveConference
      parameters:
      - description: Uniquely identifies the conference by id
        in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ConferenceRegion'
      responses:
        '200':
          $ref: '#/components/responses/ConferenceResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
      summary: Retrieve a conference
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/end:
    post:
      description: End a conference and terminate all active participants.
      operationId: EndConference
      parameters:
      - description: Uniquely identifies the conference.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndConferenceRequest'
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: End a conference
      tags:
      - Conference Commands
      x-endpoint-cost: 0.01
      x-latency-category: interactive
  /conferences/{id}/actions/gather_using_audio:
    post:
      description: Play an audio file to a specific conference participant and gather DTMF input.
      operationId: ConferenceGatherUsingAudio
      parameters:
      - description: Uniquely identifies the conference.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceGatherUsingAudioRequest'
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Gather DTMF using audio prompt in a conference
      tags:
      - Conference Commands
      x-endpoint-cost: 0.01
      x-latency-category: interactive
  /conferences/{id}/actions/hold:
    post:
      description: Hold a list of participants in a conference call
      operationId: HoldConferenceParticipants
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceHoldRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Hold conference participants
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/join:
    post:
      description: "Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the `call_control_id` of the leg you wish to join to the conference as an attribute. The conference can have up to a certain amount of active participants, as set by the `max_participants` parameter in conference creation request. \n\n**Expected Webhooks:**\n\n- `conference.participant.joined`\n- `conference.participant.left`\n"
      operationId: JoinConference
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JoinConferenceRequest'
        description: Join Conference request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Join a conference
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/leave:
    post:
      description: "Removes a call leg from a conference and moves it back to parked state. \n\n**Expected Webhooks:**\n\n- `conference.participant.left`\n"
      operationId: LeaveConference
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeaveConferenceRequest'
        description: Leave Conference request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Leave a conference
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/mute:
    post:
      description: Mute a list of participants in a conference call
      operationId: MuteConferenceParticipants
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceMuteRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Mute conference participants
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/play:
    post:
      description: Play audio to all or some participants on a conference call.
      operationId: PlayConferenceAudio
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferencePlayRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Play audio to conference participants
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/record_pause:
    post:
      description: Pause conference recording.
      operationId: PauseConferenceRecording
      parameters:
      - description: Specifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PauseConferenceRecordingRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Conference recording pause
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/record_resume:
    post:
      description: Resume conference recording.
      operationId: ResumeConferenceRecording
      parameters:
      - description: Specifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResumeConferenceRecordingRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Conference recording resume
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/record_start:
    post:
      description: 'Start recording the conference. Recording will stop on conference end, or via the Stop Recording command.


        **Expected Webhooks:**


        - `conference.recording.saved`'
      operationId: StartConferenceRecording
      parameters:
      - description: Specifies the conference to record by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartConferenceRecordingRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Conference recording start
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/record_stop:
    post:
      description: 'Stop recording the conference.


        **Expected Webhooks:**


        - `conference.recording.saved`

        '
      operationId: StopConferenceRecording
      parameters:
      - description: Specifies the conference to stop the recording for by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopRecordingConferenceRequest'
        description: Stop recording conference request
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Conference recording stop
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/send_dtmf:
    post:
      description: Send DTMF tones to one or more conference participants.
      operationId: ConferenceSendDTMF
      parameters:
      - description: Uniquely identifies the conference.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceSendDTMFRequest'
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Send DTMF to conference participants
      tags:
      - Conference Commands
      x-endpoint-cost: 0.01
      x-latency-category: interactive
  /conferences/{id}/actions/speak:
    post:
      description: Convert text to speech and play it to all or some participants.
      operationId: SpeakTextToConference
      parameters:
      - description: Specifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceSpeakRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Speak text to conference participants
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/stop:
    post:
      description: Stop audio being played to all or some participants on a conference call.
      operationId: StopConferenceAudio
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceStopRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Stop audio being played on the conference
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/unhold:
    post:
      description: Unhold a list of participants in a conference call
      operationId: UnholdConferenceParticipants
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceUnholdRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Unhold conference participants
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/unmute:
    post:
      description: Unmute a list of participants in a conference call
      operationId: UnmuteConferenceParticipants
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConferenceUnmuteRequest'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Unmute conference participants
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/actions/update:
    post:
      description: Update conference participant supervisor_role
      operationId: UpdateConference
      parameters:
      - description: Uniquely identifies the conference by id or name
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConferenceRequest'
        description: Update Conference request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/ConferenceCommandResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Update conference participant
      tags:
      - Conference Commands
      x-latency-category: interactive
  /conferences/{id}/participants/{participant_id}:
    get:
      description: Retrieve details of a specific conference participant by their ID or label.
      operationId: RetrieveConferenceParticipant
      parameters:
      - description: Uniquely identifies the conference.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      - description: Uniquely identifies the participant by their ID or label.
        in: path
        name: participant_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceParticipantResource'
          description: Successful response
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Retrieve a conference participant
      tags:
      - Conference Commands
      x-endpoint-cost: 0.01
      x-latency-category: interactive
    patch:
      description: Update properties of a conference participant.
      operationId: UpdateConferenceParticipant
      parameters:
      - description: Uniquely identifies the conference.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      - description: Uniquely identifies the participant.
        in: path
        name: participant_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConferenceParticipantRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceParticipantResource'
          description: Successful response
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '422':
          $ref: '#/components/responses/UnprocessableEntityResponse'
      summary: Update a conference participant
      tags:
      - Conference Commands
      x-endpoint-cost: 0.01
      x-latency-category: interactive
components:
  schemas:
    RimeVoiceSettings:
      properties:
        type:
          description: Voice settings provider type
          enum:
          - rime
          type: string
        voice_speed:
          default: 1.0
          description: Speech speed multiplier. Default is 1.0.
          example: 1.0
          format: float
          type: number
      required:
      - type
      title: Rime Voice Settings
      type: object
    LeaveConferenceRequest:
      example:
        beep_enabled: never
        call_control_id: c46e06d7-b78f-4b13-96b6-c576af9640ff
      properties:
        beep_enabled:
          description: Whether a beep sound should be played when the participant leaves the conference. Can be used to override the conference-level setting.
          enum:
          - always
          - never
          - on_enter
          - on_exit
          example: on_exit
          type: string
        call_control_id:
          description: Unique identifier and token for controlling the call
          example: f91269aa-61d1-417f-97b3-10e020e8bc47
          type: string
        command_id:
          description: Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        region:
          $ref: '#/components/schemas/ConferenceRegion'
      required:
      - call_control_id
      title: Leave Conference Request
      type: object
    ResumeConferenceRecordingRequest:
      properties:
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        recording_id:
          description: Use this field to resume specific recording.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        region:
          $ref: '#/components/schemas/ConferenceRegion'
      title: Pause Recording Request
      type: object
    ConferenceUnmuteRequest:
      example:
        call_control_ids:
        - v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
      properties:
        call_control_ids:
          description: List of unique identifiers and tokens for controlling the call. Enter each call control ID to be unmuted. When empty all participants will be unmuted.
          items:
            type: string
          type: array
        region:
          $ref: '#/components/schemas/ConferenceRegion'
      title: Conference Unmute Request
      type: object
    AzureVoiceSettings:
      properties:
        api_key_ref:
          description: The `identifier` for an integration secret that refers to your Azure Speech API key.
          example: my_azure_api_key
          type: string
        deployment_id:
          description: The deployment ID for a custom Azure neural voice.
          example: my-custom-voice-deployment
          type: string
        effect:
          description: Audio effect to apply.
          enum:
          - eq_car
          - eq_telecomhp8k
          type: string
        gender:
          description: Voice gender filter.
          enum:
          - Male
          - Female
          type: string
        region:
          description: The Azure region for the Speech service (e.g., `eastus`, `westeurope`). Required when using a custom API key.
          example: eastus
          type: string
        type:
          description: Voice settings provider type
          enum:
          - azure
          type: string
      required:
      - type
      title: Azure Voice Settings
      type: object
    call-control_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/call-control_Error'
          type: array
    ConferenceUnholdRequest:
      example:
        call_control_ids:
        - v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
      properties:
        call_control_ids:
          description: List of unique identifiers and tokens for controlling the call. Enter each call control ID to be unheld.
          items:
            type: string
          type: array
        region:
          $ref: '#/components/schemas/ConferenceRegion'
      required:
      - call_control_ids
      title: Conference Unhold Request
      type: object
    ConferenceGatherUsingAudioRequest:
      example:
        audio_url: http://example.com/gather_prompt.wav
        call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
        maximum_digits: 4
        minimum_digits: 1
        timeout_millis: 30000
      properties:
        audio_url:
          description: The URL of the audio file to play as the gather prompt. Must be WAV or MP3 format.
          example: http://example.com/gather_prompt.wav
          type: string
        call_control_id:
          description: Unique identifier and token for controlling the call leg that will receive the gather prompt.
          example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. Must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          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.
          example: 10000
          type: integer
        inter_digit_timeout_millis:
          default: 5000
          description: Duration in milliseconds to wait between digits.
          example: 3000
          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.
          example: 10
          minimum: 1
          type: integer
        maximum_tries:
          default: 3
          description: Maximum number of times to play the prompt if no input is received.
          example: 3
          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.
          example: 1
          minimum: 1
          type: integer
        stop_playback_on_dtmf:
          default: true
          description: Whether to stop the audio playback when a DTMF digit is received.
          example: true
          type: boolean
        terminating_digit:
          default: '#'
          description: Digit that terminates gathering.
          example: '#'
          type: string
        timeout_millis:
          default: 60000
          description: Duration in milliseconds to wait for input before timing out.
          example: 30000
          type: integer
        valid_digits:
          default: 0123456789#*
          description: Digits that are valid for gathering. All other digits will be ignored.
          example: 0123456789
          type: string
      required:
    

# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/openapi/telnyx-conference-commands-api-openapi.yml