Skip to main content

Gather

POST 

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

Request

Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call

Body

required

Gather

    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.

    timeout_millis int32

    Default value: 60000

    The number of milliseconds to wait to complete the request.

    inter_digit_timeout_millis int32

    Default value: 5000

    The number of milliseconds to wait for input between digits.

    initial_timeout_millis int32

    Default value: 5000

    The number of milliseconds to wait for the first DTMF.

    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.

    gather_id string

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

    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.

Schema

    data

    object

    result string

default: Unexpected error

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
  • ]

Callbacks

Loading...