Ruby SDK - Telnyx

The official telnyx gem provides a Ruby client generated from the same OpenAPI definition as the API reference.

Requests, types, and pagination

Models, Sorbet types, 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

bundle add telnyx

Requirements

Ruby 3.2.0 or higher.

Initialize the client and make a request

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

Usage

require "bundler/setup"
require "telnyx"

telnyx = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"] # This is the default and can be omitted
)

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

puts(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