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
已按上述方式初始化。

Lists accounts managed by the current user.

列出当前用户管理的账户

Lists the accounts managed by the current user.
GET /managed_accounts
ruby
page = client.managed_accounts.list

puts(page)
列出当前用户管理的账户。
GET /managed_accounts
ruby
page = client.managed_accounts.list

puts(page)

Create a new managed account.

创建新的托管账户

Create a new managed account owned by the authenticated user.
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)
创建一个由已认证用户拥有的新托管账户。
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)

Retrieve a managed account

检索托管账户

Retrieves the details of a single managed account.
GET /managed_accounts/{id}
ruby
managed_account = client.managed_accounts.retrieve("id")

puts(managed_account)
检索单个托管账户的详细信息。
GET /managed_accounts/{id}
ruby
managed_account = client.managed_accounts.retrieve("id")

puts(managed_account)

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("id")

puts(managed_account)
更新单个托管账户。
PATCH /managed_accounts/{id}
可选参数：
managed_account_allow_custom_pricing
（布尔值）
ruby
managed_account = client.managed_accounts.update("id")

puts(managed_account)

Disables a managed account

禁用托管账户

Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages.
POST /managed_accounts/{id}/actions/disable
ruby
response = client.managed_accounts.actions.disable("id")

puts(response)
禁用托管账户，禁止其使用Telnyx服务，包括拨打或接听电话以及发送或接收短信。
POST /managed_accounts/{id}/actions/disable
ruby
response = client.managed_accounts.actions.disable("id")

puts(response)

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("id")

puts(response)
启用托管账户及其子用户使用Telnyx服务。
POST /managed_accounts/{id}/actions/enable
可选参数：
reenable_all_connections
（布尔值）
ruby
response = client.managed_accounts.actions.enable("id")

puts(response)

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("id")

puts(response)
PATCH /managed_accounts/{id}/update_global_channel_limit
可选参数：
channel_limit
（整数）
ruby
response = client.managed_accounts.update_global_channel_limit("id")

puts(response)

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

显示当前用户的可分配全球外呼通道信息

GET /managed_accounts/allocatable_global_outbound_channels
ruby
response = client.managed_accounts.get_allocatable_global_outbound_channels

puts(response)
GET /managed_accounts/allocatable_global_outbound_channels
ruby
response = client.managed_accounts.get_allocatable_global_outbound_channels

puts(response)