Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Conference Commands

Gather DTMF using audio prompt in a conference

Play an audio file to a specific conference participant and gather DTMF input.

post/conferences/{id}/actions/gather_using_audio

Path parameters

idstring uuid required

Uniquely identifies the conference.

Request body

audio_urlstring

The URL of the audio file to play as the gather prompt. Must be WAV or MP3 format.

call_control_idstring required

Unique identifier and token for controlling the call leg that will receive the gather prompt.

client_statestring

Use this field to add state to every subsequent webhook. Must be a valid Base-64 encoded string.

gather_idstring

Identifier for this gather command. Will be included in the gather ended webhook. Maximum 100 characters.

initial_timeout_millisinteger

Duration in milliseconds to wait for the first digit before timing out.

inter_digit_timeout_millisinteger

Duration in milliseconds to wait between digits.

invalid_audio_urlstring

URL of audio file to play when invalid input is received.

invalid_media_namestring

Name of media file to play when invalid input is received.

maximum_digitsinteger

Maximum number of digits to gather.

maximum_triesinteger

Maximum number of times to play the prompt if no input is received.

media_namestring

The name of the media file uploaded to the Media Storage API to play as the gather prompt.

minimum_digitsinteger

Minimum number of digits to gather.

stop_playback_on_dtmfboolean

Whether to stop the audio playback when a DTMF digit is received.

terminating_digitstring

Digit that terminates gathering.

timeout_millisinteger

Duration in milliseconds to wait for input before timing out.

valid_digitsstring

Digits that are valid for gathering. All other digits will be ignored.

Example request

{
  "audio_url": "http://example.com/gather_prompt.wav",
  "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "maximum_digits": 4,
  "minimum_digits": 1,
  "timeout_millis": 30000
}

Response

Successful response upon making a conference command.

Example response

{
  "data": {
    "result": "ok"
  }
}