Call Commands

Gather

Changed on

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/calls/{call_control_id}/actions/gather
  • Auth: HTTP bearer

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

minimum_digitsinteger

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

maximum_digitsinteger

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

timeout_millisinteger

The number of milliseconds to wait to complete the request.

inter_digit_timeout_millisinteger

The number of milliseconds to wait for input between digits.

initial_timeout_millisinteger

The number of milliseconds to wait for the first DTMF.

terminating_digitstring

The digit used to terminate input if fewer than maximum_digits digits have been gathered. Set to an empty string to disable the terminating digit entirely, so that a digit such as # can be collected as input per valid_digits.

valid_digitsstring

A list of all digits accepted as valid.

gather_idstring

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

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.

Example request

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

Response

Successful response upon making a call control command.

Example response

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

Changes

  • 1571b0380bd7Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to integer for status

  • 8f5f4e537994Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from string to integer, and format from integer to int32 for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status