Skip to main content

​
Telnyx Development — Documentation Index

Account setup, authentication, API fundamentals, SDKs, CLI, MCP servers, and integration guides. One section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · Full content for this section: https://developers.telnyx.com/development/llms-txt-full.md

​
Subsections

Focused per-subsection files (index + full content):

​
Account setup

  • Create Account: Step-by-step guide to create and set up your Telnyx account for accessing APIs and services.
  • Account Signup: Understand the trust and safety checks applied to every Telnyx signup attempt.
  • Account Levels Overview: Understand how Telnyx accounts are categorized and what distinguishes each framework.
  • Pretrial Account: Capabilities, restrictions, and daily limits applied to Telnyx pretrial accounts.
  • Trial Account: Capabilities, restrictions, and daily limits applied to Telnyx trial accounts.
  • Using Your Trial Account: Recommended process to get the most value from Telnyx trial credits.
  • Paid Account: Capabilities and restrictions for paid Telnyx accounts — expanded number purchasing, messaging throughput, and product access beyond trial accounts.
  • Verified Account: Capabilities that remain restricted after verification and how to request enterprise access.
  • Account Upgrade: Actions required to advance from pretrial to trial, paid, verified, and enterprise Telnyx accounts.
  • Data Locality: Choose where your Telnyx data is stored at rest. Available regions are the US, Germany (EU), Australia, and UAE.

​
APIs fundamentals

  • Create API Keys: Step-by-step guide to create, manage, and secure your Telnyx API keys for all services.
  • API Authentication: Authentication methods and security best practices for all Telnyx APIs.
  • HTTP Patterns: Universal patterns for making requests and handling responses across all Telnyx APIs.
  • API error codes: Comprehensive reference of all Telnyx API error codes with descriptions and solutions.
  • Rate Limiting: Understand rate limits on the Telnyx REST API, including limit headers, retry strategies, and best practices for handling 429 responses across all services.
  • API Reliability & Retries: Best practices for handling API errors, implementing retries, and building resilient integrations across all Telnyx services.
  • Webhook Fundamentals: Receive, handle, and secure webhooks from Telnyx APIs. Covers webhook setup, signature verification, payload structure, and retries for Voice, SMS, and Fax.
  • Parameters & Field Names: Comprehensive guide to Telnyx API parameter and field naming conventions, data types, and formatting standards.

​
Server-side SDKs

  • Node.js: The official Telnyx Node.js SDK for server-side applications, covering messaging, voice, numbers, WebRTC, and the rest of the Telnyx REST API surface.
  • Python: The official Telnyx Python SDK for server-side applications, covering messaging, voice, numbers, WebRTC, and the rest of the Telnyx REST API surface.
  • PHP: The official Telnyx PHP SDK for server-side applications, covering messaging, voice, numbers, WebRTC, and the rest of the Telnyx REST API surface.
  • Java: The official Telnyx Java SDK for server-side applications, covering messaging, voice, numbers, WebRTC, and the rest of the Telnyx REST API surface.
  • Ruby: The official Telnyx Ruby SDK for server-side applications, covering messaging, voice, numbers, WebRTC, and the rest of the Telnyx REST API surface.
  • Go: The official Telnyx Go SDK for server-side applications, covering messaging, voice, numbers, WebRTC, and the rest of the Telnyx REST API surface.

​
Telnyx CLI

  • Overview: The Telnyx CLI is the official command-line interface for managing phone numbers, messaging, calls, and other Telnyx resources from your terminal.
  • Install: Install the Telnyx CLI on macOS, Windows, or Linux using Homebrew, the install script, or by downloading a prebuilt binary for your platform.
  • Quickstart: Install the Telnyx CLI, configure authentication, and run your first command in five minutes — send a message, list numbers, or place a call.
  • Authentication: Authenticate the Telnyx CLI by setting the TELNYX_API_KEY environment variable so commands can call Telnyx APIs on your account’s behalf.
  • Scripting & Automation: Automate workflows with the Telnyx CLI using output formats, filtering, and JSON parsing — patterns for shell scripts, cron jobs, and CI/CD pipelines.
  • Command Reference: Comprehensive reference for every Telnyx CLI command, auto-generated from the Telnyx REST API with options, examples, and per-resource usage notes.
  • 10DLC Registration: Register your business for US A2P 10DLC messaging using the Telnyx CLI, from brand creation through campaign approval, with copy-paste shell commands.
  • Troubleshooting: Troubleshoot common Telnyx CLI errors including authentication failures, missing API keys, and request errors, with solutions mapped to API error codes.
  • Overview: Documentation for the deprecated @telnyx/api-cli Node.js package. For new projects use the current Telnyx CLI with simpler authentication.
  • Installation: Install the deprecated @telnyx/api-cli Node.js CLI for legacy projects. New projects should use the current Telnyx CLI for better support.
  • Authentication: Configure API keys and switch between multiple authentication profiles in the deprecated @telnyx/api-cli legacy Node.js CLI.
  • Command Reference: Complete command reference for the deprecated @telnyx/api-cli Node.js CLI, retained for legacy projects. New projects should use the current Telnyx CLI.

​
Development Tools

  • Postman Setup: Configure Postman with the Telnyx OpenAPI collection and environment variables to send authenticated requests against every Telnyx product API.
  • ngrok Setup: Telnyx’s ngrok setup guide allows developers to easily create
  • Node-RED: Build Telnyx integrations visually with Node-RED. Install the @telnyx/node-red-telnyx package to wire SMS, voice, and Call Control flows without code.

​
For AI Agents

  • Local MCP Server: Install and configure the Telnyx Local MCP server so AI assistants like Claude Desktop can call Telnyx APIs as tools for agentic developer workflows.
  • Remote MCP: Integrate Telnyx services with Claude and other AI assistants without running a local MCP server.
  • Agent Skills: Build Telnyx integrations in natural language with Agent Skills for Claude Code and other AI coding agents. Supports all 36 Telnyx products via skill files.