Skip to main content
POST
/
calls
/
{call_control_id}
/
actions
/
gather
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.calls.actions.gather('call_control_id');

console.log(response.data);
{
  "data": {
    "result": "ok"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
call_control_id
string
required

Unique identifier and token for controlling the call

Body

application/json

Gather

​
minimum_digits
integer<int32>
default:1

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

Example:

1

​
maximum_digits
integer<int32>
default:128

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

Example:

10

​
timeout_millis
integer<int32>
default:60000

The number of milliseconds to wait to complete the request.

Example:

60000

​
inter_digit_timeout_millis
integer<int32>
default:5000

The number of milliseconds to wait for input between digits.

Example:

10000

​
initial_timeout_millis
integer<int32>
default:5000

The number of milliseconds to wait for the first DTMF.

Example:

10000

​
terminating_digit
string
default:#

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

Example:

"#"

​
valid_digits
string
default:0123456789#*

A list of all digits accepted as valid.

Example:

"123"

​
gather_id
string

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

Required string length: 1 - 40
Example:

"my_gather_id"

​
client_state
string

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

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

​
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.

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

Response

Successful response upon making a call control command.

​
data
Call Control Command Result · object
Example:
{ "result": "ok" }