<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Voice Gather - JavaScript

Installation

npm install [email protected]

Setup

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Add messages to AI Assistant

Add messages to the conversation started by an AI assistant on the call.

POST /calls/{callcontrolid}/actions/aiassistantadd_messages

Optional: clientstate (string), commandid (string), messages (array[object])

const response = await client.calls.actions.addAIAssistantMessages('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');

console.log(response.data);

Returns: result (string)

Start AI Assistant

Start an AI assistant on the call. Expected Webhooks:

• call.conversation.ended
• call.conversation_insights.generated

POST /calls/{callcontrolid}/actions/aiassistantstart

Optional: assistant (object), clientstate (string), commandid (string), greeting (string), interruptionsettings (object), messagehistory (array[object]), participants (array[object]), sendmessagehistoryupdates (boolean), transcription (object), voice (string), voicesettings (object)

const response = await client.calls.actions.startAIAssistant('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');

console.log(response.data);

Returns: conversation_id (uuid), result (string)

Stop AI Assistant

Stop an AI assistant on the call.

POST /calls/{callcontrolid}/actions/aiassistantstop

Optional: clientstate (string), commandid (string)

const response = await client.calls.actions.stopAIAssistant('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');

console.log(response.data);

Returns: result (string)

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.

POST /calls/{callcontrolid}/actions/gather

Optional: clientstate (string), commandid (string), gatherid (string), initialtimeoutmillis (int32), interdigittimeoutmillis (int32), maximumdigits (int32), minimumdigits (int32), terminatingdigit (string), timeoutmillis (int32), valid_digits (string)

const response = await client.calls.actions.gather('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');

console.log(response.data);

Returns: result (string)

Gather stop

Stop current gather. Expected Webhooks:

• call.gather.ended

POST /calls/{callcontrolid}/actions/gather_stop

Optional: clientstate (string), commandid (string)

const response = await client.calls.actions.stopGather('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');

console.log(response.data);

Returns: result (string)

Gather using AI

Gather parameters defined in the request payload using a voice assistant. You can pass parameters described as a JSON Schema object and the voice assistant will attempt to gather these informations.

POST /calls/{callcontrolid}/actions/gatherusingai — Required: parameters

Optional: assistant (object), clientstate (string), commandid (string), gatherendedspeech (string), greeting (string), interruptionsettings (object), language (object), messagehistory (array[object]), sendmessagehistoryupdates (boolean), sendpartialresults (boolean), transcription (object), userresponsetimeoutms (integer), voice (string), voice_settings (object)

const response = await client.calls.actions.gatherUsingAI('call_control_id', {
  parameters: {
    properties: 'bar',
    required: 'bar',
    type: 'bar',
  },
});

console.log(response.data);

Returns: conversation_id (uuid), result (string)

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 'invalidaudiourl', which will be played back at the beginning of each prompt. Playback will be interrupted when a DTMF signal is received.

POST /calls/{callcontrolid}/actions/gatherusingaudio

Optional: audiourl (string), clientstate (string), commandid (string), interdigittimeoutmillis (int32), invalidaudiourl (string), invalidmedianame (string), maximumdigits (int32), maximumtries (int32), medianame (string), minimumdigits (int32), terminatingdigit (string), timeoutmillis (int32), valid_digits (string)

const response = await client.calls.actions.gatherUsingAudio('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');

console.log(response.data);

Returns: result (string)

Gather using speak

Convert text to speech and play it 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_payload', which will be played back at the beginning of each prompt. Speech will be interrupted when a DTMF signal is received.

POST /calls/{callcontrolid}/actions/gatherusingspeak — Required: voice, payload

Optional: clientstate (string), commandid (string), interdigittimeoutmillis (int32), invalidpayload (string), language (enum: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, hi-IN, is-IS, it-IT, ja-JP, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR), maximumdigits (int32), maximumtries (int32), minimumdigits (int32), payloadtype (enum: text, ssml), servicelevel (enum: basic, premium), terminatingdigit (string), timeoutmillis (int32), validdigits (string), voice_settings (object)

const response = await client.calls.actions.gatherUsingSpeak('call_control_id', {
  payload: 'say this on call',
  voice: 'male',
});

console.log(response.data);

Returns: result (string)

Webhooks

Webhook Verification

Telnyx signs webhooks with Ed25519. Each request includes telnyx-signature-ed25519 and telnyx-timestamp headers. Always verify signatures in production:

// In your webhook handler (e.g., Express — use raw body, not parsed JSON):
app.post('/webhooks', express.raw({ type: 'application/json' }), async (req, res) => {
  try {
    const event = await client.webhooks.unwrap(req.body.toString(), {
      headers: req.headers,
    });
    // Signature valid — event is the parsed webhook payload
    console.log('Received event:', event.data.event_type);
    res.status(200).send('OK');
  } catch (err) {
    console.error('Webhook verification failed:', err.message);
    res.status(400).send('Invalid signature');
  }
});

The following webhook events are sent to your configured webhook URL. All webhooks include telnyx-timestamp and telnyx-signature-ed25519 headers for Ed25519 signature verification. Use client.webhooks.unwrap() to verify.

Webhook payload fields

CallAIGatherEnded

CallAIGatherMessageHistoryUpdated

CallAIGatherPartialResults

callGatherEnded