Telnyx TypeScript API Library
This library provides convenient access to the Telnyx REST API from server-side TypeScript or JavaScript.
The full API of this library can be found in api.md.
It is generated with Stainless.
MCP Server
Use the Telnyx MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
Note: You may need to set environment variables in your MCP client.
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);
Examples
Runnable examples are available for:
Search for and order a phone number
const { data: availableNumbers } = await client.availablePhoneNumbers.list({
filter: {
country_code: 'US',
national_destination_code: '312',
limit: 1,
},
});
const phoneNumber = availableNumbers?.[0]?.phone_number;
if (!phoneNumber) throw new Error('No phone numbers found');
const { data: order } = await client.numberOrders.create({
phone_numbers: [{ phone_number: phoneNumber }],
});
Send an SMS
const { data: message } = await client.messages.send({
from: '+15551234567',
to: '+15557654321',
text: 'Hello from Telnyx!',
});
Start a Call Control call
const { data: call } = await client.calls.dial({
connection_id: 'your-connection-id',
from: '+15551234567',
to: '+15557654321',
webhook_url: 'https://example.com/webhooks',
});
Verify an inbound webhook
Configure the client with your Telnyx public key and pass the exact raw request body to unwrap. Parsing or re-serializing the body before verification invalidates the signature.
const webhookClient = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'],
publicKey: process.env['TELNYX_PUBLIC_KEY'],
});
const event = webhookClient.webhooks.unwrap(rawBody, {
headers: requestHeaders,
});
See the complete Express webhook verification example for raw-body handling and error responses.
Mint a WebRTC login token locally
A WebRTC client logs in with a token for a telephony credential. Instead of asking the API for one per login (createToken), your backend can sign it itself from the credential's token_material, with no request to Telnyx per token:
// Once, when the user is set up: create the credential and ask for the signing material.
const { data: credential } = await client.telephonyCredentials.create({
connection_id: '1234567890',
include: 'token_material',
});
// Store these with the user, server side: the token is built from all of them.
await db.save(userId, {
id: credential.id,
user_id: credential.user_id,
sip_username: credential.sip_username,
expires_at: credential.expires_at,
token_material: credential.token_material,
});
// On every login, with no request to Telnyx:
const loginToken = await client.telephonyCredentials.toJwt(credential, { ttl: 3600 });
// or later, from the stored values:
const loginTokenFromStore = await client.telephonyCredentials.toJwt(await db.load(userId), { ttl: 3600 });
The API returns token_material only when include: 'token_material' is passed. For a credential created without it, or retrieved later, toJwt fetches the material once with retrieveTokenMaterial. token_material is as sensitive as the SIP password: keep it on the server. See the WebRTC login token example.
Configure retries
Connection failures and retryable HTTP responses are retried twice by default. Set maxRetries for the client or override it for an individual request:
const retryingClient = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'],
maxRetries: 4,
});
await retryingClient.messages.send(
{
from: '+15551234567',
to: '+15557654321',
text: 'Hello from Telnyx!',
},
{ maxRetries: 0 },
);
See Handling errors and Retries for details.
Request & Response types
This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const params: Telnyx.NumberOrderCreateParams = {
phone_numbers: [{ phone_number: '+15558675309' }],
};
const numberOrder: Telnyx.NumberOrderCreateResponse = await client.numberOrders.create(params);
Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
File uploads
Request parameters that correspond to file uploads can be passed in many different forms:
File (or an object with the same structure)- a
fetch Response (or an object with the same structure)
- an
fs.ReadStream
- the return value of our
toFile helper
import fs from 'fs';
import Telnyx, { toFile } from 'telnyx';
const client = new Telnyx();
// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
await client.ai.audio.transcribe({
model: 'distil-whisper/distil-large-v2',
file: fs.createReadStream('/path/to/file'),
});
// Or if you have the web `File` API you can pass a `File` instance:
await client.ai.audio.transcribe({
model: 'distil-whisper/distil-large-v2',
file: new File(['my bytes'], 'file'),
});
// You can also pass a `fetch` `Response`:
await client.ai.audio.transcribe({
model: 'distil-whisper/distil-large-v2',
file: await fetch('https://somesite/file'),
});
// Finally, if none of the above are convenient, you can use our `toFile` helper:
await client.ai.audio.transcribe({
model: 'distil-whisper/distil-large-v2',
file: await toFile(Buffer.from('my bytes'), 'file'),
});
await client.ai.audio.transcribe({
model: 'distil-whisper/distil-large-v2',
file: await toFile(new Uint8Array([0, 1, 2]), 'file'),
});
Handling errors
When the library is unable to connect to the API,
or if the API returns a non-success status code (i.e., 4xx or 5xx response),
a subclass of APIError will be thrown:
const numberOrder = await client.numberOrders
.create({ phone_numbers: [{ phone_number: '+15558675309' }] })
.catch(async (err) => {
if (err instanceof Telnyx.APIError) {
console.log(err.status); // 400
console.log(err.name); // BadRequestError
console.log(err.headers); // {server: 'nginx', ...}
} else {
throw err;
}
});
Error codes are as follows:
| Status Code | Error Type |
|---|
| 400 | BadRequestError |
| 401 | AuthenticationError |
| 403 | PermissionDeniedError |
| 404 | NotFoundError |
| 422 | UnprocessableEntityError |
| 429 | RateLimitError |
| >=500 | InternalServerError |
| N/A | APIConnectionError |
Retries
Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
429 Rate Limit, and >=500 Internal errors will all be retried by default.
You can use the maxRetries option to configure or disable this:
// Configure the default for all requests:
const client = new Telnyx({
maxRetries: 0, // default is 2
});
// Or, configure per-request:
await client.numberOrders.create({ phone_numbers: [{ phone_number: '+15558675309' }] }, {
maxRetries: 5,
});
Timeouts
Requests time out after 1 minute by default. You can configure this with a timeout option:
// Configure the default for all requests:
const client = new Telnyx({
timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});
// Override per-request:
await client.numberOrders.create({ phone_numbers: [{ phone_number: '+15558675309' }] }, {
timeout: 5 * 1000,
});
On timeout, an APIConnectionTimeoutError is thrown.
Note that requests which time out will be retried twice by default.
Auto-pagination
List methods in the Telnyx API are paginated.
You can use the for await … of syntax to iterate through items across all pages:
async function fetchAllAccessIPAddressResponses(params) {
const allAccessIPAddressResponses = [];
// Automatically fetches more pages as needed.
for await (const accessIPAddressResponse of client.accessIPAddress.list({
'page[number]': 1,
'page[size]': 50,
})) {
allAccessIPAddressResponses.push(accessIPAddressResponse);
}
return allAccessIPAddressResponses;
}
Alternatively, you can request a single page at a time:
let page = await client.accessIPAddress.list({ 'page[number]': 1, 'page[size]': 50 });
for (const accessIPAddressResponse of page.data) {
console.log(accessIPAddressResponse);
}
// Convenience methods are provided for manually paginating:
while (page.hasNextPage()) {
page = await page.getNextPage();
// ...
}
Advanced Usage
Accessing raw Response data (e.g., headers)
The "raw" Response returned by fetch() can be accessed through the .asResponse() method on the APIPromise type that all methods return.
This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.
You can also use the .withResponse() method to get the raw Response along with the parsed data.
Unlike .asResponse() this method consumes the body, returning once it is parsed.
const client = new Telnyx();
const response = await client.numberOrders
.create({ phone_numbers: [{ phone_number: '+15558675309' }] })
.asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object
const { data: numberOrder, response: raw } = await client.numberOrders
.create({ phone_numbers: [{ phone_number: '+15558675309' }] })
.withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(numberOrder.data);
Logging
[!IMPORTANT]
All log messages are intended for debugging only. The format and content of log messages
may change between releases.
Log levels
The log level can be configured in two ways:
- Via the
TELNYX_LOG environment variable
- Using the
logLevel client option (overrides the environment variable if set)
import Telnyx from 'telnyx';
const client = new Telnyx({
logLevel: 'debug', // Show all log messages
});
Available log levels, from most to least verbose:
'debug' - Show debug messages, info, warnings, and errors'info' - Show info messages, warnings, and errors'warn' - Show warnings and errors (default)'error' - Show only errors'off' - Disable all logging
At the 'debug' level, all HTTP requests and responses are logged, including headers and bodies.
Some authentication-related headers are redacted, but sensitive data in request and response bodies
may still be visible.
Custom logger
By default, this library logs to globalThis.console. You can also provide a custom logger.
Most logging libraries are supported, including pino, winston, bunyan, consola, signale, and @std/log. If your logger doesn't work, please open an issue.
When providing a custom logger, the logLevel option still controls which messages are emitted, messages
below the configured level will not be sent to your logger.
import Telnyx from 'telnyx';
import pino from 'pino';
const logger = pino();
const client = new Telnyx({
logger: logger.child({ name: 'Telnyx' }),
logLevel: 'debug', // Send all messages to pino, allowing it to filter
});
Making custom/undocumented requests
This library is typed for convenient access to the documented API. If you need to access undocumented
endpoints, params, or response properties, the library can still be used.
Undocumented endpoints
To make requests to undocumented endpoints, you can use client.get, client.post, and other HTTP verbs.
Options on the client, such as retries, will be respected when making these requests.
await client.post('/some/path', {
body: { some_prop: 'foo' },
query: { some_query_arg: 'bar' },
});
Undocumented request params
To make requests using undocumented parameters, you may use // @ts-expect-error on the undocumented
parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
send will be sent as-is.
client.calls.dial({
// ...
// @ts-expect-error baz is not yet public
baz: 'undocumented option',
});
For requests with the GET verb, any extra params will be in the query, all other requests will send the
extra param in the body.
If you want to explicitly send an extra argument, you can do so with the query, body, and headers request
options.
Undocumented response properties
To access undocumented response properties, you may access the response object with // @ts-expect-error on
the response object, or cast the response object to the requisite type. Like the request params, we do not
validate or strip extra properties from the response from the API.
Customizing the fetch client
By default, this library expects a global fetch function is defined.
If you want to use a different fetch function, you can either polyfill the global:
import fetch from 'my-fetch';
globalThis.fetch = fetch;
Or pass it to the client:
import Telnyx from 'telnyx';
import fetch from 'my-fetch';
const client = new Telnyx({ fetch });
Fetch options
If you want to set custom fetch options without overriding the fetch function, you can provide a fetchOptions object when instantiating the client or making a request. (Request-specific options override client options.)
import Telnyx from 'telnyx';
const client = new Telnyx({
fetchOptions: {
// `RequestInit` options
},
});
Configuring proxies
To modify proxy behavior, you can provide custom fetchOptions that add runtime-specific proxy
options to requests:
Node [docs]
import Telnyx from 'telnyx';
import * as undici from 'undici';
const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
const client = new Telnyx({
fetchOptions: {
dispatcher: proxyAgent,
},
});
Bun [docs]
import Telnyx from 'telnyx';
const client = new Telnyx({
fetchOptions: {
proxy: 'http://localhost:8888',
},
});
Deno [docs]
import Telnyx from 'npm:telnyx';
const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
const client = new Telnyx({
fetchOptions: {
client: httpClient,
},
});
Frequently Asked Questions
Semantic versioning
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes that only affect static types, without breaking runtime behavior.
- Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.
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.
Contributing
See the contributing documentation.