Back to Details

telnyx-account-management-ruby

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- 从Telnyx OpenAPI规范自动生成，请勿编辑。 -->

Telnyx Account Management - Ruby

Telnyx账号管理 - Ruby

Installation

安装

bash
gem install telnyx
bash
gem install telnyx

Setup

初始化配置

ruby
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.
ruby
require "telnyx"

client = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"], # 这是默认配置，可省略
)
以下所有示例均假设
client
已按上述方式完成初始化。

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:
ruby
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).
所有API调用都可能失败，原因包括网络错误、速率限制(429)、校验错误(422)或认证错误(401)。生产环境代码中请务必做好错误处理：
ruby
begin
  result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
  puts "网络错误 — 检查网络连接后重试"
rescue Telnyx::Errors::RateLimitError
  # 429: 触发速率限制 — 等待后使用指数退避策略重试
  sleep(1) # 可查看Retry-After响应头获取准确的等待时长
rescue Telnyx::Errors::APIStatusError => e
  puts "API错误 #{e.status}: #{e.message}"
  if e.status == 422
    puts "校验错误 — 检查必填字段和格式是否正确"
  end
end
常见错误码：
401
API密钥无效，
403
权限不足，
404
资源不存在，
422
校验错误（请检查字段格式），
429
触发速率限制（请使用指数退避策略重试）。

Important Notes

重要说明

  • Pagination: Use 
    .auto_paging_each
    for automatic iteration: 
    page.auto_paging_each { |item| puts item.id }
    .
  • 分页： 使用
    .auto_paging_each
    实现自动遍历：
    page.auto_paging_each { |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
ruby
page = client.managed_accounts.list

puts(page)
Returns: 
api_user
(string), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
列出当前用户管理的所有账号。用户需要获得Telnyx的明确审批才能成为管理员账号。
GET /managed_accounts
ruby
page = client.managed_accounts.list

puts(page)
返回参数：
api_user
(字符串), 
created_at
(字符串), 
email
(邮箱), 
id
(uuid), 
managed_account_allow_custom_pricing
(布尔值), 
manager_account_id
(字符串), 
organization_name
(字符串), 
record_type
(枚举值: managed_account), 
rollup_billing
(布尔值), 
updated_at
(字符串)

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 /managed_accounts
— Required: 
business_name
Optional: 
email
(string), 
managed_account_allow_custom_pricing
(boolean), 
password
(string), 
rollup_billing
(boolean)
ruby
managed_account = client.managed_accounts.create(business_name: "Larry's Cat Food Inc")

puts(managed_account)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
创建归当前认证用户所有的新托管账号。你需要获得Telnyx的明确审批才能成为管理员账号。
POST /managed_accounts
— 必填参数：
business_name
可选参数：
email
(字符串), 
managed_account_allow_custom_pricing
(布尔值), 
password
(字符串), 
rollup_billing
(布尔值)
ruby
managed_account = client.managed_accounts.create(business_name: "Larry's Cat Food Inc")

puts(managed_account)
返回参数：
api_key
(字符串), 
api_token
(字符串), 
api_user
(字符串), 
balance
(对象), 
created_at
(字符串), 
email
(邮箱), 
id
(uuid), 
managed_account_allow_custom_pricing
(布尔值), 
manager_account_id
(字符串), 
organization_name
(字符串), 
record_type
(枚举值: managed_account), 
rollup_billing
(布尔值), 
updated_at
(字符串)

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 /managed_accounts/allocatable_global_outbound_channels
ruby
response = client.managed_accounts.get_allocatable_global_outbound_channels

puts(response)
Returns: 
allocatable_global_outbound_channels
(integer), 
managed_account_allow_custom_pricing
(boolean), 
record_type
(string), 
total_global_channels_allocated
(integer)
查询当前用户可分配的全球外呼通道信息，仅账号管理员可使用。
GET /managed_accounts/allocatable_global_outbound_channels
ruby
response = client.managed_accounts.get_allocatable_global_outbound_channels

puts(response)
返回参数：
allocatable_global_outbound_channels
(整数), 
managed_account_allow_custom_pricing
(布尔值), 
record_type
(字符串), 
total_global_channels_allocated
(整数)

Retrieve a managed account

查询单个托管账号

Retrieves the details of a single managed account.
GET /managed_accounts/{id}
ruby
managed_account = client.managed_accounts.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(managed_account)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
获取单个托管账号的详细信息。
GET /managed_accounts/{id}
ruby
managed_account = client.managed_accounts.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(managed_account)
返回参数：
api_key
(字符串), 
api_token
(字符串), 
api_user
(字符串), 
balance
(对象), 
created_at
(字符串), 
email
(邮箱), 
id
(uuid), 
managed_account_allow_custom_pricing
(布尔值), 
manager_account_id
(字符串), 
organization_name
(字符串), 
record_type
(枚举值: managed_account), 
rollup_billing
(布尔值), 
updated_at
(字符串)

Update a managed account

更新托管账号

Update a single managed account.
PATCH /managed_accounts/{id}
Optional: 
managed_account_allow_custom_pricing
(boolean)
ruby
managed_account = client.managed_accounts.update("550e8400-e29b-41d4-a716-446655440000")

puts(managed_account)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
更新单个托管账号的信息。
PATCH /managed_accounts/{id}
可选参数：
managed_account_allow_custom_pricing
(布尔值)
ruby
managed_account = client.managed_accounts.update("550e8400-e29b-41d4-a716-446655440000")

puts(managed_account)
返回参数：
api_key
(字符串), 
api_token
(字符串), 
api_user
(字符串), 
balance
(对象), 
created_at
(字符串), 
email
(邮箱), 
id
(uuid), 
managed_account_allow_custom_pricing
(布尔值), 
manager_account_id
(字符串), 
organization_name
(字符串), 
record_type
(枚举值: managed_account), 
rollup_billing
(布尔值), 
updated_at
(字符串)

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
ruby
response = client.managed_accounts.actions.disable("550e8400-e29b-41d4-a716-446655440000")

puts(response)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
禁用托管账号，禁止其使用Telnyx服务，包括收发电话和短信。正在进行的通话不受影响。该托管账号及其子用户将无法再通过Mission Control门户登录。
POST /managed_accounts/{id}/actions/disable
ruby
response = client.managed_accounts.actions.disable("550e8400-e29b-41d4-a716-446655440000")

puts(response)
返回参数：
api_key
(字符串), 
api_token
(字符串), 
api_user
(字符串), 
balance
(对象), 
created_at
(字符串), 
email
(邮箱), 
id
(uuid), 
managed_account_allow_custom_pricing
(布尔值), 
manager_account_id
(字符串), 
organization_name
(字符串), 
record_type
(枚举值: managed_account), 
rollup_billing
(布尔值), 
updated_at
(字符串)

Enables a managed account

启用托管账号

Enables a managed account and its sub-users to use Telnyx services.
POST /managed_accounts/{id}/actions/enable
Optional: 
reenable_all_connections
(boolean)
ruby
response = client.managed_accounts.actions.enable("550e8400-e29b-41d4-a716-446655440000")

puts(response)
Returns: 
api_key
(string), 
api_token
(string), 
api_user
(string), 
balance
(object), 
created_at
(string), 
email
(email), 
id
(uuid), 
managed_account_allow_custom_pricing
(boolean), 
manager_account_id
(string), 
organization_name
(string), 
record_type
(enum: managed_account), 
rollup_billing
(boolean), 
updated_at
(string)
启用托管账号及其子用户的Telnyx服务访问权限。
POST /managed_accounts/{id}/actions/enable
可选参数：
reenable_all_connections
(布尔值)
ruby
response = client.managed_accounts.actions.enable("550e8400-e29b-41d4-a716-446655440000")

puts(response)
返回参数：
api_key
(字符串), 
api_token
(字符串), 
api_user
(字符串), 
balance
(对象), 
created_at
(字符串), 
email
(邮箱), 
id
(uuid), 
managed_account_allow_custom_pricing
(布尔值), 
manager_account_id
(字符串), 
organization_name
(字符串), 
record_type
(枚举值: managed_account), 
rollup_billing
(布尔值), 
updated_at
(字符串)

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

更新指定托管账号的可分配全球外呼通道配额

PATCH /managed_accounts/{id}/update_global_channel_limit
Optional: 
channel_limit
(integer)
ruby
response = client.managed_accounts.update_global_channel_limit("550e8400-e29b-41d4-a716-446655440000")

puts(response)
Returns: 
channel_limit
(integer), 
email
(string), 
id
(string), 
manager_account_id
(string), 
record_type
(string)
PATCH /managed_accounts/{id}/update_global_channel_limit
可选参数：
channel_limit
(整数)
ruby
response = client.managed_accounts.update_global_channel_limit("550e8400-e29b-41d4-a716-446655440000")

puts(response)
返回参数：
channel_limit
(整数), 
email
(字符串), 
id
(字符串), 
manager_account_id
(字符串), 
record_type
(字符串)

List organization users

列出组织用户

Returns a list of the users in your organization.
GET /organizations/users
ruby
page = client.organizations.users.list

puts(page)
Returns: 
created_at
(string), 
email
(email), 
groups
(array[object]), 
id
(string), 
last_sign_in_at
(string | null), 
organization_user_bypasses_sso
(boolean), 
record_type
(string), 
user_status
(enum: enabled, disabled, blocked)
返回你的组织下所有用户的列表。
GET /organizations/users
ruby
page = client.organizations.users.list

puts(page)
返回参数：
created_at
(字符串), 
email
(邮箱), 
groups
(对象数组), 
id
(字符串), 
last_sign_in_at
(字符串 | 空), 
organization_user_bypasses_sso
(布尔值), 
record_type
(字符串), 
user_status
(枚举值: 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/users_groups_report
ruby
response = client.organizations.users.get_groups_report

puts(response)
Returns: 
created_at
(string), 
email
(email), 
groups
(array[object]), 
id
(string), 
last_sign_in_at
(string | null), 
organization_user_bypasses_sso
(boolean), 
record_type
(string), 
user_status
(enum: enabled, disabled, blocked)
返回你的组织下所有用户及其分组归属的报告。该接口返回所有用户，无分页，始终包含分组信息。可通过指定Content-Type请求头获取JSON或CSV格式的报告。
GET /organizations/users/users_groups_report
ruby
response = client.organizations.users.get_groups_report

puts(response)
返回参数：
created_at
(字符串), 
email
(邮箱), 
groups
(对象数组), 
id
(字符串), 
last_sign_in_at
(字符串 | 空), 
organization_user_bypasses_sso
(布尔值), 
record_type
(字符串), 
user_status
(枚举值: enabled, disabled, blocked)

Get organization user

查询单个组织用户

Returns a user in your organization.
GET /organizations/users/{id}
ruby
user = client.organizations.users.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(user)
Returns: 
created_at
(string), 
email
(email), 
groups
(array[object]), 
id
(string), 
last_sign_in_at
(string | null), 
organization_user_bypasses_sso
(boolean), 
record_type
(string), 
user_status
(enum: enabled, disabled, blocked)
返回你的组织下的单个用户信息。
GET /organizations/users/{id}
ruby
user = client.organizations.users.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(user)
返回参数：
created_at
(字符串), 
email
(邮箱), 
groups
(对象数组), 
id
(字符串), 
last_sign_in_at
(字符串 | 空), 
organization_user_bypasses_sso
(布尔值), 
record_type
(字符串), 
user_status
(枚举值: enabled, disabled, blocked)

Delete organization user

删除组织用户

Deletes a user in your organization.
POST /organizations/users/{id}/actions/remove
ruby
action = client.organizations.users.actions.remove("550e8400-e29b-41d4-a716-446655440000")

puts(action)
Returns: 
created_at
(string), 
email
(email), 
groups
(array[object]), 
id
(string), 
last_sign_in_at
(string | null), 
organization_user_bypasses_sso
(boolean), 
record_type
(string), 
user_status
(enum: enabled, disabled, blocked)
删除你的组织下的指定用户。
POST /organizations/users/{id}/actions/remove
ruby
action = client.organizations.users.actions.remove("550e8400-e29b-41d4-a716-446655440000")

puts(action)
返回参数：
created_at
(字符串), 
email
(邮箱), 
groups
(对象数组), 
id
(字符串), 
last_sign_in_at
(字符串 | 空), 
organization_user_bypasses_sso
(布尔值), 
record_type
(字符串), 
user_status
(枚举值: enabled, disabled, blocked)