<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Webrtc - Ruby

Installation

gem install telnyx

Setup

require "telnyx"

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

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

begin
  result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
  puts "Network error — check connectivity and retry"
rescue Telnyx::Errors::RateLimitError
  # 429: rate limited — wait and retry with exponential backoff
  sleep(1) # Check Retry-After header for actual delay
rescue Telnyx::Errors::APIStatusError => e
  puts "API error #{e.status}: #{e.message}"
  if e.status == 422
    puts "Validation error — check required fields and formats"
  end
end

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Pagination: Use .autopagingeach for automatic iteration: page.autopagingeach { |item| puts item.id }.

List mobile push credentials

GET /mobilepushcredentials

page = client.mobile_push_credentials.list

puts(page)

Returns: alias (string), certificate (string), createdat (date-time), id (string), privatekey (string), projectaccountjsonfile (object), recordtype (string), type (string), updated_at (date-time)

Creates a new mobile push credential

POST /mobilepushcredentials — Required: type, certificate, private_key, alias

push_credential_response = client.mobile_push_credentials.create(
  create_mobile_push_credential_request: {
    alias: "LucyIosCredential",
    certificate: "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
    private_key: "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
    type: :ios
  }
)

puts(push_credential_response)

Returns: alias (string), certificate (string), createdat (date-time), id (string), privatekey (string), projectaccountjsonfile (object), recordtype (string), type (string), updated_at (date-time)

Retrieves a mobile push credential

Retrieves mobile push credential based on the given pushcredentialid

GET /mobilepushcredentials/{pushcredentialid}

push_credential_response = client.mobile_push_credentials.retrieve("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0")

puts(push_credential_response)

Returns: alias (string), certificate (string), createdat (date-time), id (string), privatekey (string), projectaccountjsonfile (object), recordtype (string), type (string), updated_at (date-time)

Deletes a mobile push credential

Deletes a mobile push credential based on the given pushcredentialid

DELETE /mobilepushcredentials/{pushcredentialid}

result = client.mobile_push_credentials.delete("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0")

puts(result)

List all credentials

List all On-demand Credentials.

GET /telephony_credentials

page = client.telephony_credentials.list

puts(page)

Returns: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)

Create a credential

Create a credential.

POST /telephonycredentials — Required: connectionid

Optional: expires_at (string), name (string), tag (string)

telephony_credential = client.telephony_credentials.create(connection_id: "1234567890")

puts(telephony_credential)

Returns: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)

Get a credential

Get the details of an existing On-demand Credential.

GET /telephony_credentials/{id}

telephony_credential = client.telephony_credentials.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(telephony_credential)

Returns: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)

Update a credential

Update an existing credential.

PATCH /telephony_credentials/{id}

Optional: connectionid (string), expiresat (string), name (string), tag (string)

telephony_credential = client.telephony_credentials.update("550e8400-e29b-41d4-a716-446655440000")

puts(telephony_credential)

Returns: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)

Delete a credential

Delete an existing credential.

DELETE /telephony_credentials/{id}

telephony_credential = client.telephony_credentials.delete("550e8400-e29b-41d4-a716-446655440000")

puts(telephony_credential)

Returns: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)