Sign in

v52

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

Gather

Gather DTMF signals to build interactive menus.

You can pass a list of valid digits. The Answer command must be issued before the gather command.

Expected Webhooks:

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

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

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.

gather_idstring

An id that will be sent back in the corresponding call.gather.ended webhook. Will be randomly generated if not specified.

initial_timeout_millisinteger

The number of milliseconds to wait for the first DTMF.

inter_digit_timeout_millisinteger

The number of milliseconds to wait for input between digits.

maximum_digitsinteger

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

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 to complete the request.

valid_digitsstring

A list of all digits accepted as valid.

Example request

{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "gather_id": "my_gather_id",
  "initial_timeout_millis": 10000,
  "inter_digit_timeout_millis": 10000,
  "maximum_digits": 10,
  "minimum_digits": 1,
  "terminating_digit": "#",
  "timeout_millis": 60000,
  "valid_digits": "123"
}

Response

Successful response upon making a call control command.

Example response

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