Back to Details

telnyx-iot-ruby

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

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

Telnyx Iot - Ruby

Telnyx Iot - 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 "Network error — check connectivity and retry"
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 }
    。

Purchase eSIMs

购买eSIM

Purchases and registers the specified amount of eSIMs to the current user's account.
If 
sim_card_group_id
is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used.
POST /actions/purchase/esims
— Required: 
amount
Optional: 
product
(string), 
sim_card_group_id
(uuid), 
status
(enum: enabled, disabled, standby), 
tags
(array[string]), 
whitelabel_name
(string)
ruby
purchase = client.actions.purchase.create(amount: 10)

puts(purchase)
Returns: 
actions_in_progress
(boolean), 
authorized_imeis
(array | null), 
created_at
(string), 
current_billing_period_consumed_data
(object), 
data_limit
(object), 
eid
(string | null), 
esim_installation_status
(enum: released, disabled), 
iccid
(string), 
id
(uuid), 
imsi
(string), 
msisdn
(string), 
record_type
(string), 
resources_with_in_progress_actions
(array[object]), 
sim_card_group_id
(uuid), 
status
(object), 
tags
(array[string]), 
type
(enum: physical, esim), 
updated_at
(string), 
version
(string), 
voice_enabled
(boolean)
购买指定数量的eSIM并注册到当前用户账号下。 如果提供了
sim_card_group_id
，则这些eSIM会关联到对应分组，否则会使用当前用户的默认分组。
POST /actions/purchase/esims
— 必填参数：
amount
可选参数：
product
（字符串）、
sim_card_group_id
（uuid）、
status
（枚举值：enabled, disabled, standby）、
tags
（字符串数组）、
whitelabel_name
（字符串）
ruby
purchase = client.actions.purchase.create(amount: 10)

puts(purchase)
返回参数：
actions_in_progress
（布尔值）、
authorized_imeis
（数组 | 空）、
created_at
（字符串）、
current_billing_period_consumed_data
（对象）、
data_limit
（对象）、
eid
（字符串 | 空）、
esim_installation_status
（枚举值：released, disabled）、
iccid
（字符串）、
id
（uuid）、
imsi
（字符串）、
msisdn
（字符串）、
record_type
（字符串）、
resources_with_in_progress_actions
（对象数组）、
sim_card_group_id
（uuid）、
status
（对象）、
tags
（字符串数组）、
type
（枚举值：physical, esim）、
updated_at
（字符串）、
version
（字符串）、
voice_enabled
（布尔值）

Register SIM cards

注册SIM卡

Register the SIM cards associated with the provided registration codes to the current user's account.
If 
sim_card_group_id
is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.
POST /actions/register/sim_cards
— Required: 
registration_codes
Optional: 
sim_card_group_id
(uuid), 
status
(enum: enabled, disabled, standby), 
tags
(array[string])
ruby
register = client.actions.register.create(registration_codes: ["0000000001", "0000000002", "0000000003"])

puts(register)
Returns: 
actions_in_progress
(boolean), 
authorized_imeis
(array | null), 
created_at
(string), 
current_billing_period_consumed_data
(object), 
data_limit
(object), 
eid
(string | null), 
esim_installation_status
(enum: released, disabled), 
iccid
(string), 
id
(uuid), 
imsi
(string), 
msisdn
(string), 
record_type
(string), 
resources_with_in_progress_actions
(array[object]), 
sim_card_group_id
(uuid), 
status
(object), 
tags
(array[string]), 
type
(enum: physical, esim), 
updated_at
(string), 
version
(string), 
voice_enabled
(boolean)
将提供的注册码对应的SIM卡注册到当前用户账号下。 如果提供了
sim_card_group_id
，则这些SIM卡会关联到对应分组，否则会使用当前用户的默认分组。
POST /actions/register/sim_cards
— 必填参数：
registration_codes
可选参数：
sim_card_group_id
（uuid）、
status
（枚举值：enabled, disabled, standby）、
tags
（字符串数组）
ruby
register = client.actions.register.create(registration_codes: ["0000000001", "0000000002", "0000000003"])

puts(register)
返回参数：
actions_in_progress
（布尔值）、
authorized_imeis
（数组 | 空）、
created_at
（字符串）、
current_billing_period_consumed_data
（对象）、
data_limit
（对象）、
eid
（字符串 | 空）、
esim_installation_status
（枚举值：released, disabled）、
iccid
（字符串）、
id
（uuid）、
imsi
（字符串）、
msisdn
（字符串）、
record_type
（字符串）、
resources_with_in_progress_actions
（对象数组）、
sim_card_group_id
（uuid）、
status
（对象）、
tags
（字符串数组）、
type
（枚举值：physical, esim）、
updated_at
（字符串）、
version
（字符串）、
voice_enabled
（布尔值）

List bulk SIM card actions

列出批量SIM卡操作

This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.
GET /bulk_sim_card_actions
ruby
page = client.bulk_sim_card_actions.list

puts(page)
Returns: 
action_type
(enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_actions_summary
(array[object]), 
updated_at
(string)
该API返回分页的批量SIM卡操作列表。批量SIM卡操作包含一组单个SIM卡操作的详情。
GET /bulk_sim_card_actions
ruby
page = client.bulk_sim_card_actions.list

puts(page)
返回参数：
action_type
（枚举值：bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_actions_summary
（对象数组）、
updated_at
（字符串）

Get bulk SIM card action details

获取批量SIM卡操作详情

This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions.
GET /bulk_sim_card_actions/{id}
ruby
bulk_sim_card_action = client.bulk_sim_card_actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(bulk_sim_card_action)
Returns: 
action_type
(enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_actions_summary
(array[object]), 
updated_at
(string)
该API获取单个批量SIM卡操作的信息。批量SIM卡操作包含一组单个SIM卡操作的详情。
GET /bulk_sim_card_actions/{id}
ruby
bulk_sim_card_action = client.bulk_sim_card_actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(bulk_sim_card_action)
返回参数：
action_type
（枚举值：bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_actions_summary
（对象数组）、
updated_at
（字符串）

List OTA updates

列出OTA更新

GET /ota_updates
ruby
page = client.ota_updates.list

puts(page)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
sim_card_id
(uuid), 
status
(enum: in-progress, completed, failed), 
type
(enum: sim_card_network_preferences), 
updated_at
(string)
GET /ota_updates
ruby
page = client.ota_updates.list

puts(page)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
sim_card_id
（uuid）、
status
（枚举值：in-progress, completed, failed）、
type
（枚举值：sim_card_network_preferences）、
updated_at
（字符串）

Get OTA update

获取OTA更新详情

This API returns the details of an Over the Air (OTA) update.
GET /ota_updates/{id}
ruby
ota_update = client.ota_updates.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(ota_update)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_id
(uuid), 
status
(enum: in-progress, completed, failed), 
type
(enum: sim_card_network_preferences), 
updated_at
(string)
该API返回空中下载（OTA）更新的详细信息。
GET /ota_updates/{id}
ruby
ota_update = client.ota_updates.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(ota_update)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_id
（uuid）、
status
（枚举值：in-progress, completed, failed）、
type
（枚举值：sim_card_network_preferences）、
updated_at
（字符串）

List SIM card actions

列出SIM卡操作

This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.
GET /sim_card_actions
ruby
page = client.sim_cards.actions.list

puts(page)
Returns: 
action_type
(enum: enable, enable_standby_sim_card, disable, set_standby), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object | null), 
sim_card_id
(uuid), 
status
(object), 
updated_at
(string)
该API返回分页的SIM卡操作列表，可通过指定筛选条件查询已有的异步操作集合。
GET /sim_card_actions
ruby
page = client.sim_cards.actions.list

puts(page)
返回参数：
action_type
（枚举值：enable, enable_standby_sim_card, disable, set_standby）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象 | 空）、
sim_card_id
（uuid）、
status
（对象）、
updated_at
（字符串）

Get SIM card action details

获取SIM卡操作详情

This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.
GET /sim_card_actions/{id}
ruby
action = client.sim_cards.actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(action)
Returns: 
action_type
(enum: enable, enable_standby_sim_card, disable, set_standby), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object | null), 
sim_card_id
(uuid), 
status
(object), 
updated_at
(string)
该API获取SIM卡操作的详细信息，用于跟进已有的异步操作进度。
GET /sim_card_actions/{id}
ruby
action = client.sim_cards.actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(action)
返回参数：
action_type
（枚举值：enable, enable_standby_sim_card, disable, set_standby）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象 | 空）、
sim_card_id
（uuid）、
status
（对象）、
updated_at
（字符串）

List SIM card data usage notifications

列出SIM卡流量使用通知

Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters.
GET /sim_card_data_usage_notifications
ruby
page = client.sim_card_data_usage_notifications.list

puts(page)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
sim_card_id
(uuid), 
threshold
(object), 
updated_at
(string)
返回分页的SIM卡流量使用通知列表，可通过指定筛选条件查询相关记录。
GET /sim_card_data_usage_notifications
ruby
page = client.sim_card_data_usage_notifications.list

puts(page)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
sim_card_id
（uuid）、
threshold
（对象）、
updated_at
（字符串）

Create a new SIM card data usage notification

创建新的SIM卡流量使用通知

Creates a new SIM card data usage notification.
POST /sim_card_data_usage_notifications
— Required: 
sim_card_id
, 
threshold
ruby
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.create(
  sim_card_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  threshold: {}
)

puts(sim_card_data_usage_notification)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
sim_card_id
(uuid), 
threshold
(object), 
updated_at
(string)
创建一条新的SIM卡流量使用通知。
POST /sim_card_data_usage_notifications
— 必填参数：
sim_card_id
、
threshold
ruby
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.create(
  sim_card_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  threshold: {}
)

puts(sim_card_data_usage_notification)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
sim_card_id
（uuid）、
threshold
（对象）、
updated_at
（字符串）

Get a single SIM card data usage notification

获取单个SIM卡流量使用通知

Get a single SIM Card Data Usage Notification.
GET /sim_card_data_usage_notifications/{id}
ruby
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_data_usage_notification)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
sim_card_id
(uuid), 
threshold
(object), 
updated_at
(string)
获取单条SIM卡流量使用通知的详情。
GET /sim_card_data_usage_notifications/{id}
ruby
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_data_usage_notification)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
sim_card_id
（uuid）、
threshold
（对象）、
updated_at
（字符串）

Updates information for a SIM Card Data Usage Notification

更新SIM卡流量使用通知

Updates information for a SIM Card Data Usage Notification.
PATCH /sim_card_data_usage_notifications/{id}
Optional: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
sim_card_id
(uuid), 
threshold
(object), 
updated_at
(string)
ruby
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_data_usage_notification)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
sim_card_id
(uuid), 
threshold
(object), 
updated_at
(string)
更新SIM卡流量使用通知的信息。
PATCH /sim_card_data_usage_notifications/{id}
可选参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
sim_card_id
（uuid）、
threshold
（对象）、
updated_at
（字符串）
ruby
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_data_usage_notification)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
sim_card_id
（uuid）、
threshold
（对象）、
updated_at
（字符串）

Delete SIM card data usage notifications

删除SIM卡流量使用通知

Delete the SIM Card Data Usage Notification.
DELETE /sim_card_data_usage_notifications/{id}
ruby
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_data_usage_notification)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
sim_card_id
(uuid), 
threshold
(object), 
updated_at
(string)
删除指定的SIM卡流量使用通知。
DELETE /sim_card_data_usage_notifications/{id}
ruby
sim_card_data_usage_notification = client.sim_card_data_usage_notifications.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_data_usage_notification)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
sim_card_id
（uuid）、
threshold
（对象）、
updated_at
（字符串）

List SIM card group actions

列出SIM卡分组操作

This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.
GET /sim_card_group_actions
ruby
page = client.sim_card_groups.actions.list

puts(page)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_group_id
(uuid), 
status
(enum: in-progress, completed, failed), 
type
(enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), 
updated_at
(string)
该API返回分页的SIM卡分组操作列表，可通过指定筛选条件查询已有的异步操作集合。
GET /sim_card_group_actions
ruby
page = client.sim_card_groups.actions.list

puts(page)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_group_id
（uuid）、
status
（枚举值：in-progress, completed, failed）、
type
（枚举值：set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist）、
updated_at
（字符串）

Get SIM card group action details

获取SIM卡分组操作详情

This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.
GET /sim_card_group_actions/{id}
ruby
action = client.sim_card_groups.actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(action)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_group_id
(uuid), 
status
(enum: in-progress, completed, failed), 
type
(enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), 
updated_at
(string)
该API获取SIM卡分组操作的详细信息，用于跟进已有的异步操作进度。
GET /sim_card_group_actions/{id}
ruby
action = client.sim_card_groups.actions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(action)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_group_id
（uuid）、
status
（枚举值：in-progress, completed, failed）、
type
（枚举值：set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist）、
updated_at
（字符串）

Get all SIM card groups

获取所有SIM卡分组

Get all SIM card groups belonging to the user that match the given filters.
GET /sim_card_groups
ruby
page = client.sim_card_groups.list

puts(page)
Returns: 
consumed_data
(object), 
created_at
(string), 
data_limit
(object), 
default
(boolean), 
id
(uuid), 
name
(string), 
private_wireless_gateway_id
(uuid), 
record_type
(string), 
sim_card_count
(integer), 
updated_at
(string), 
wireless_blocklist_id
(uuid)
获取当前用户名下符合筛选条件的所有SIM卡分组。
GET /sim_card_groups
ruby
page = client.sim_card_groups.list

puts(page)
返回参数：
consumed_data
（对象）、
created_at
（字符串）、
data_limit
（对象）、
default
（布尔值）、
id
（uuid）、
name
（字符串）、
private_wireless_gateway_id
（uuid）、
record_type
（字符串）、
sim_card_count
（整数）、
updated_at
（字符串）、
wireless_blocklist_id
（uuid）

Create a SIM card group

创建SIM卡分组

Creates a new SIM card group object
POST /sim_card_groups
— Required: 
name
Optional: 
data_limit
(object)
ruby
sim_card_group = client.sim_card_groups.create(name: "My Test Group")

puts(sim_card_group)
Returns: 
consumed_data
(object), 
created_at
(string), 
data_limit
(object), 
default
(boolean), 
id
(uuid), 
name
(string), 
private_wireless_gateway_id
(uuid), 
record_type
(string), 
updated_at
(string), 
wireless_blocklist_id
(uuid)
创建一个新的SIM卡分组对象
POST /sim_card_groups
— 必填参数：
name
可选参数：
data_limit
（对象）
ruby
sim_card_group = client.sim_card_groups.create(name: "My Test Group")

puts(sim_card_group)
返回参数：
consumed_data
（对象）、
created_at
（字符串）、
data_limit
（对象）、
default
（布尔值）、
id
（uuid）、
name
（字符串）、
private_wireless_gateway_id
（uuid）、
record_type
（字符串）、
updated_at
（字符串）、
wireless_blocklist_id
（uuid）

Get SIM card group

获取SIM卡分组

Returns the details regarding a specific SIM card group
GET /sim_card_groups/{id}
ruby
sim_card_group = client.sim_card_groups.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_group)
Returns: 
consumed_data
(object), 
created_at
(string), 
data_limit
(object), 
default
(boolean), 
id
(uuid), 
name
(string), 
private_wireless_gateway_id
(uuid), 
record_type
(string), 
updated_at
(string), 
wireless_blocklist_id
(uuid)
返回指定SIM卡分组的详细信息
GET /sim_card_groups/{id}
ruby
sim_card_group = client.sim_card_groups.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_group)
返回参数：
consumed_data
（对象）、
created_at
（字符串）、
data_limit
（对象）、
default
（布尔值）、
id
（uuid）、
name
（字符串）、
private_wireless_gateway_id
（uuid）、
record_type
（字符串）、
updated_at
（字符串）、
wireless_blocklist_id
（uuid）

Update a SIM card group

更新SIM卡分组

Updates a SIM card group
PATCH /sim_card_groups/{id}
Optional: 
data_limit
(object), 
name
(string)
ruby
sim_card_group = client.sim_card_groups.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_group)
Returns: 
consumed_data
(object), 
created_at
(string), 
data_limit
(object), 
default
(boolean), 
id
(uuid), 
name
(string), 
private_wireless_gateway_id
(uuid), 
record_type
(string), 
updated_at
(string), 
wireless_blocklist_id
(uuid)
更新指定SIM卡分组的信息
PATCH /sim_card_groups/{id}
可选参数：
data_limit
（对象）、
name
（字符串）
ruby
sim_card_group = client.sim_card_groups.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_group)
返回参数：
consumed_data
（对象）、
created_at
（字符串）、
data_limit
（对象）、
default
（布尔值）、
id
（uuid）、
name
（字符串）、
private_wireless_gateway_id
（uuid）、
record_type
（字符串）、
updated_at
（字符串）、
wireless_blocklist_id
（uuid）

Delete a SIM card group

删除SIM卡分组

Permanently deletes a SIM card group
DELETE /sim_card_groups/{id}
ruby
sim_card_group = client.sim_card_groups.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_group)
Returns: 
consumed_data
(object), 
created_at
(string), 
data_limit
(object), 
default
(boolean), 
id
(uuid), 
name
(string), 
private_wireless_gateway_id
(uuid), 
record_type
(string), 
updated_at
(string), 
wireless_blocklist_id
(uuid)
永久删除指定SIM卡分组
DELETE /sim_card_groups/{id}
ruby
sim_card_group = client.sim_card_groups.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_group)
返回参数：
consumed_data
（对象）、
created_at
（字符串）、
data_limit
（对象）、
default
（布尔值）、
id
（uuid）、
name
（字符串）、
private_wireless_gateway_id
（uuid）、
record_type
（字符串）、
updated_at
（字符串）、
wireless_blocklist_id
（uuid）

Request Private Wireless Gateway removal from SIM card group

移除SIM卡分组的私有无线网关

This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic handled by Telnyx's default mobile network configuration.
POST /sim_card_groups/{id}/actions/remove_private_wireless_gateway
ruby
response = client.sim_card_groups.actions.remove_private_wireless_gateway("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_group_id
(uuid), 
status
(enum: in-progress, completed, failed), 
type
(enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), 
updated_at
(string)
该操作会异步移除SIM卡分组已关联的私有无线网关配置。操作完成后，该分组下所有SIM卡的流量将由Telnyx默认移动网络配置处理。
POST /sim_card_groups/{id}/actions/remove_private_wireless_gateway
ruby
response = client.sim_card_groups.actions.remove_private_wireless_gateway("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_group_id
（uuid）、
status
（枚举值：in-progress, completed, failed）、
type
（枚举值：set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist）、
updated_at
（字符串）

Request Wireless Blocklist removal from SIM card group

移除SIM卡分组的无线黑名单

This action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group.
POST /sim_card_groups/{id}/actions/remove_wireless_blocklist
ruby
response = client.sim_card_groups.actions.remove_wireless_blocklist("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_group_id
(uuid), 
status
(enum: in-progress, completed, failed), 
type
(enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), 
updated_at
(string)
该操作会异步移除SIM卡分组下所有SIM卡关联的无线黑名单。
POST /sim_card_groups/{id}/actions/remove_wireless_blocklist
ruby
response = client.sim_card_groups.actions.remove_wireless_blocklist("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_group_id
（uuid）、
status
（枚举值：in-progress, completed, failed）、
type
（枚举值：set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist）、
updated_at
（字符串）

Request Private Wireless Gateway assignment for SIM card group

为SIM卡分组分配私有无线网关

This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic controlled by the associated Private Wireless Gateway. This operation will also imply that new SIM cards assigned to a group will inherit its network definitions.
POST /sim_card_groups/{id}/actions/set_private_wireless_gateway
— Required: 
private_wireless_gateway_id
ruby
response = client.sim_card_groups.actions.set_private_wireless_gateway(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  private_wireless_gateway_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
)

puts(response)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_group_id
(uuid), 
status
(enum: in-progress, completed, failed), 
type
(enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), 
updated_at
(string)
该操作会异步将已配置的私有无线网关分配给指定SIM卡分组。操作完成后，该分组下所有SIM卡的流量将由关联的私有无线网关管控，新加入该分组的SIM卡也会自动继承该网络配置。
POST /sim_card_groups/{id}/actions/set_private_wireless_gateway
— 必填参数：
private_wireless_gateway_id
ruby
response = client.sim_card_groups.actions.set_private_wireless_gateway(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  private_wireless_gateway_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
)

puts(response)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_group_id
（uuid）、
status
（枚举值：in-progress, completed, failed）、
type
（枚举值：set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist）、
updated_at
（字符串）

Request Wireless Blocklist assignment for SIM card group

为SIM卡分组分配无线黑名单

This action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group.
POST /sim_card_groups/{id}/actions/set_wireless_blocklist
— Required: 
wireless_blocklist_id
ruby
response = client.sim_card_groups.actions.set_wireless_blocklist(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  wireless_blocklist_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
)

puts(response)
Returns: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
sim_card_group_id
(uuid), 
status
(enum: in-progress, completed, failed), 
type
(enum: set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist), 
updated_at
(string)
该操作会异步将无线黑名单分配给指定SIM卡分组下的所有SIM卡。
POST /sim_card_groups/{id}/actions/set_wireless_blocklist
— 必填参数：
wireless_blocklist_id
ruby
response = client.sim_card_groups.actions.set_wireless_blocklist(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  wireless_blocklist_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
)

puts(response)
返回参数：
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
sim_card_group_id
（uuid）、
status
（枚举值：in-progress, completed, failed）、
type
（枚举值：set_private_wireless_gateway, remove_private_wireless_gateway, set_wireless_blocklist, remove_wireless_blocklist）、
updated_at
（字符串）

Preview SIM card orders

预览SIM卡订单

Preview SIM card order purchases.
POST /sim_card_order_preview
— Required: 
quantity
, 
address_id
ruby
response = client.sim_card_order_preview.preview(address_id: "1293384261075731499", quantity: 21)

puts(response)
Returns: 
quantity
(integer), 
record_type
(string), 
shipping_cost
(object), 
sim_cards_cost
(object), 
total_cost
(object)
预览SIM卡订单的购买信息。
POST /sim_card_order_preview
— 必填参数：
quantity
、
address_id
ruby
response = client.sim_card_order_preview.preview(address_id: "1293384261075731499", quantity: 21)

puts(response)
返回参数：
quantity
（整数）、
record_type
（字符串）、
shipping_cost
（对象）、
sim_cards_cost
（对象）、
total_cost
（对象）

Get all SIM card orders

获取所有SIM卡订单

Get all SIM card orders according to filters.
GET /sim_card_orders
ruby
page = client.sim_card_orders.list

puts(page)
Returns: 
cost
(object), 
created_at
(string), 
id
(uuid), 
order_address
(object), 
quantity
(integer), 
record_type
(string), 
status
(enum: pending, processing, ready_to_ship, shipped, delivered, canceled), 
tracking_url
(uri), 
updated_at
(string)
根据筛选条件获取所有SIM卡订单。
GET /sim_card_orders
ruby
page = client.sim_card_orders.list

puts(page)
返回参数：
cost
（对象）、
created_at
（字符串）、
id
（uuid）、
order_address
（对象）、
quantity
（整数）、
record_type
（字符串）、
status
（枚举值：pending, processing, ready_to_ship, shipped, delivered, canceled）、
tracking_url
（uri）、
updated_at
（字符串）

Create a SIM card order

创建SIM卡订单

Creates a new order for SIM cards.
POST /sim_card_orders
— Required: 
address_id
, 
quantity
ruby
sim_card_order = client.sim_card_orders.create(address_id: "1293384261075731499", quantity: 23, sim_card_group_id: "550e8400-e29b-41d4-a716-446655440000")
puts(sim_card_order)
Returns: 
cost
(object), 
created_at
(string), 
id
(uuid), 
order_address
(object), 
quantity
(integer), 
record_type
(string), 
status
(enum: pending, processing, ready_to_ship, shipped, delivered, canceled), 
tracking_url
(uri), 
updated_at
(string)
创建新的SIM卡采购订单。
POST /sim_card_orders
— 必填参数：
address_id
、
quantity
ruby
sim_card_order = client.sim_card_orders.create(address_id: "1293384261075731499", quantity: 23, sim_card_group_id: "550e8400-e29b-41d4-a716-446655440000")
puts(sim_card_order)
返回参数：
cost
（对象）、
created_at
（字符串）、
id
（uuid）、
order_address
（对象）、
quantity
（整数）、
record_type
（字符串）、
status
（枚举值：pending, processing, ready_to_ship, shipped, delivered, canceled）、
tracking_url
（uri）、
updated_at
（字符串）

Get a single SIM card order

获取单个SIM卡订单

Get a single SIM card order by its ID.
GET /sim_card_orders/{id}
ruby
sim_card_order = client.sim_card_orders.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_order)
Returns: 
cost
(object), 
created_at
(string), 
id
(uuid), 
order_address
(object), 
quantity
(integer), 
record_type
(string), 
status
(enum: pending, processing, ready_to_ship, shipped, delivered, canceled), 
tracking_url
(uri), 
updated_at
(string)
根据ID获取单个SIM卡订单的详情。
GET /sim_card_orders/{id}
ruby
sim_card_order = client.sim_card_orders.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card_order)
返回参数：
cost
（对象）、
created_at
（字符串）、
id
（uuid）、
order_address
（对象）、
quantity
（整数）、
record_type
（字符串）、
status
（枚举值：pending, processing, ready_to_ship, shipped, delivered, canceled）、
tracking_url
（uri）、
updated_at
（字符串）

Get all SIM cards

获取所有SIM卡

Get all SIM cards belonging to the user that match the given filters.
GET /sim_cards
ruby
page = client.sim_cards.list

puts(page)
Returns: 
actions_in_progress
(boolean), 
authorized_imeis
(array | null), 
created_at
(string), 
current_billing_period_consumed_data
(object), 
data_limit
(object), 
eid
(string | null), 
esim_installation_status
(enum: released, disabled), 
iccid
(string), 
id
(uuid), 
imsi
(string), 
msisdn
(string), 
record_type
(string), 
resources_with_in_progress_actions
(array[object]), 
sim_card_group_id
(uuid), 
status
(object), 
tags
(array[string]), 
type
(enum: physical, esim), 
updated_at
(string), 
version
(string), 
voice_enabled
(boolean)
获取当前用户名下符合筛选条件的所有SIM卡。
GET /sim_cards
ruby
page = client.sim_cards.list

puts(page)
返回参数：
actions_in_progress
（布尔值）、
authorized_imeis
（数组 | 空）、
created_at
（字符串）、
current_billing_period_consumed_data
（对象）、
data_limit
（对象）、
eid
（字符串 | 空）、
esim_installation_status
（枚举值：released, disabled）、
iccid
（字符串）、
id
（uuid）、
imsi
（字符串）、
msisdn
（字符串）、
record_type
（字符串）、
resources_with_in_progress_actions
（对象数组）、
sim_card_group_id
（uuid）、
status
（对象）、
tags
（字符串数组）、
type
（枚举值：physical, esim）、
updated_at
（字符串）、
version
（字符串）、
voice_enabled
（布尔值）

Request bulk disabling voice on SIM cards.

批量禁用SIM卡语音功能

This API triggers an asynchronous operation to disable voice on SIM cards belonging to a specified SIM Card Group. For each SIM Card a SIM Card Action will be generated.
POST /sim_cards/actions/bulk_disable_voice
— Required: 
sim_card_group_id
ruby
response = client.sim_cards.actions.bulk_disable_voice(sim_card_group_id: "6b14e151-8493-4fa1-8664-1cc4e6d14158")

puts(response)
Returns: 
action_type
(enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
updated_at
(string)
该API触发异步操作，禁用指定SIM卡分组下所有SIM卡的语音功能，每个SIM卡都会生成对应的SIM卡操作记录。
POST /sim_cards/actions/bulk_disable_voice
— 必填参数：
sim_card_group_id
ruby
response = client.sim_cards.actions.bulk_disable_voice(sim_card_group_id: "6b14e151-8493-4fa1-8664-1cc4e6d14158")

puts(response)
返回参数：
action_type
（枚举值：bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
updated_at
（字符串）

Request bulk enabling voice on SIM cards.

批量启用SIM卡语音功能

This API triggers an asynchronous operation to enable voice on SIM cards belonging to a specified SIM Card Group. For each SIM Card a SIM Card Action will be generated.
POST /sim_cards/actions/bulk_enable_voice
— Required: 
sim_card_group_id
ruby
response = client.sim_cards.actions.bulk_enable_voice(sim_card_group_id: "6b14e151-8493-4fa1-8664-1cc4e6d14158")

puts(response)
Returns: 
action_type
(enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
updated_at
(string)
该API触发异步操作，启用指定SIM卡分组下所有SIM卡的语音功能，每个SIM卡都会生成对应的SIM卡操作记录。
POST /sim_cards/actions/bulk_enable_voice
— 必填参数：
sim_card_group_id
ruby
response = client.sim_cards.actions.bulk_enable_voice(sim_card_group_id: "6b14e151-8493-4fa1-8664-1cc4e6d14158")

puts(response)
返回参数：
action_type
（枚举值：bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
updated_at
（字符串）

Request bulk setting SIM card public IPs.

批量设置SIM卡公网IP

This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards. For each SIM Card a SIM Card Action will be generated. The status of the SIM Card Action can be followed through the List SIM Card Action API.
POST /sim_cards/actions/bulk_set_public_ips
— Required: 
sim_card_ids
ruby
response = client.sim_cards.actions.bulk_set_public_ips(sim_card_ids: ["6b14e151-8493-4fa1-8664-1cc4e6d14158"])

puts(response)
Returns: 
action_type
(enum: bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object), 
updated_at
(string)
该API触发异步操作，为指定的每个SIM卡设置公网IP，每个SIM卡都会生成对应的SIM卡操作记录。可通过列出SIM卡操作接口跟进操作进度。
POST /sim_cards/actions/bulk_set_public_ips
— 必填参数：
sim_card_ids
ruby
response = client.sim_cards.actions.bulk_set_public_ips(sim_card_ids: ["6b14e151-8493-4fa1-8664-1cc4e6d14158"])

puts(response)
返回参数：
action_type
（枚举值：bulk_disable_voice, bulk_enable_voice, bulk_set_public_ips）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象）、
updated_at
（字符串）

Validate SIM cards registration codes

校验SIM卡注册码

It validates whether SIM card registration codes are valid or not.
POST /sim_cards/actions/validate_registration_codes
Optional: 
registration_codes
(array[string])
ruby
response = client.sim_cards.actions.validate_registration_codes

puts(response)
Returns: 
invalid_detail
(string | null), 
record_type
(string), 
registration_code
(string), 
valid
(boolean)
校验SIM卡注册码是否有效。
POST /sim_cards/actions/validate_registration_codes
可选参数：
registration_codes
（字符串数组）
ruby
response = client.sim_cards.actions.validate_registration_codes

puts(response)
返回参数：
invalid_detail
（字符串 | 空）、
record_type
（字符串）、
registration_code
（字符串）、
valid
（布尔值）

Get SIM card

获取SIM卡详情

Returns the details regarding a specific SIM card.
GET /sim_cards/{id}
ruby
sim_card = client.sim_cards.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card)
Returns: 
actions_in_progress
(boolean), 
authorized_imeis
(array | null), 
created_at
(string), 
current_billing_period_consumed_data
(object), 
current_device_location
(object), 
current_imei
(string), 
current_mcc
(string), 
current_mnc
(string), 
data_limit
(object), 
eid
(string | null), 
esim_installation_status
(enum: released, disabled), 
iccid
(string), 
id
(uuid), 
imsi
(string), 
ipv4
(string), 
ipv6
(string), 
live_data_session
(enum: connected, disconnected, unknown), 
msisdn
(string), 
pin_puk_codes
(object), 
record_type
(string), 
resources_with_in_progress_actions
(array[object]), 
sim_card_group_id
(uuid), 
status
(object), 
tags
(array[string]), 
type
(enum: physical, esim), 
updated_at
(string), 
version
(string), 
voice_enabled
(boolean)
返回指定SIM卡的详细信息。
GET /sim_cards/{id}
ruby
sim_card = client.sim_cards.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card)
返回参数：
actions_in_progress
（布尔值）、
authorized_imeis
（数组 | 空）、
created_at
（字符串）、
current_billing_period_consumed_data
（对象）、
current_device_location
（对象）、
current_imei
（字符串）、
current_mcc
（字符串）、
current_mnc
（字符串）、
data_limit
（对象）、
eid
（字符串 | 空）、
esim_installation_status
（枚举值：released, disabled）、
iccid
（字符串）、
id
（uuid）、
imsi
（字符串）、
ipv4
（字符串）、
ipv6
（字符串）、
live_data_session
（枚举值：connected, disconnected, unknown）、
msisdn
（字符串）、
pin_puk_codes
（对象）、
record_type
（字符串）、
resources_with_in_progress_actions
（对象数组）、
sim_card_group_id
（uuid）、
status
（对象）、
tags
（字符串数组）、
type
（枚举值：physical, esim）、
updated_at
（字符串）、
version
（字符串）、
voice_enabled
（布尔值）

Update a SIM card

更新SIM卡

Updates SIM card data
PATCH /sim_cards/{id}
Optional: 
actions_in_progress
(boolean), 
authorized_imeis
(array | null), 
created_at
(string), 
current_billing_period_consumed_data
(object), 
current_device_location
(object), 
current_imei
(string), 
current_mcc
(string), 
current_mnc
(string), 
data_limit
(object), 
eid
(string | null), 
esim_installation_status
(enum: released, disabled), 
iccid
(string), 
id
(uuid), 
imsi
(string), 
ipv4
(string), 
ipv6
(string), 
live_data_session
(enum: connected, disconnected, unknown), 
msisdn
(string), 
pin_puk_codes
(object), 
record_type
(string), 
resources_with_in_progress_actions
(array[object]), 
sim_card_group_id
(uuid), 
status
(object), 
tags
(array[string]), 
type
(enum: physical, esim), 
updated_at
(string), 
version
(string), 
voice_enabled
(boolean)
ruby
sim_card = client.sim_cards.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card)
Returns: 
actions_in_progress
(boolean), 
authorized_imeis
(array | null), 
created_at
(string), 
current_billing_period_consumed_data
(object), 
current_device_location
(object), 
current_imei
(string), 
current_mcc
(string), 
current_mnc
(string), 
data_limit
(object), 
eid
(string | null), 
esim_installation_status
(enum: released, disabled), 
iccid
(string), 
id
(uuid), 
imsi
(string), 
ipv4
(string), 
ipv6
(string), 
live_data_session
(enum: connected, disconnected, unknown), 
msisdn
(string), 
pin_puk_codes
(object), 
record_type
(string), 
resources_with_in_progress_actions
(array[object]), 
sim_card_group_id
(uuid), 
status
(object), 
tags
(array[string]), 
type
(enum: physical, esim), 
updated_at
(string), 
version
(string), 
voice_enabled
(boolean)
更新SIM卡的信息
PATCH /sim_cards/{id}
可选参数：
actions_in_progress
（布尔值）、
authorized_imeis
（数组 | 空）、
created_at
（字符串）、
current_billing_period_consumed_data
（对象）、
current_device_location
（对象）、
current_imei
（字符串）、
current_mcc
（字符串）、
current_mnc
（字符串）、
data_limit
（对象）、
eid
（字符串 | 空）、
esim_installation_status
（枚举值：released, disabled）、
iccid
（字符串）、
id
（uuid）、
imsi
（字符串）、
ipv4
（字符串）、
ipv6
（字符串）、
live_data_session
（枚举值：connected, disconnected, unknown）、
msisdn
（字符串）、
pin_puk_codes
（对象）、
record_type
（字符串）、
resources_with_in_progress_actions
（对象数组）、
sim_card_group_id
（uuid）、
status
（对象）、
tags
（字符串数组）、
type
（枚举值：physical, esim）、
updated_at
（字符串）、
version
（字符串）、
voice_enabled
（布尔值）
ruby
sim_card = client.sim_cards.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card)
返回参数：
actions_in_progress
（布尔值）、
authorized_imeis
（数组 | 空）、
created_at
（字符串）、
current_billing_period_consumed_data
（对象）、
current_device_location
（对象）、
current_imei
（字符串）、
current_mcc
（字符串）、
current_mnc
（字符串）、
data_limit
（对象）、
eid
（字符串 | 空）、
esim_installation_status
（枚举值：released, disabled）、
iccid
（字符串）、
id
（uuid）、
imsi
（字符串）、
ipv4
（字符串）、
ipv6
（字符串）、
live_data_session
（枚举值：connected, disconnected, unknown）、
msisdn
（字符串）、
pin_puk_codes
（对象）、
record_type
（字符串）、
resources_with_in_progress_actions
（对象数组）、
sim_card_group_id
（uuid）、
status
（对象）、
tags
（字符串数组）、
type
（枚举值：physical, esim）、
updated_at
（字符串）、
version
（字符串）、
voice_enabled
（布尔值）

Deletes a SIM card

删除SIM卡

The SIM card will be decommissioned, removed from your account and you will stop being charged. The SIM card won't be able to connect to the network after the deletion is completed, thus making it impossible to consume data. Transitioning to the disabled state may take a period of time.
DELETE /sim_cards/{id}
ruby
sim_card = client.sim_cards.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card)
Returns: 
actions_in_progress
(boolean), 
authorized_imeis
(array | null), 
created_at
(string), 
current_billing_period_consumed_data
(object), 
current_device_location
(object), 
current_imei
(string), 
current_mcc
(string), 
current_mnc
(string), 
data_limit
(object), 
eid
(string | null), 
esim_installation_status
(enum: released, disabled), 
iccid
(string), 
id
(uuid), 
imsi
(string), 
ipv4
(string), 
ipv6
(string), 
live_data_session
(enum: connected, disconnected, unknown), 
msisdn
(string), 
pin_puk_codes
(object), 
record_type
(string), 
resources_with_in_progress_actions
(array[object]), 
sim_card_group_id
(uuid), 
status
(object), 
tags
(array[string]), 
type
(enum: physical, esim), 
updated_at
(string), 
version
(string), 
voice_enabled
(boolean)
SIM卡将被停用并从您的账号中移除，后续不会再产生费用。删除完成后该SIM卡无法连接网络，也无法使用流量。切换到停用状态可能需要一定时间。
DELETE /sim_cards/{id}
ruby
sim_card = client.sim_cards.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(sim_card)
返回参数：
actions_in_progress
（布尔值）、
authorized_imeis
（数组 | 空）、
created_at
（字符串）、
current_billing_period_consumed_data
（对象）、
current_device_location
（对象）、
current_imei
（字符串）、
current_mcc
（字符串）、
current_mnc
（字符串）、
data_limit
（对象）、
eid
（字符串 | 空）、
esim_installation_status
（枚举值：released, disabled）、
iccid
（字符串）、
id
（uuid）、
imsi
（字符串）、
ipv4
（字符串）、
ipv6
（字符串）、
live_data_session
（枚举值：connected, disconnected, unknown）、
msisdn
（字符串）、
pin_puk_codes
（对象）、
record_type
（字符串）、
resources_with_in_progress_actions
（对象数组）、
sim_card_group_id
（uuid）、
status
（对象）、
tags
（字符串数组）、
type
（枚举值：physical, esim）、
updated_at
（字符串）、
version
（字符串）、
voice_enabled
（布尔值）

Request a SIM card disable

申请停用SIM卡

This API disables a SIM card, disconnecting it from the network and making it impossible to consume data. The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the disabled state may take a period of time.
POST /sim_cards/{id}/actions/disable
ruby
response = client.sim_cards.actions.disable("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
action_type
(enum: enable, enable_standby_sim_card, disable, set_standby), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object | null), 
sim_card_id
(uuid), 
status
(object), 
updated_at
(string)
该API会停用SIM卡，断开其网络连接，使其无法使用流量。API会触发一个名为SIM卡操作的异步任务，切换到停用状态可能需要一定时间。
POST /sim_cards/{id}/actions/disable
ruby
response = client.sim_cards.actions.disable("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
action_type
（枚举值：enable, enable_standby_sim_card, disable, set_standby）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象 | 空）、
sim_card_id
（uuid）、
status
（对象）、
updated_at
（字符串）

Request a SIM card enable

申请启用SIM卡

This API enables a SIM card, connecting it to the network and making it possible to consume data. To enable a SIM card, it must be associated with a SIM card group. The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the enabled state may take a period of time.
POST /sim_cards/{id}/actions/enable
ruby
response = client.sim_cards.actions.enable("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
action_type
(enum: enable, enable_standby_sim_card, disable, set_standby), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object | null), 
sim_card_id
(uuid), 
status
(object), 
updated_at
(string)
该API会启用SIM卡，连接到网络使其可以使用流量。启用SIM卡前，必须先将其关联到某个SIM卡分组。API会触发一个名为SIM卡操作的异步任务，切换到启用状态可能需要一定时间。
POST /sim_cards/{id}/actions/enable
ruby
response = client.sim_cards.actions.enable("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
action_type
（枚举值：enable, enable_standby_sim_card, disable, set_standby）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象 | 空）、
sim_card_id
（uuid）、
status
（对象）、
updated_at
（字符串）

Request removing a SIM card public IP

移除SIM卡公网IP

This API removes an existing public IP from a SIM card.
The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API.
POST /sim_cards/{id}/actions/remove_public_ip
ruby
response = client.sim_cards.actions.remove_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
action_type
(enum: enable, enable_standby_sim_card, disable, set_standby), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object | null), 
sim_card_id
(uuid), 
status
(object), 
updated_at
(string)
该API移除SIM卡已绑定的公网IP，会触发一个名为SIM卡操作的异步任务。可通过列出SIM卡操作接口跟进操作进度。
POST /sim_cards/{id}/actions/remove_public_ip
ruby
response = client.sim_cards.actions.remove_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
action_type
（枚举值：enable, enable_standby_sim_card, disable, set_standby）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象 | 空）、
sim_card_id
（uuid）、
status
（对象）、
updated_at
（字符串）

Request setting a SIM card public IP

为SIM卡设置公网IP

This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card.
The API will trigger an asynchronous operation called a SIM Card Action.
POST /sim_cards/{id}/actions/set_public_ip
ruby
response = client.sim_cards.actions.set_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
action_type
(enum: enable, enable_standby_sim_card, disable, set_standby), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object | null), 
sim_card_id
(uuid), 
status
(object), 
updated_at
(string)
该API会为SIM卡分配随机公网IP，使其可以通过公网访问，会触发一个名为SIM卡操作的异步任务。
POST /sim_cards/{id}/actions/set_public_ip
ruby
response = client.sim_cards.actions.set_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
action_type
（枚举值：enable, enable_standby_sim_card, disable, set_standby）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象 | 空）、
sim_card_id
（uuid）、
status
（对象）、
updated_at
（字符串）

Request setting a SIM card to standby

申请将SIM卡设置为待机状态

The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data. To set a SIM card to standby, it must be associated with SIM card group. The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the standby state may take a period of time.
POST /sim_cards/{id}/actions/set_standby
ruby
response = client.sim_cards.actions.set_standby("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
action_type
(enum: enable, enable_standby_sim_card, disable, set_standby), 
created_at
(string), 
id
(uuid), 
record_type
(string), 
settings
(object | null), 
sim_card_id
(uuid), 
status
(object), 
updated_at
(string)
设置为待机状态的操作完成后，SIM卡可以连接网络并使用流量。设置待机状态前，必须先将SIM卡关联到某个SIM卡分组。API会触发一个名为SIM卡操作的异步任务，切换到待机状态可能需要一定时间。
POST /sim_cards/{id}/actions/set_standby
ruby
response = client.sim_cards.actions.set_standby("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
action_type
（枚举值：enable, enable_standby_sim_card, disable, set_standby）、
created_at
（字符串）、
id
（uuid）、
record_type
（字符串）、
settings
（对象 | 空）、
sim_card_id
（uuid）、
status
（对象）、
updated_at
（字符串）

Get activation code for an eSIM

获取eSIM激活码

It returns the activation code for an eSIM.
This API is only available for eSIMs. If the given SIM is a physical SIM card, or has already been installed, an error will be returned.
GET /sim_cards/{id}/activation_code
ruby
response = client.sim_cards.get_activation_code("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
activation_code
(string), 
record_type
(string)
返回eSIM的激活码。该API仅适用于eSIM，如果指定的是物理SIM卡或者已完成安装的eSIM，会返回错误。
GET /sim_cards/{id}/activation_code
ruby
response = client.sim_cards.get_activation_code("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
activation_code
（字符串）、
record_type
（字符串）

Get SIM card device details

获取SIM卡设备详情

It returns the device details where a SIM card is currently being used.
GET /sim_cards/{id}/device_details
ruby
response = client.sim_cards.get_device_details("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
brand_name
(string), 
device_type
(string), 
imei
(string), 
model_name
(string), 
operating_system
(string), 
record_type
(string)
返回当前正在使用该SIM卡的设备详细信息。
GET /sim_cards/{id}/device_details
ruby
response = client.sim_cards.get_device_details("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
brand_name
（字符串）、
device_type
（字符串）、
imei
（字符串）、
model_name
（字符串）、
operating_system
（字符串）、
record_type
（字符串）

Get SIM card public IP definition

获取SIM卡公网IP配置

It returns the public IP requested for a SIM card.
GET /sim_cards/{id}/public_ip
ruby
response = client.sim_cards.get_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
Returns: 
created_at
(string), 
ip
(string), 
record_type
(string), 
region_code
(string), 
sim_card_id
(uuid), 
type
(enum: ipv4), 
updated_at
(string)
返回为SIM卡申请的公网IP信息。
GET /sim_cards/{id}/public_ip
ruby
response = client.sim_cards.get_public_ip("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
返回参数：
created_at
（字符串）、
ip
（字符串）、
record_type
（字符串）、
region_code
（字符串）、
sim_card_id
（uuid）、
type
（枚举值：ipv4）、
updated_at
（字符串）

List wireless connectivity logs

列出无线连接日志

This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.
GET /sim_cards/{id}/wireless_connectivity_logs
ruby
page = client.sim_cards.list_wireless_connectivity_logs("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(page)
Returns: 
apn
(string), 
cell_id
(string), 
created_at
(string), 
id
(integer), 
imei
(string), 
imsi
(string), 
ipv4
(string), 
ipv6
(string), 
last_seen
(string), 
log_type
(enum: registration, data), 
mobile_country_code
(string), 
mobile_network_code
(string), 
radio_access_technology
(string), 
record_type
(string), 
sim_card_id
(uuid), 
start_time
(string), 
state
(string), 
stop_time
(string)
该API返回指定SIM卡关联的分页无线连接日志，用于排查问题。
GET /sim_cards/{id}/wireless_connectivity_logs
ruby
page = client.sim_cards.list_wireless_connectivity_logs("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(page)
返回参数：
apn
（字符串）、
cell_id
（字符串）、
created_at
（字符串）、
id
（整数）、
imei
（字符串）、
imsi
（字符串）、
ipv4
（字符串）、
ipv6
（字符串）、
last_seen
（字符串）、
log_type
（枚举值：registration, data）、
mobile_country_code
（字符串）、
mobile_network_code
（字符串）、
radio_access_technology
（字符串）、
record_type
（字符串）、
sim_card_id
（uuid）、
start_time
（字符串）、
state
（字符串）、
stop_time
（字符串）

List Migration Source coverage

列出迁移源覆盖区域

GET /storage/migration_source_coverage
ruby
response = client.storage.list_migration_source_coverage

puts(response)
Returns: 
provider
(enum: aws), 
source_region
(string)
GET /storage/migration_source_coverage
ruby
response = client.storage.list_migration_source_coverage

puts(response)
返回参数：
provider
（枚举值：aws）、
source_region
（字符串）

List all Migration Sources

列出所有迁移源

GET /storage/migration_sources
ruby
migration_sources = client.storage.migration_sources.list

puts(migration_sources)
Returns: 
bucket_name
(string), 
id
(string), 
provider
(enum: aws, telnyx), 
provider_auth
(object), 
source_region
(string)
GET /storage/migration_sources
ruby
migration_sources = client.storage.migration_sources.list

puts(migration_sources)
返回参数：
bucket_name
（字符串）、
id
（字符串）、
provider
（枚举值：aws, telnyx）、
provider_auth
（对象）、
source_region
（字符串）

Create a Migration Source

创建迁移源

Create a source from which data can be migrated from.
POST /storage/migration_sources
— Required: 
provider
, 
provider_auth
, 
bucket_name
Optional: 
id
(string), 
source_region
(string)
ruby
migration_source = client.storage.migration_sources.create(bucket_name: "my-bucket", provider: :aws, provider_auth: {})

puts(migration_source)
Returns: 
bucket_name
(string), 
id
(string), 
provider
(enum: aws, telnyx), 
provider_auth
(object), 
source_region
(string)
创建可用于数据迁移的源地址。
POST /storage/migration_sources
— 必填参数：
provider
、
provider_auth
、
bucket_name
可选参数：
id
（字符串）、
source_region
（字符串）
ruby
migration_source = client.storage.migration_sources.create(bucket_name: "my-bucket", provider: :aws, provider_auth: {})

puts(migration_source)
返回参数：
bucket_name
（字符串）、
id
（字符串）、
provider
（枚举值：aws, telnyx）、
provider_auth
（对象）、
source_region
（字符串）

Get a Migration Source

获取迁移源

GET /storage/migration_sources/{id}
ruby
migration_source = client.storage.migration_sources.retrieve("")

puts(migration_source)
Returns: 
bucket_name
(string), 
id
(string), 
provider
(enum: aws, telnyx), 
provider_auth
(object), 
source_region
(string)
GET /storage/migration_sources/{id}
ruby
migration_source = client.storage.migration_sources.retrieve("")

puts(migration_source)
返回参数：
bucket_name
（字符串）、
id
（字符串）、
provider
（枚举值：aws, telnyx）、
provider_auth
（对象）、
source_region
（字符串）

Delete a Migration Source

删除迁移源

DELETE /storage/migration_sources/{id}
ruby
migration_source = client.storage.migration_sources.delete("")

puts(migration_source)
Returns: 
bucket_name
(string), 
id
(string), 
provider
(enum: aws, telnyx), 
provider_auth
(object), 
source_region
(string)
DELETE /storage/migration_sources/{id}
ruby
migration_source = client.storage.migration_sources.delete("")

puts(migration_source)
返回参数：
bucket_name
（字符串）、
id
（字符串）、
provider
（枚举值：aws, telnyx）、
provider_auth
（对象）、
source_region
（字符串）

List all Migrations

列出所有迁移任务

GET /storage/migrations
ruby
migrations = client.storage.migrations.list

puts(migrations)
Returns: 
bytes_migrated
(integer), 
bytes_to_migrate
(integer), 
created_at
(date-time), 
eta
(date-time), 
id
(string), 
last_copy
(date-time), 
refresh
(boolean), 
source_id
(string), 
speed
(integer), 
status
(enum: pending, checking, migrating, complete, error, stopped), 
target_bucket_name
(string), 
target_region
(string)
GET /storage/migrations
ruby
migrations = client.storage.migrations.list

puts(migrations)
返回参数：
bytes_migrated
（整数）、
bytes_to_migrate
（整数）、
created_at
（日期时间）、
eta
（日期时间）、
id
（字符串）、
last_copy
（日期时间）、
refresh
（布尔值）、
source_id
（字符串）、
speed
（整数）、
status
（枚举值：pending, checking, migrating, complete, error, stopped）、
target_bucket_name
（字符串）、
target_region
（字符串）

Create a Migration

创建迁移任务

Initiate a migration of data from an external provider into Telnyx Cloud Storage. Currently, only S3 is supported.
POST /storage/migrations
— Required: 
source_id
, 
target_bucket_name
, 
target_region
Optional: 
bytes_migrated
(integer), 
bytes_to_migrate
(integer), 
created_at
(date-time), 
eta
(date-time), 
id
(string), 
last_copy
(date-time), 
refresh
(boolean), 
speed
(integer), 
status
(enum: pending, checking, migrating, complete, error, stopped)
ruby
migration = client.storage.migrations.create(
  source_id: "550e8400-e29b-41d4-a716-446655440000",
  target_bucket_name: "my-target-bucket",
  target_region: "us-central-1"
)

puts(migration)
Returns: 
bytes_migrated
(integer), 
bytes_to_migrate
(integer), 
created_at
(date-time), 
eta
(date-time), 
id
(string), 
last_copy
(date-time), 
refresh
(boolean), 
source_id
(string), 
speed
(integer), 
status
(enum: pending, checking, migrating, complete, error, stopped), 
target_bucket_name
(string), 
target_region
(string)
启动从外部服务到Telnyx云存储的数据迁移任务，目前仅支持S3。
POST /storage/migrations
— 必填参数：
source_id
、
target_bucket_name
、
target_region
可选参数：
bytes_migrated
（整数）、
bytes_to_migrate
（整数）、
created_at
（日期时间）、
eta
（日期时间）、
id
（字符串）、
last_copy
（日期时间）、
refresh
（布尔值）、
speed
（整数）、
status
（枚举值：pending, checking, migrating, complete, error, stopped）
ruby
migration = client.storage.migrations.create(
  source_id: "550e8400-e29b-41d4-a716-446655440000",
  target_bucket_name: "my-target-bucket",
  target_region: "us-central-1"
)

puts(migration)
返回参数：
bytes_migrated
（整数）、
bytes_to_migrate
（整数）、
created_at
（日期时间）、
eta
（日期时间）、
id
（字符串）、
last_copy
（日期时间）、
refresh
（布尔值）、
source_id
（字符串）、
speed
（整数）、
status
（枚举值：pending, checking, migrating, complete, error, stopped）、
target_bucket_name
（字符串）、
target_region
（字符串）

Get a Migration

获取迁移任务

GET /storage/migrations/{id}
ruby
migration = client.storage.migrations.retrieve("")

puts(migration)
Returns: 
bytes_migrated
(integer), 
bytes_to_migrate
(integer), 
created_at
(date-time), 
eta
(date-time), 
id
(string), 
last_copy
(date-time), 
refresh
(boolean), 
source_id
(string), 
speed
(integer), 
status
(enum: pending, checking, migrating, complete, error, stopped), 
target_bucket_name
(string), 
target_region
(string)
GET /storage/migrations/{id}
ruby
migration = client.storage.migrations.retrieve("")

puts(migration)
返回参数：
bytes_migrated
（整数）、
bytes_to_migrate
（整数）、
created_at
（日期时间）、
eta
（日期时间）、
id
（字符串）、
last_copy
（日期时间）、
refresh
（布尔值）、
source_id
（字符串）、
speed
（整数）、
status
（枚举值：pending, checking, migrating, complete, error, stopped）、
target_bucket_name
（字符串）、
target_region
（字符串）

Stop a Migration

停止迁移任务

POST /storage/migrations/{id}/actions/stop
ruby
response = client.storage.migrations.actions.stop("")

puts(response)
Returns: 
bytes_migrated
(integer), 
bytes_to_migrate
(integer), 
created_at
(date-time), 
eta
(date-time), 
id
(string), 
last_copy
(date-time), 
refresh
(boolean), 
source_id
(string), 
speed
(integer), 
status
(enum: pending, checking, migrating, complete, error, stopped), 
target_bucket_name
(string), 
target_region
(string)
POST /storage/migrations/{id}/actions/stop
ruby
response = client.storage.migrations.actions.stop("")

puts(response)
返回参数：
bytes_migrated
（整数）、
bytes_to_migrate
（整数）、
created_at
（日期时间）、
eta
（日期时间）、
id
（字符串）、
last_copy
（日期时间）、
refresh
（布尔值）、
source_id
（字符串）、
speed
（整数）、
status
（枚举值：pending, checking, migrating, complete, error, stopped）、
target_bucket_name
（字符串）、
target_region
（字符串）

List Mobile Voice Connections

列出移动语音连接

GET /v2/mobile_voice_connections
ruby
page = client.mobile_voice_connections.list

puts(page)
Returns: 
active
(boolean), 
connection_name
(string), 
created_at
(date-time), 
id
(string), 
inbound
(object), 
outbound
(object), 
record_type
(enum: mobile_voice_connection), 
tags
(array[string]), 
updated_at
(date-time), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(string | null), 
webhook_event_url
(string | null), 
webhook_timeout_secs
(integer | null)
GET /v2/mobile_voice_connections
ruby
page = client.mobile_voice_connections.list

puts(page)
返回参数：
active
（布尔值）、
connection_name
（字符串）、
created_at
（日期时间）、
id
（字符串）、
inbound
（对象）、
outbound
（对象）、
record_type
（枚举值：mobile_voice_connection）、
tags
（字符串数组）、
updated_at
（日期时间）、
webhook_api_version
（枚举值：1, 2）、
webhook_event_failover_url
（字符串 | 空）、
webhook_event_url
（字符串 | 空）、
webhook_timeout_secs
（整数 | 空）

Create a Mobile Voice Connection

创建移动语音连接

POST /v2/mobile_voice_connections
Optional: 
active
(boolean), 
connection_name
(string), 
inbound
(object), 
outbound
(object), 
tags
(array[string]), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(string | null), 
webhook_event_url
(string | null), 
webhook_timeout_secs
(integer | null)
ruby
mobile_voice_connection = client.mobile_voice_connections.create

puts(mobile_voice_connection)
Returns: 
active
(boolean), 
connection_name
(string), 
created_at
(date-time), 
id
(string), 
inbound
(object), 
outbound
(object), 
record_type
(enum: mobile_voice_connection), 
tags
(array[string]), 
updated_at
(date-time), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(string | null), 
webhook_event_url
(string | null), 
webhook_timeout_secs
(integer | null)
POST /v2/mobile_voice_connections
可选参数：
active
（布尔值）、
connection_name
（字符串）、
inbound
（对象）、
outbound
（对象）、
tags
（字符串数组）、
webhook_api_version
（枚举值：1, 2）、
webhook_event_failover_url
（字符串 | 空）、
webhook_event_url
（字符串 | 空）、
webhook_timeout_secs
（整数 | 空）
ruby
mobile_voice_connection = client.mobile_voice_connections.create

puts(mobile_voice_connection)
返回参数：
active
（布尔值）、
connection_name
（字符串）、
created_at
（日期时间）、
id
（字符串）、
inbound
（对象）、
outbound
（对象）、
record_type
（枚举值：mobile_voice_connection）、
tags
（字符串数组）、
updated_at
（日期时间）、
webhook_api_version
（枚举值：1, 2）、
webhook_event_failover_url
（字符串 | 空）、
webhook_event_url
（字符串 | 空）、
webhook_timeout_secs
（整数 | 空）

Retrieve a Mobile Voice Connection

查询移动语音连接

GET /v2/mobile_voice_connections/{id}
ruby
mobile_voice_connection = client.mobile_voice_connections.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_voice_connection)
Returns: 
active
(boolean), 
connection_name
(string), 
created_at
(date-time), 
id
(string), 
inbound
(object), 
outbound
(object), 
record_type
(enum: mobile_voice_connection), 
tags
(array[string]), 
updated_at
(date-time), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(string | null), 
webhook_event_url
(string | null), 
webhook_timeout_secs
(integer | null)
GET /v2/mobile_voice_connections/{id}
ruby
mobile_voice_connection = client.mobile_voice_connections.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_voice_connection)
返回参数：
active
（布尔值）、
connection_name
（字符串）、
created_at
（日期时间）、
id
（字符串）、
inbound
（对象）、
outbound
（对象）、
record_type
（枚举值：mobile_voice_connection）、
tags
（字符串数组）、
updated_at
（日期时间）、
webhook_api_version
（枚举值：1, 2）、
webhook_event_failover_url
（字符串 | 空）、
webhook_event_url
（字符串 | 空）、
webhook_timeout_secs
（整数 | 空）

Update a Mobile Voice Connection

更新移动语音连接

PATCH /v2/mobile_voice_connections/{id}
Optional: 
active
(boolean), 
connection_name
(string), 
inbound
(object), 
outbound
(object), 
tags
(array[string]), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(string | null), 
webhook_event_url
(string | null), 
webhook_timeout_secs
(integer)
ruby
mobile_voice_connection = client.mobile_voice_connections.update("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_voice_connection)
Returns: 
active
(boolean), 
connection_name
(string), 
created_at
(date-time), 
id
(string), 
inbound
(object), 
outbound
(object), 
record_type
(enum: mobile_voice_connection), 
tags
(array[string]), 
updated_at
(date-time), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(string | null), 
webhook_event_url
(string | null), 
webhook_timeout_secs
(integer | null)
PATCH /v2/mobile_voice_connections/{id}
可选参数：
active
（布尔值）、
connection_name
（字符串）、
inbound
（对象）、
outbound
（对象）、
tags
（字符串数组）、
webhook_api_version
（枚举值：1, 2）、
webhook_event_failover_url
（字符串 | 空）、
webhook_event_url
（字符串 | 空）、
webhook_timeout_secs
（整数）
ruby
mobile_voice_connection = client.mobile_voice_connections.update("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_voice_connection)
返回参数：
active
（布尔值）、
connection_name
（字符串）、
created_at
（日期时间）、
id
（字符串）、
inbound
（对象）、
outbound
（对象）、
record_type
（枚举值：mobile_voice_connection）、
tags
（字符串数组）、
updated_at
（日期时间）、
webhook_api_version
（枚举值：1, 2）、
webhook_event_failover_url
（字符串 | 空）、
webhook_event_url
（字符串 | 空）、
webhook_timeout_secs
（整数 | 空）

Delete a Mobile Voice Connection

删除移动语音连接

DELETE /v2/mobile_voice_connections/{id}
ruby
mobile_voice_connection = client.mobile_voice_connections.delete("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_voice_connection)
Returns: 
active
(boolean), 
connection_name
(string), 
created_at
(date-time), 
id
(string), 
inbound
(object), 
outbound
(object), 
record_type
(enum: mobile_voice_connection), 
tags
(array[string]), 
updated_at
(date-time), 
webhook_api_version
(enum: 1, 2), 
webhook_event_failover_url
(string | null), 
webhook_event_url
(string | null), 
webhook_timeout_secs
(integer | null)
DELETE /v2/mobile_voice_connections/{id}
ruby
mobile_voice_connection = client.mobile_voice_connections.delete("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_voice_connection)
返回参数：
active
（布尔值）、
connection_name
（字符串）、
created_at
（日期时间）、
id
（字符串）、
inbound
（对象）、
outbound
（对象）、
record_type
（枚举值：mobile_voice_connection）、
tags
（字符串数组）、
updated_at
（日期时间）、
webhook_api_version
（枚举值：1, 2）、
webhook_event_failover_url
（字符串 | 空）、
webhook_event_url
（字符串 | 空）、
webhook_timeout_secs
（整数 | 空）

Get all wireless regions

获取所有无线区域

Retrieve all wireless regions for the given product.
GET /wireless/regions
ruby
response = client.wireless.retrieve_regions(product: "public_ips")

puts(response)
Returns: 
code
(string), 
inserted_at
(date-time), 
name
(string), 
updated_at
(date-time)
查询指定产品支持的所有无线区域。
GET /wireless/regions
ruby
response = client.wireless.retrieve_regions(product: "public_ips")

puts(response)
返回参数：
code
（字符串）、
inserted_at
（日期时间）、
name
（字符串）、
updated_at
（日期时间）

Get all possible wireless blocklist values

获取所有可用的无线黑名单值

Retrieve all wireless blocklist values for a given blocklist type.
GET /wireless_blocklist_values
ruby
wireless_blocklist_values = client.wireless_blocklist_values.list(type: :country)

puts(wireless_blocklist_values)
Returns: 
data
(object), 
meta
(object)
查询指定类型的无线黑名单支持的所有可选值。
GET /wireless_blocklist_values
ruby
wireless_blocklist_values = client.wireless_blocklist_values.list(type: :country)

puts(wireless_blocklist_values)
返回参数：
data
（对象）、
meta
（对象）

Get all Wireless Blocklists

获取所有无线黑名单

Get all Wireless Blocklists belonging to the user.
GET /wireless_blocklists
ruby
page = client.wireless_blocklists.list

puts(page)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
type
(enum: country, mcc, plmn), 
updated_at
(string), 
values
(array[object])
获取当前用户名下的所有无线黑名单。
GET /wireless_blocklists
ruby
page = client.wireless_blocklists.list

puts(page)
返回参数：
created_at
（字符串）、
id
（uuid）、
name
（字符串）、
record_type
（字符串）、
type
（枚举值：country, mcc, plmn）、
updated_at
（字符串）、
values
（对象数组）

Create a Wireless Blocklist

创建无线黑名单

Create a Wireless Blocklist to prevent SIMs from connecting to certain networks.
POST /wireless_blocklists
— Required: 
name
, 
type
, 
values
ruby
wireless_blocklist = client.wireless_blocklists.create(name: "My Wireless Blocklist", type: :country, values: ["CA", "US"])

puts(wireless_blocklist)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
type
(enum: country, mcc, plmn), 
updated_at
(string), 
values
(array[object])
创建无线黑名单，用于阻止SIM卡连接到特定网络。
POST /wireless_blocklists
— 必填参数：
name
、
type
、
values
ruby
wireless_blocklist = client.wireless_blocklists.create(name: "My Wireless Blocklist", type: :country, values: ["CA", "US"])

puts(wireless_blocklist)
返回参数：
created_at
（字符串）、
id
（uuid）、
name
（字符串）、
record_type
（字符串）、
type
（枚举值：country, mcc, plmn）、
updated_at
（字符串）、
values
（对象数组）

Update a Wireless Blocklist

更新无线黑名单

Update a Wireless Blocklist.
PATCH /wireless_blocklists
Optional: 
name
(string), 
type
(enum: country, mcc, plmn), 
values
(array[object])
ruby
wireless_blocklist = client.wireless_blocklists.update

puts(wireless_blocklist)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
type
(enum: country, mcc, plmn), 
updated_at
(string), 
values
(array[object])
更新无线黑名单的信息。
PATCH /wireless_blocklists
可选参数：
name
（字符串）、
type
（枚举值：country, mcc, plmn）、
values
（对象数组）
ruby
wireless_blocklist = client.wireless_blocklists.update

puts(wireless_blocklist)
返回参数：
created_at
（字符串）、
id
（uuid）、
name
（字符串）、
record_type
（字符串）、
type
（枚举值：country, mcc, plmn）、
updated_at
（字符串）、
values
（对象数组）

Get a Wireless Blocklist

获取无线黑名单

Retrieve information about a Wireless Blocklist.
GET /wireless_blocklists/{id}
ruby
wireless_blocklist = client.wireless_blocklists.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireless_blocklist)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
type
(enum: country, mcc, plmn), 
updated_at
(string), 
values
(array[object])
查询指定无线黑名单的信息。
GET /wireless_blocklists/{id}
ruby
wireless_blocklist = client.wireless_blocklists.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireless_blocklist)
返回参数：
created_at
（字符串）、
id
（uuid）、
name
（字符串）、
record_type
（字符串）、
type
（枚举值：country, mcc, plmn）、
updated_at
（字符串）、
values
（对象数组）

Delete a Wireless Blocklist

删除无线黑名单

Deletes the Wireless Blocklist.
DELETE /wireless_blocklists/{id}
ruby
wireless_blocklist = client.wireless_blocklists.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireless_blocklist)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
type
(enum: country, mcc, plmn), 
updated_at
(string), 
values
(array[object])
删除指定的无线黑名单。
DELETE /wireless_blocklists/{id}
ruby
wireless_blocklist = client.wireless_blocklists.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireless_blocklist)
返回参数：
created_at
（字符串）、
id
（uuid）、
name
（字符串）、
record_type
（字符串）、
type
（枚举值：country, mcc, plmn）、
updated_at
（字符串）、
values
（对象数组）