Server-side SDKs

Choose an SDK

TypeScript and Node.js

npm package, setup, API usage, pagination, and error handling.

Python

Sync and async clients, typed models, pagination, and error handling.

Go

Go modules, request options, pagination, and error handling.

Java

Gradle and Maven setup, sync and async clients, and typed models.

Ruby

Bundler setup, typed models, pagination, and error handling.

PHP

Composer setup, named parameters, pagination, and error handling.

The Telnyx CLI provides command-line access to the same API for terminal workflows and automation.

SDK or direct HTTP

Select the interface that matches the workload:

Use case	Recommended interface
Application or service integration	SDK
Typed request and response models	SDK
Pagination, retries, and structured errors	SDK
Quick endpoint test	API reference HTTP example
Shell script or command-line workflow	Telnyx CLI or direct HTTP
Environment without a supported SDK runtime	Direct HTTP

Every REST endpoint remains available over HTTPS. The API reference provides endpoint schemas and request examples when direct HTTP is the better fit.

Install

npm install telnyx

Package · Source

pip install telnyx

Package · Source

go get github.com/team-telnyx/telnyx-go/v4

Package · Source

Add com.telnyx.sdk:telnyx to the Gradle or Maven build using the current release from Maven Central.Maven Central · Source

bundle add telnyx

Package · Source

composer require telnyx/telnyx-php

Package · Source

Authenticate

Create an API key in the Mission Control Portal, store it outside source control, and expose it to the application as TELNYX_API_KEY. Pass this environment variable when initializing the client; SDKs that support environment-based defaults read the same name.

export TELNYX_API_KEY="KEY..."

See Create and manage API keys for key creation, storage, rotation, and revocation.

Make a request

The following TypeScript example initializes the client from TELNYX_API_KEY and creates a call:

import Telnyx from "telnyx";

const client = new Telnyx();

const call = await client.calls.dial({
  connection_id: "<CONNECTION_ID>",
  from: "+15557654321",
  to: "+15551234567",
  webhook_url: "https://example.com/webhooks",
});

console.log(call.data.id);

Open the language guide above for the equivalent client setup and current method signatures in each SDK.

Generated API coverage

Telnyx generates the server-side SDKs from the public REST API definition. Resource and method names follow the API model, while each library provides language-specific types and conventions. All official server-side SDKs include utilities for ED25519 webhook-signature verification. Use the SDK’s webhook service with the raw request body, the telnyx-signature-ed25519 header, the telnyx-timestamp header, and the public key from the Mission Control Portal. SDK releases can follow API changes at different times. Before adopting a newly released endpoint or field:

Update to the current SDK release.
Check the language guide or repository for the generated method and model.
Use direct HTTP when an API capability is available before the matching SDK release.

Get help

Report SDK-specific defects in the corresponding GitHub repository. For account or API behavior issues, contact Telnyx Support. Include the SDK language, package version, affected resource or method, and a minimal reproduction with credentials removed.

Account setup

APIs fundamentals

Server-side SDKs

Telnyx CLI

Development Tools

Migration Guides

Glossary

For AI Agents

Server-side SDKs

Choose an SDK

TypeScript and Node.js

Python

Go

Java

Ruby

PHP

SDK or direct HTTP

Install

Authenticate

Make a request

Generated API coverage

Get help

​Choose an SDK

TypeScript and Node.js

Python

Go

Java

Ruby

PHP

​SDK or direct HTTP

​Install

​Authenticate

​Make a request

​Generated API coverage

​Get help

Choose an SDK

SDK or direct HTTP

Install

Authenticate

Make a request

Generated API coverage

Get help