---
title: "Gather DTMF using audio prompt in a conference"
method: POST
path: "/conferences/{id}/actions/gather_using_audio"
tags: ["Conference Commands"]
---

# Gather DTMF using audio prompt in a conference

`POST /conferences/{id}/actions/gather_using_audio`

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

## Path parameters

- `id` string, uuid, required

## Request body

- ConferenceGatherUsingAudioRequest
  - `call_control_id` string, required — Unique identifier and token for controlling the call leg that will receive the gather prompt.
  - `audio_url` string — The URL of the audio file to play as the gather prompt. Must be WAV or MP3 format.
  - `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.
  - `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.
  - `timeout_millis` integer — Duration in milliseconds to wait for input before timing out.
  - `terminating_digit` string — Digit that terminates gathering.
  - `valid_digits` string — Digits that are valid for gathering. All other digits will be ignored.
  - `inter_digit_timeout_millis` integer — Duration in milliseconds to wait between digits.
  - `initial_timeout_millis` integer — Duration in milliseconds to wait for the first digit before timing out.
  - `stop_playback_on_dtmf` boolean — Whether to stop the audio playback when a DTMF digit is received.
  - `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.
  - `gather_id` string — Identifier for this gather command. Will be included in the gather ended webhook. Maximum 100 characters.
  - `client_state` string — Use this field to add state to every subsequent webhook. Must be a valid Base-64 encoded string.

## Response `200`

Successful response upon making a conference command.

- object
  - `data` ConferenceCommandResult
    - `result` string, required

## Other responses

- `401` — Unauthorized. Authentication failed - the required authentication headers were either invalid or not included in the request.
- `404` — Resource not found. The requested resource does not exist. Common causes include: invalid call_control_id, conference not found, audio file not found, or recording not found.
- `422` — Unprocessable entity. The request was well-formed but could not be processed due to semantic errors. This includes validation errors, invalid parameter values, call state errors, conference errors, queue errors, recording/transcription errors, and business logic violations.

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api/versions/e32d46c5945b/schema)