Python SDK - Telnyx

The official telnyx package provides synchronous and asynchronous Python clients generated from the same OpenAPI definition as the API reference.

Requests, types, and pagination

Typed models, nested parameters, file uploads, and 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

pip install telnyx

Requirements

Python 3.9 or higher.

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 os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)

response = client.calls.dial(
    connection_id="conn12345",
    from_="+15557654321",
    to="+15551234567",
    webhook_url="https://your-webhook.url/events",
)
print(response.data)

While you can provide an api_key keyword argument, we recommend using python-dotenv to add TELNYX_API_KEY="My API Key" to your .env file so that your API Key is not stored in source control.

Async usage

Simply import AsyncTelnyx instead of Telnyx and use await with each API call:

import os
import asyncio
from telnyx import AsyncTelnyx

client = AsyncTelnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)


async def main() -> None:
    response = await client.calls.dial(
        connection_id="conn12345",
        from_="+15557654321",
        to="+15551234567",
        webhook_url="https://your-webhook.url/events",
    )
    print(response.data)


asyncio.run(main())

Functionality between the synchronous and asynchronous clients is otherwise identical.

With aiohttp

By default, the async client uses httpx for HTTP requests. However, for improved concurrency performance you may also use aiohttp as the HTTP backend. You can enable this by installing aiohttp:

# install from PyPI
pip install telnyx[aiohttp]

Then you can enable it by instantiating the client with http_client=DefaultAioHttpClient():

import os
import asyncio
from telnyx import DefaultAioHttpClient
from telnyx import AsyncTelnyx


async def main() -> None:
    async with AsyncTelnyx(
        api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
        http_client=DefaultAioHttpClient(),
    ) as client:
        response = await client.calls.dial(
            connection_id="conn12345",
            from_="+15557654321",
            to="+15551234567",
            webhook_url="https://your-webhook.url/events",
        )
        print(response.data)


asyncio.run(main())

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

​Async usage

​With aiohttp

​Source and releases