TypeScript and Node.js SDK

The official telnyx package provides a typed TypeScript and Node.js client generated from the same OpenAPI definition as the API reference.

Requests, types, and pagination

Request and response types, file uploads, and automatic pagination.

Resource map

Search every SDK resource and method and open the matching REST endpoint.

Errors, retries, and timeouts

Handle structured errors and configure retry and timeout behavior.

Webhooks

Verify ED25519 signatures and process webhook events.

Advanced usage

Configure language-specific logging, transport, raw responses, and custom requests.

Install

npm install telnyx

Requirements

TypeScript >= 4.9 is supported. The following runtimes are supported:

Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
Node.js 20 LTS or later (non-EOL) versions.
Deno v1.28.0 or higher.
Bun 1.0 or later.
Cloudflare Workers.
Vercel Edge Runtime.
Jest 28 or greater with the "node" environment ("jsdom" is not supported at this time).
Nitro v2.6 or greater.

Note that React Native is not supported at this time. If you are interested in other runtime environments, please open or upvote an issue on GitHub.

Initialize the client and make a request

Quickstart from the current SDK source, using TELNYX_API_KEY for authentication:

Usage

The full API of this library can be found in api.md.

import Telnyx from 'telnyx';

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

const response = await client.calls.dial({
  connection_id: 'conn12345',
  from: '+15557654321',
  to: '+15551234567',
  webhook_url: 'https://your-webhook.url/events',
});

console.log(response.data);

Source and releases

SDK releases can follow REST API changes at different times. Check the package registry for the current version and use the resource map to confirm method availability.

Requests, types, and pagination

Resource map

Errors, retries, and timeouts

Webhooks

Advanced usage

​Install

​Requirements

​Initialize the client and make a request

​Usage

​Source and releases

Install

Requirements

Initialize the client and make a request

Usage

Source and releases