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

Telnyx Account Management - 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 }.

Lists accounts managed by the current user.

Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.

GET /managed_accounts

page = client.managed_accounts.list

puts(page)

Returns: apiuser (string), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (boolean), updated_at (string)

Create a new managed account.

Create a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account.

POST /managedaccounts — Required: businessname

Optional: email (string), managedaccountallowcustompricing (boolean), password (string), rollup_billing (boolean)

managed_account = client.managed_accounts.create(business_name: "Larry's Cat Food Inc")

puts(managed_account)

Returns: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (boolean), updated_at (string)

Display information about allocatable global outbound channels for the current user.

Display information about allocatable global outbound channels for the current user. Only usable by account managers.

GET /managedaccounts/allocatableglobaloutboundchannels

response = client.managed_accounts.get_allocatable_global_outbound_channels

puts(response)

Returns: allocatableglobaloutboundchannels (integer), managedaccountallowcustompricing (boolean), recordtype (string), totalglobalchannels_allocated (integer)

Retrieve a managed account

Retrieves the details of a single managed account.

GET /managed_accounts/{id}

managed_account = client.managed_accounts.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(managed_account)

Returns: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (boolean), updated_at (string)

Update a managed account

Update a single managed account.

PATCH /managed_accounts/{id}

Optional: managedaccountallowcustompricing (boolean)

managed_account = client.managed_accounts.update("550e8400-e29b-41d4-a716-446655440000")

puts(managed_account)

Returns: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (boolean), updated_at (string)

Disables a managed account

Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be affected. The managed account and its sub-users will no longer be able to log in via the mission control portal.

POST /managed_accounts/{id}/actions/disable

response = client.managed_accounts.actions.disable("550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (boolean), updated_at (string)

Enables a managed account

Enables a managed account and its sub-users to use Telnyx services.

POST /managed_accounts/{id}/actions/enable

Optional: reenableallconnections (boolean)

response = client.managed_accounts.actions.enable("550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (boolean), updated_at (string)

Update the amount of allocatable global outbound channels allocated to a specific managed account.

PATCH /managedaccounts/{id}/updateglobalchannellimit

Optional: channel_limit (integer)

response = client.managed_accounts.update_global_channel_limit("550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns: channellimit (integer), email (string), id (string), manageraccountid (string), recordtype (string)

List organization users

Returns a list of the users in your organization.

GET /organizations/users

page = client.organizations.users.list

puts(page)

Returns: createdat (string), email (email), groups (array[object]), id (string), lastsigninat (string | null), organizationuserbypassessso (boolean), recordtype (string), user_status (enum: enabled, disabled, blocked)

Get organization users groups report

Returns a report of all users in your organization with their group memberships. This endpoint returns all users without pagination and always includes group information. The report can be retrieved in JSON or CSV format by sending specific content-type headers.

GET /organizations/users/usersgroupsreport

response = client.organizations.users.get_groups_report

puts(response)

Returns: createdat (string), email (email), groups (array[object]), id (string), lastsigninat (string | null), organizationuserbypassessso (boolean), recordtype (string), user_status (enum: enabled, disabled, blocked)

Get organization user

Returns a user in your organization.

GET /organizations/users/{id}

user = client.organizations.users.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(user)

Returns: createdat (string), email (email), groups (array[object]), id (string), lastsigninat (string | null), organizationuserbypassessso (boolean), recordtype (string), user_status (enum: enabled, disabled, blocked)

Delete organization user

Deletes a user in your organization.

POST /organizations/users/{id}/actions/remove

action = client.organizations.users.actions.remove("550e8400-e29b-41d4-a716-446655440000")

puts(action)

Returns: createdat (string), email (email), groups (array[object]), id (string), lastsigninat (string | null), organizationuserbypassessso (boolean), recordtype (string), user_status (enum: enabled, disabled, blocked)