Telnyx Voice - JavaScript

Installation

bash

npm install telnyx

Setup

javascript

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.

Answer call

Answer an incoming call.

POST /calls/{call_control_id}/actions/answer

javascript

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

console.log(response.data);

Bridge calls

Bridge two call control calls.

POST /calls/{call_control_id}/actions/bridge — Required: call_control_id

javascript

const response = await client.calls.actions.bridge('call_control_id', {
  call_control_id_to_bridge_with: 'v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg',
});

console.log(response.data);

Dial

Dial a number or SIP URI from a given connection.

POST /calls — Required: connection_id, to, from

javascript

const response = await client.calls.dial({
  connection_id: '7267xxxxxxxxxxxxxx',
  from: '+18005550101',
  to: '+18005550100 or sip:username@sip.telnyx.com',
});

console.log(response.data);

Hangup call

Hang up the call.

POST /calls/{call_control_id}/actions/hangup

javascript

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

console.log(response.data);

Transfer call

Transfer a call to a new destination.

POST /calls/{call_control_id}/actions/transfer — Required: to

javascript

const response = await client.calls.actions.transfer('call_control_id', {
  to: '+18005550100 or sip:username@sip.telnyx.com',
});

console.log(response.data);

List all active calls for given connection

Lists all active calls for given connection.

GET /connections/{connection_id}/active_calls

javascript

// Automatically fetches more pages as needed.
for await (const connectionListActiveCallsResponse of client.connections.listActiveCalls(
  '1293384261075731461',
)) {
  console.log(connectionListActiveCallsResponse.call_control_id);
}

List call control applications

Return a list of call control applications.

GET /call_control_applications

javascript

// Automatically fetches more pages as needed.
for await (const callControlApplication of client.callControlApplications.list()) {
  console.log(callControlApplication.id);
}

Create a call control application

Create a call control application.

POST /call_control_applications — Required: application_name, webhook_event_url

javascript

const callControlApplication = await client.callControlApplications.create({
  application_name: 'call-router',
  webhook_event_url: 'https://example.com',
});

console.log(callControlApplication.data);

Retrieve a call control application

Retrieves the details of an existing call control application.

GET /call_control_applications/{id}

javascript

const callControlApplication = await client.callControlApplications.retrieve('id');

console.log(callControlApplication.data);

Update a call control application

Updates settings of an existing call control application.

PATCH /call_control_applications/{id} — Required: application_name, webhook_event_url

javascript

const callControlApplication = await client.callControlApplications.update('id', {
  application_name: 'call-router',
  webhook_event_url: 'https://example.com',
});

console.log(callControlApplication.data);

Delete a call control application

Deletes a call control application.

DELETE /call_control_applications/{id}

javascript

const callControlApplication = await client.callControlApplications.delete('id');

console.log(callControlApplication.data);

List call events

Filters call events by given filter parameters.

GET /call_events

javascript

// Automatically fetches more pages as needed.
for await (const callEventListResponse of client.callEvents.list()) {
  console.log(callEventListResponse.call_leg_id);
}

Webhooks

The following webhook events are sent to your configured webhook URL. All webhooks include telnyx-timestamp and telnyx-signature-ed25519 headers for verification (Standard Webhooks compatible).

Event	Description
`callAnswered`	Call Answered
`callStreamingStarted`	Call Streaming Started
`callStreamingStopped`	Call Streaming Stopped
`callStreamingFailed`	Call Streaming Failed
`callBridged`	Call Bridged
`callInitiated`	Call Initiated
`callHangup`	Call Hangup
`callRecordingSaved`	Call Recording Saved
`callMachineDetectionEnded`	Call Machine Detection Ended
`callMachineGreetingEnded`	Call Machine Greeting Ended
`callMachinePremiumDetectionEnded`	Call Machine Premium Detection Ended
`callMachinePremiumGreetingEnded`	Call Machine Premium Greeting Ended