Sign in

v52

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

Gather using audio

Play an audio file on the call until the required DTMF signals are gathered to build interactive menus.

You can pass a list of valid digits along with an 'invalid_audio_url', which will be played back at the beginning of each prompt. Playback will be interrupted when a DTMF signal is received. The Answer command must be issued before the gather_using_audio` command.

Expected Webhooks:

  • call.playback.started
  • call.playback.ended
  • call.dtmf.received (you may receive many of these webhooks)
  • call.gather.ended
post/calls/{call_control_id}/actions/gather_using_audio

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

audio_urlstring

The URL of a file to be played back at the beginning of each prompt. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request.

client_statestring

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

command_idstring

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

inter_digit_timeout_millisinteger

The number of milliseconds to wait for input between digits.

invalid_audio_urlstring

The URL of a file to play when digits don't match the valid_digits parameter or the number of digits is not between min and max. The URL can point to either a WAV or MP3 file. invalid_media_name and invalid_audio_url cannot be used together in one request.

invalid_media_namestring

The media_name of a file to be played back when digits don't match the valid_digits parameter or the number of digits is not between min and max. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.

maximum_digitsinteger

The maximum number of digits to fetch. This parameter has a maximum value of 128.

maximum_triesinteger

The maximum number of times the file should be played if there is no input from the user on the call.

media_namestring

The media_name of a file to be played back at the beginning of each prompt. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.

minimum_digitsinteger

The minimum number of digits to fetch. This parameter has a minimum value of 1.

terminating_digitstring

The digit used to terminate input if fewer than maximum_digits digits have been gathered.

timeout_millisinteger

The number of milliseconds to wait for a DTMF response after file playback ends before a replaying the sound file.

valid_digitsstring

A list of all digits accepted as valid.

Example request

{
  "audio_url": "http://example.com/message.wav",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "inter_digit_timeout_millis": 10000,
  "invalid_audio_url": "http://example.com/message.wav",
  "maximum_digits": 10,
  "minimum_digits": 1,
  "terminating_digit": "#",
  "timeout_millis": 10000,
  "valid_digits": "123"
}

Response

Successful response upon making a call control command.

Example response

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