Gather using audio

POST 
/calls/:call_control_id/actions/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

Request

Path Parameters

call_control_id stringrequired

Unique identifier and token for controlling the call

application/json

Body

required

Gather using audio request

audio_url string

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.

media_name string

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.

invalid_audio_url string

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_name string

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.

minimum_digits int32

Default value: 1

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

maximum_digits int32

Default value: 128

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

maximum_tries int32

Default value: 3

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

timeout_millis int32

Default value: 60000

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

terminating_digit string

Default value: #

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

valid_digits string

Default value: 0123456789#*

A list of all digits accepted as valid.

inter_digit_timeout_millis int32

Default value: 5000

The number of milliseconds to wait for input between digits.

client_state string

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

command_id string

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

Responses

200: Successful response upon making a call control command.

application/json

• Schema
• Example (from schema)

Schema

data

object

result string

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

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Callbacks

Loading...