telnyx-numbers-config-ruby

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

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

Telnyx Numbers Config - 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

重要注意事项

  • Phone numbers must be in E.164 format (e.g.,
    +13125550001
    ). Include the
    +
    prefix and country code. No spaces, dashes, or parentheses.
  • Pagination: Use
    .auto_paging_each
    for automatic iteration:
    page.auto_paging_each { |item| puts item.id }
    .
  • 电话号码必须符合E.164格式(例如:
    +13125550001
    ),需包含
    +
    前缀和国家码,不得包含空格、短横线或括号。
  • 分页: 使用
    .auto_paging_each
    实现自动遍历分页结果:
    page.auto_paging_each { |item| puts item.id }

Bulk update phone number profiles

批量更新电话号码配置文件

POST /messaging_numbers_bulk_updates
— Required:
messaging_profile_id
,
numbers
Optional:
assign_only
(boolean)
ruby
messaging_numbers_bulk_update = client.messaging_numbers_bulk_updates.create(
  messaging_profile_id: "00000000-0000-0000-0000-000000000000",
  numbers: ["+18880000000", "+18880000001", "+18880000002"]
)

puts(messaging_numbers_bulk_update)
Returns:
failed
(array[string]),
order_id
(uuid),
pending
(array[string]),
record_type
(enum: messaging_numbers_bulk_update),
success
(array[string])
POST /messaging_numbers_bulk_updates
— 必填参数:
messaging_profile_id
numbers
可选参数:
assign_only
(布尔值)
ruby
messaging_numbers_bulk_update = client.messaging_numbers_bulk_updates.create(
  messaging_profile_id: "00000000-0000-0000-0000-000000000000",
  numbers: ["+18880000000", "+18880000001", "+18880000002"]
)

puts(messaging_numbers_bulk_update)
返回参数:
failed
(字符串数组)、
order_id
(UUID)、
pending
(字符串数组)、
record_type
(枚举值:messaging_numbers_bulk_update)、
success
(字符串数组)

Retrieve bulk update status

查询批量更新任务状态

GET /messaging_numbers_bulk_updates/{order_id}
ruby
messaging_numbers_bulk_update = client.messaging_numbers_bulk_updates.retrieve("order_id")

puts(messaging_numbers_bulk_update)
Returns:
failed
(array[string]),
order_id
(uuid),
pending
(array[string]),
record_type
(enum: messaging_numbers_bulk_update),
success
(array[string])
GET /messaging_numbers_bulk_updates/{order_id}
ruby
messaging_numbers_bulk_update = client.messaging_numbers_bulk_updates.retrieve("order_id")

puts(messaging_numbers_bulk_update)
返回参数:
failed
(字符串数组)、
order_id
(UUID)、
pending
(字符串数组)、
record_type
(枚举值:messaging_numbers_bulk_update)、
success
(字符串数组)

List mobile phone numbers with messaging settings

查询带消息配置的手机号码列表

GET /mobile_phone_numbers/messaging
ruby
page = client.mobile_phone_numbers.messaging.list

puts(page)
Returns:
country_code
(string),
created_at
(date-time),
features
(object),
id
(string),
messaging_product
(string),
messaging_profile_id
(string | null),
organization_id
(string),
phone_number
(string),
record_type
(enum: messaging_phone_number, messaging_settings),
tags
(array[string]),
traffic_type
(string),
type
(enum: longcode),
updated_at
(date-time)
GET /mobile_phone_numbers/messaging
ruby
page = client.mobile_phone_numbers.messaging.list

puts(page)
返回参数:
country_code
(字符串)、
created_at
(日期时间)、
features
(对象)、
id
(字符串)、
messaging_product
(字符串)、
messaging_profile_id
(字符串 / 空)、
organization_id
(字符串)、
phone_number
(字符串)、
record_type
(枚举值:messaging_phone_number、messaging_settings)、
tags
(字符串数组)、
traffic_type
(字符串)、
type
(枚举值:longcode)、
updated_at
(日期时间)

Retrieve a mobile phone number with messaging settings

查询单条带消息配置的手机号码

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

puts(messaging)
Returns:
country_code
(string),
created_at
(date-time),
features
(object),
id
(string),
messaging_product
(string),
messaging_profile_id
(string | null),
organization_id
(string),
phone_number
(string),
record_type
(enum: messaging_phone_number, messaging_settings),
tags
(array[string]),
traffic_type
(string),
type
(enum: longcode),
updated_at
(date-time)
GET /mobile_phone_numbers/{id}/messaging
ruby
messaging = client.mobile_phone_numbers.messaging.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(messaging)
返回参数:
country_code
(字符串)、
created_at
(日期时间)、
features
(对象)、
id
(字符串)、
messaging_product
(字符串)、
messaging_profile_id
(字符串 / 空)、
organization_id
(字符串)、
phone_number
(字符串)、
record_type
(枚举值:messaging_phone_number、messaging_settings)、
tags
(字符串数组)、
traffic_type
(字符串)、
type
(枚举值:longcode)、
updated_at
(日期时间)

List phone numbers

查询电话号码列表

GET /phone_numbers
ruby
page = client.phone_numbers.list

puts(page)
Returns:
billing_group_id
(string | null),
call_forwarding_enabled
(boolean),
call_recording_enabled
(boolean),
caller_id_name_enabled
(boolean),
cnam_listing_enabled
(boolean),
connection_id
(string | null),
connection_name
(string | null),
country_iso_alpha2
(string),
created_at
(date-time),
customer_reference
(string | null),
deletion_lock_enabled
(boolean),
emergency_address_id
(string | null),
emergency_enabled
(boolean),
emergency_status
(enum: active, deprovisioning, disabled, provisioning, provisioning-failed),
external_pin
(string | null),
hd_voice_enabled
(boolean),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
messaging_profile_id
(string | null),
messaging_profile_name
(string | null),
phone_number
(string),
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode),
purchased_at
(string),
record_type
(string),
source_type
(object),
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending),
t38_fax_gateway_enabled
(boolean),
tags
(array[string]),
updated_at
(string)
GET /phone_numbers
ruby
page = client.phone_numbers.list

puts(page)
返回参数:
billing_group_id
(字符串 / 空)、
call_forwarding_enabled
(布尔值)、
call_recording_enabled
(布尔值)、
caller_id_name_enabled
(布尔值)、
cnam_listing_enabled
(布尔值)、
connection_id
(字符串 / 空)、
connection_name
(字符串 / 空)、
country_iso_alpha2
(字符串)、
created_at
(日期时间)、
customer_reference
(字符串 / 空)、
deletion_lock_enabled
(布尔值)、
emergency_address_id
(字符串 / 空)、
emergency_enabled
(布尔值)、
emergency_status
(枚举值:active、deprovisioning、disabled、provisioning、provisioning-failed)、
external_pin
(字符串 / 空)、
hd_voice_enabled
(布尔值)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
messaging_profile_id
(字符串 / 空)、
messaging_profile_name
(字符串 / 空)、
phone_number
(字符串)、
phone_number_type
(枚举值:local、toll_free、mobile、national、shared_cost、landline、tollfree、shortcode、longcode)、
purchased_at
(字符串)、
record_type
(字符串)、
source_type
(对象)、
status
(枚举值:purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending、requirement-info-pending、requirement-info-under-review、requirement-info-exception、provision-pending)、
t38_fax_gateway_enabled
(布尔值)、
tags
(字符串数组)、
updated_at
(字符串)

Verify ownership of phone numbers

验证电话号码归属权

Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account.
POST /phone_numbers/actions/verify_ownership
— Required:
phone_numbers
ruby
response = client.phone_numbers.actions.verify_ownership(phone_numbers: ["+15551234567"])

puts(response)
Returns:
found
(array[object]),
not_found
(array[string]),
record_type
(string)
验证传入的电话号码归属权,返回号码与对应ID的映射关系,以及账号下不存在的号码列表。
POST /phone_numbers/actions/verify_ownership
— 必填参数:
phone_numbers
ruby
response = client.phone_numbers.actions.verify_ownership(phone_numbers: ["+15551234567"])

puts(response)
返回参数:
found
(对象数组)、
not_found
(字符串数组)、
record_type
(字符串)

Lists the phone numbers jobs

查询电话号码任务列表

GET /phone_numbers/jobs
ruby
page = client.phone_numbers.jobs.list

puts(page)
Returns:
created_at
(string),
etc
(date-time),
failed_operations
(array[object]),
id
(uuid),
pending_operations
(array[object]),
phone_numbers
(array[object]),
record_type
(string),
status
(enum: pending, in_progress, completed, failed, expired),
successful_operations
(array[object]),
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers),
updated_at
(string)
GET /phone_numbers/jobs
ruby
page = client.phone_numbers.jobs.list

puts(page)
返回参数:
created_at
(字符串)、
etc
(日期时间)、
failed_operations
(对象数组)、
id
(UUID)、
pending_operations
(对象数组)、
phone_numbers
(对象数组)、
record_type
(字符串)、
status
(枚举值:pending、in_progress、completed、failed、expired)、
successful_operations
(对象数组)、
type
(枚举值:update_emergency_settings、delete_phone_numbers、update_phone_numbers)、
updated_at
(字符串)

Delete a batch of numbers

批量删除电话号码

Creates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call.
POST /phone_numbers/jobs/delete_phone_numbers
— Required:
phone_numbers
ruby
response = client.phone_numbers.jobs.delete_batch(phone_numbers: ["+19705555098", "+19715555098", "32873127836"])

puts(response)
Returns:
created_at
(string),
etc
(date-time),
failed_operations
(array[object]),
id
(uuid),
pending_operations
(array[object]),
phone_numbers
(array[object]),
record_type
(string),
status
(enum: pending, in_progress, completed, failed, expired),
successful_operations
(array[object]),
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers),
updated_at
(string)
创建后台任务批量删除电话号码,单次API调用最多可操作1000个号码。
POST /phone_numbers/jobs/delete_phone_numbers
— 必填参数:
phone_numbers
ruby
response = client.phone_numbers.jobs.delete_batch(phone_numbers: ["+19705555098", "+19715555098", "32873127836"])

puts(response)
返回参数:
created_at
(字符串)、
etc
(日期时间)、
failed_operations
(对象数组)、
id
(UUID)、
pending_operations
(对象数组)、
phone_numbers
(对象数组)、
record_type
(字符串)、
status
(枚举值:pending、in_progress、completed、failed、expired)、
successful_operations
(对象数组)、
type
(枚举值:update_emergency_settings、delete_phone_numbers、update_phone_numbers)、
updated_at
(字符串)

Update the emergency settings from a batch of numbers

批量更新电话号码紧急设置

Creates a background job to update the emergency settings of a collection of phone numbers. At most one thousand numbers can be updated per API call.
POST /phone_numbers/jobs/update_emergency_settings
— Required:
emergency_enabled
,
phone_numbers
Optional:
emergency_address_id
(string | null)
ruby
response = client.phone_numbers.jobs.update_emergency_settings_batch(
  emergency_enabled: true,
  phone_numbers: ["+19705555098", "+19715555098", "32873127836"]
)

puts(response)
Returns:
created_at
(string),
etc
(date-time),
failed_operations
(array[object]),
id
(uuid),
pending_operations
(array[object]),
phone_numbers
(array[object]),
record_type
(string),
status
(enum: pending, in_progress, completed, failed, expired),
successful_operations
(array[object]),
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers),
updated_at
(string)
创建后台任务批量更新一组电话号码的紧急设置,单次API调用最多可操作1000个号码。
POST /phone_numbers/jobs/update_emergency_settings
— 必填参数:
emergency_enabled
phone_numbers
可选参数:
emergency_address_id
(字符串 / 空)
ruby
response = client.phone_numbers.jobs.update_emergency_settings_batch(
  emergency_enabled: true,
  phone_numbers: ["+19705555098", "+19715555098", "32873127836"]
)

puts(response)
返回参数:
created_at
(字符串)、
etc
(日期时间)、
failed_operations
(对象数组)、
id
(UUID)、
pending_operations
(对象数组)、
phone_numbers
(对象数组)、
record_type
(字符串)、
status
(枚举值:pending、in_progress、completed、failed、expired)、
successful_operations
(对象数组)、
type
(枚举值:update_emergency_settings、delete_phone_numbers、update_phone_numbers)、
updated_at
(字符串)

Update a batch of numbers

批量更新电话号码

Creates a new background job to update a batch of numbers. At most one thousand numbers can be updated per API call. At least one of the updateable fields must be submitted.
POST /phone_numbers/jobs/update_phone_numbers
— Required:
phone_numbers
Optional:
billing_group_id
(string),
connection_id
(string),
customer_reference
(string),
deletion_lock_enabled
(boolean),
external_pin
(string),
hd_voice_enabled
(boolean),
tags
(array[string]),
voice
(object)
ruby
response = client.phone_numbers.jobs.update_batch(phone_numbers: ["1583466971586889004", "+13127367254"])

puts(response)
Returns:
created_at
(string),
etc
(date-time),
failed_operations
(array[object]),
id
(uuid),
pending_operations
(array[object]),
phone_numbers
(array[object]),
record_type
(string),
status
(enum: pending, in_progress, completed, failed, expired),
successful_operations
(array[object]),
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers),
updated_at
(string)
创建后台任务批量更新电话号码,单次API调用最多可操作1000个号码,至少需要传入一个可更新字段。
POST /phone_numbers/jobs/update_phone_numbers
— 必填参数:
phone_numbers
可选参数:
billing_group_id
(字符串)、
connection_id
(字符串)、
customer_reference
(字符串)、
deletion_lock_enabled
(布尔值)、
external_pin
(字符串)、
hd_voice_enabled
(布尔值)、
tags
(字符串数组)、
voice
(对象)
ruby
response = client.phone_numbers.jobs.update_batch(phone_numbers: ["1583466971586889004", "+13127367254"])

puts(response)
返回参数:
created_at
(字符串)、
etc
(日期时间)、
failed_operations
(对象数组)、
id
(UUID)、
pending_operations
(对象数组)、
phone_numbers
(对象数组)、
record_type
(字符串)、
status
(枚举值:pending、in_progress、completed、failed、expired)、
successful_operations
(对象数组)、
type
(枚举值:update_emergency_settings、delete_phone_numbers、update_phone_numbers)、
updated_at
(字符串)

Retrieve a phone numbers job

查询单条电话号码任务

GET /phone_numbers/jobs/{id}
ruby
job = client.phone_numbers.jobs.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(job)
Returns:
created_at
(string),
etc
(date-time),
failed_operations
(array[object]),
id
(uuid),
pending_operations
(array[object]),
phone_numbers
(array[object]),
record_type
(string),
status
(enum: pending, in_progress, completed, failed, expired),
successful_operations
(array[object]),
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers),
updated_at
(string)
GET /phone_numbers/jobs/{id}
ruby
job = client.phone_numbers.jobs.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(job)
返回参数:
created_at
(字符串)、
etc
(日期时间)、
failed_operations
(对象数组)、
id
(UUID)、
pending_operations
(对象数组)、
phone_numbers
(对象数组)、
record_type
(字符串)、
status
(枚举值:pending、in_progress、completed、failed、expired)、
successful_operations
(对象数组)、
type
(枚举值:update_emergency_settings、delete_phone_numbers、update_phone_numbers)、
updated_at
(字符串)

List phone numbers with messaging settings

查询带消息配置的电话号码列表

GET /phone_numbers/messaging
ruby
page = client.phone_numbers.messaging.list

puts(page)
Returns:
country_code
(string),
created_at
(date-time),
eligible_messaging_products
(array[string]),
features
(object),
health
(object),
id
(string),
messaging_product
(string),
messaging_profile_id
(string | null),
organization_id
(string),
phone_number
(string),
record_type
(enum: messaging_phone_number, messaging_settings),
tags
(array[string]),
traffic_type
(string),
type
(enum: long-code, toll-free, short-code, longcode, tollfree, shortcode),
updated_at
(date-time)
GET /phone_numbers/messaging
ruby
page = client.phone_numbers.messaging.list

puts(page)
返回参数:
country_code
(字符串)、
created_at
(日期时间)、
eligible_messaging_products
(字符串数组)、
features
(对象)、
health
(对象)、
id
(字符串)、
messaging_product
(字符串)、
messaging_profile_id
(字符串 / 空)、
organization_id
(字符串)、
phone_number
(字符串)、
record_type
(枚举值:messaging_phone_number、messaging_settings)、
tags
(字符串数组)、
traffic_type
(字符串)、
type
(枚举值:long-code、toll-free、short-code、longcode、tollfree、shortcode)、
updated_at
(日期时间)

Slim List phone numbers

精简版电话号码列表查询

List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.
GET /phone_numbers/slim
ruby
page = client.phone_numbers.slim_list

puts(page)
Returns:
billing_group_id
(string),
call_forwarding_enabled
(boolean),
call_recording_enabled
(boolean),
caller_id_name_enabled
(boolean),
cnam_listing_enabled
(boolean),
connection_id
(string),
country_iso_alpha2
(string),
created_at
(string),
customer_reference
(string),
emergency_address_id
(string),
emergency_enabled
(boolean),
emergency_status
(enum: active, deprovisioning, disabled, provisioning, provisioning-failed),
external_pin
(string),
hd_voice_enabled
(boolean),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
phone_number
(string),
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode),
purchased_at
(string),
record_type
(string),
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending),
t38_fax_gateway_enabled
(boolean),
updated_at
(string)
查询电话号码列表,该接口是/phone_numbers接口的轻量版本,拥有更高的性能和速率限制。
GET /phone_numbers/slim
ruby
page = client.phone_numbers.slim_list

puts(page)
返回参数:
billing_group_id
(字符串)、
call_forwarding_enabled
(布尔值)、
call_recording_enabled
(布尔值)、
caller_id_name_enabled
(布尔值)、
cnam_listing_enabled
(布尔值)、
connection_id
(字符串)、
country_iso_alpha2
(字符串)、
created_at
(字符串)、
customer_reference
(字符串)、
emergency_address_id
(字符串)、
emergency_enabled
(布尔值)、
emergency_status
(枚举值:active、deprovisioning、disabled、provisioning、provisioning-failed)、
external_pin
(字符串)、
hd_voice_enabled
(布尔值)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
phone_number
(字符串)、
phone_number_type
(枚举值:local、toll_free、mobile、national、shared_cost、landline、tollfree、shortcode、longcode)、
purchased_at
(字符串)、
record_type
(字符串)、
status
(枚举值:purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending、requirement-info-pending、requirement-info-under-review、requirement-info-exception、provision-pending)、
t38_fax_gateway_enabled
(布尔值)、
updated_at
(字符串)

List phone numbers with voice settings

查询带语音配置的电话号码列表

GET /phone_numbers/voice
ruby
page = client.phone_numbers.voice.list

puts(page)
Returns:
call_forwarding
(object),
call_recording
(object),
cnam_listing
(object),
connection_id
(string),
customer_reference
(string),
emergency
(object),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
media_features
(object),
phone_number
(string),
record_type
(string),
tech_prefix_enabled
(boolean),
translated_number
(string),
usage_payment_method
(enum: pay-per-minute, channel)
GET /phone_numbers/voice
ruby
page = client.phone_numbers.voice.list

puts(page)
返回参数:
call_forwarding
(对象)、
call_recording
(对象)、
cnam_listing
(对象)、
connection_id
(字符串)、
customer_reference
(字符串)、
emergency
(对象)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
media_features
(对象)、
phone_number
(字符串)、
record_type
(字符串)、
tech_prefix_enabled
(布尔值)、
translated_number
(字符串)、
usage_payment_method
(枚举值:pay-per-minute、channel)

Retrieve a phone number

查询单条电话号码

GET /phone_numbers/{id}
ruby
phone_number = client.phone_numbers.retrieve("1293384261075731499")

puts(phone_number)
Returns:
billing_group_id
(string | null),
call_forwarding_enabled
(boolean),
call_recording_enabled
(boolean),
caller_id_name_enabled
(boolean),
cnam_listing_enabled
(boolean),
connection_id
(string | null),
connection_name
(string | null),
country_iso_alpha2
(string),
created_at
(date-time),
customer_reference
(string | null),
deletion_lock_enabled
(boolean),
emergency_address_id
(string | null),
emergency_enabled
(boolean),
emergency_status
(enum: active, deprovisioning, disabled, provisioning, provisioning-failed),
external_pin
(string | null),
hd_voice_enabled
(boolean),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
messaging_profile_id
(string | null),
messaging_profile_name
(string | null),
phone_number
(string),
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode),
purchased_at
(string),
record_type
(string),
source_type
(object),
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending),
t38_fax_gateway_enabled
(boolean),
tags
(array[string]),
updated_at
(string)
GET /phone_numbers/{id}
ruby
phone_number = client.phone_numbers.retrieve("1293384261075731499")

puts(phone_number)
返回参数:
billing_group_id
(字符串 / 空)、
call_forwarding_enabled
(布尔值)、
call_recording_enabled
(布尔值)、
caller_id_name_enabled
(布尔值)、
cnam_listing_enabled
(布尔值)、
connection_id
(字符串 / 空)、
connection_name
(字符串 / 空)、
country_iso_alpha2
(字符串)、
created_at
(日期时间)、
customer_reference
(字符串 / 空)、
deletion_lock_enabled
(布尔值)、
emergency_address_id
(字符串 / 空)、
emergency_enabled
(布尔值)、
emergency_status
(枚举值:active、deprovisioning、disabled、provisioning、provisioning-failed)、
external_pin
(字符串 / 空)、
hd_voice_enabled
(布尔值)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
messaging_profile_id
(字符串 / 空)、
messaging_profile_name
(字符串 / 空)、
phone_number
(字符串)、
phone_number_type
(枚举值:local、toll_free、mobile、national、shared_cost、landline、tollfree、shortcode、longcode)、
purchased_at
(字符串)、
record_type
(字符串)、
source_type
(对象)、
status
(枚举值:purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending、requirement-info-pending、requirement-info-under-review、requirement-info-exception、provision-pending)、
t38_fax_gateway_enabled
(布尔值)、
tags
(字符串数组)、
updated_at
(字符串)

Update a phone number

更新单条电话号码

PATCH /phone_numbers/{id}
Optional:
address_id
(string),
billing_group_id
(string),
connection_id
(string),
customer_reference
(string),
external_pin
(string),
hd_voice_enabled
(boolean),
id
(string),
tags
(array[string])
ruby
phone_number = client.phone_numbers.update("1293384261075731499")

puts(phone_number)
Returns:
billing_group_id
(string | null),
call_forwarding_enabled
(boolean),
call_recording_enabled
(boolean),
caller_id_name_enabled
(boolean),
cnam_listing_enabled
(boolean),
connection_id
(string | null),
connection_name
(string | null),
country_iso_alpha2
(string),
created_at
(date-time),
customer_reference
(string | null),
deletion_lock_enabled
(boolean),
emergency_address_id
(string | null),
emergency_enabled
(boolean),
emergency_status
(enum: active, deprovisioning, disabled, provisioning, provisioning-failed),
external_pin
(string | null),
hd_voice_enabled
(boolean),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
messaging_profile_id
(string | null),
messaging_profile_name
(string | null),
phone_number
(string),
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode),
purchased_at
(string),
record_type
(string),
source_type
(object),
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending),
t38_fax_gateway_enabled
(boolean),
tags
(array[string]),
updated_at
(string)
PATCH /phone_numbers/{id}
可选参数:
address_id
(字符串)、
billing_group_id
(字符串)、
connection_id
(字符串)、
customer_reference
(字符串)、
external_pin
(字符串)、
hd_voice_enabled
(布尔值)、
id
(字符串)、
tags
(字符串数组)
ruby
phone_number = client.phone_numbers.update("1293384261075731499")

puts(phone_number)
返回参数:
billing_group_id
(字符串 / 空)、
call_forwarding_enabled
(布尔值)、
call_recording_enabled
(布尔值)、
caller_id_name_enabled
(布尔值)、
cnam_listing_enabled
(布尔值)、
connection_id
(字符串 / 空)、
connection_name
(字符串 / 空)、
country_iso_alpha2
(字符串)、
created_at
(日期时间)、
customer_reference
(字符串 / 空)、
deletion_lock_enabled
(布尔值)、
emergency_address_id
(字符串 / 空)、
emergency_enabled
(布尔值)、
emergency_status
(枚举值:active、deprovisioning、disabled、provisioning、provisioning-failed)、
external_pin
(字符串 / 空)、
hd_voice_enabled
(布尔值)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
messaging_profile_id
(字符串 / 空)、
messaging_profile_name
(字符串 / 空)、
phone_number
(字符串)、
phone_number_type
(枚举值:local、toll_free、mobile、national、shared_cost、landline、tollfree、shortcode、longcode)、
purchased_at
(字符串)、
record_type
(字符串)、
source_type
(对象)、
status
(枚举值:purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending、requirement-info-pending、requirement-info-under-review、requirement-info-exception、provision-pending)、
t38_fax_gateway_enabled
(布尔值)、
tags
(字符串数组)、
updated_at
(字符串)

Delete a phone number

删除单条电话号码

DELETE /phone_numbers/{id}
ruby
phone_number = client.phone_numbers.delete("1293384261075731499")

puts(phone_number)
Returns:
billing_group_id
(string),
call_forwarding_enabled
(boolean),
call_recording_enabled
(boolean),
caller_id_name_enabled
(boolean),
cnam_listing_enabled
(boolean),
connection_id
(string),
connection_name
(string),
created_at
(string),
customer_reference
(string),
deletion_lock_enabled
(boolean),
emergency_address_id
(string),
emergency_enabled
(boolean),
external_pin
(string),
hd_voice_enabled
(boolean),
id
(string),
messaging_profile_id
(string),
messaging_profile_name
(string),
phone_number
(string),
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline),
purchased_at
(string),
record_type
(string),
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending),
t38_fax_gateway_enabled
(boolean),
tags
(array[string]),
updated_at
(string)
DELETE /phone_numbers/{id}
ruby
phone_number = client.phone_numbers.delete("1293384261075731499")

puts(phone_number)
返回参数:
billing_group_id
(字符串)、
call_forwarding_enabled
(布尔值)、
call_recording_enabled
(布尔值)、
caller_id_name_enabled
(布尔值)、
cnam_listing_enabled
(布尔值)、
connection_id
(字符串)、
connection_name
(字符串)、
created_at
(字符串)、
customer_reference
(字符串)、
deletion_lock_enabled
(布尔值)、
emergency_address_id
(字符串)、
emergency_enabled
(布尔值)、
external_pin
(字符串)、
hd_voice_enabled
(布尔值)、
id
(字符串)、
messaging_profile_id
(字符串)、
messaging_profile_name
(字符串)、
phone_number
(字符串)、
phone_number_type
(枚举值:local、toll_free、mobile、national、shared_cost、landline)、
purchased_at
(字符串)、
record_type
(字符串)、
status
(枚举值:purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending)、
t38_fax_gateway_enabled
(布尔值)、
tags
(字符串数组)、
updated_at
(字符串)

Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)

变更电话号码的套餐状态(加入套餐或移出套餐)

PATCH /phone_numbers/{id}/actions/bundle_status_change
— Required:
bundle_id
ruby
response = client.phone_numbers.actions.change_bundle_status(
  "1293384261075731499",
  bundle_id: "5194d8fc-87e6-4188-baa9-1c434bbe861b"
)

puts(response)
Returns:
call_forwarding
(object),
call_recording
(object),
cnam_listing
(object),
connection_id
(string),
customer_reference
(string),
emergency
(object),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
media_features
(object),
phone_number
(string),
record_type
(string),
tech_prefix_enabled
(boolean),
translated_number
(string),
usage_payment_method
(enum: pay-per-minute, channel)
PATCH /phone_numbers/{id}/actions/bundle_status_change
— 必填参数:
bundle_id
ruby
response = client.phone_numbers.actions.change_bundle_status(
  "1293384261075731499",
  bundle_id: "5194d8fc-87e6-4188-baa9-1c434bbe861b"
)

puts(response)
返回参数:
call_forwarding
(对象)、
call_recording
(对象)、
cnam_listing
(对象)、
connection_id
(字符串)、
customer_reference
(字符串)、
emergency
(对象)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
media_features
(对象)、
phone_number
(字符串)、
record_type
(字符串)、
tech_prefix_enabled
(布尔值)、
translated_number
(字符串)、
usage_payment_method
(枚举值:pay-per-minute、channel)

Enable emergency for a phone number

启用电话号码的紧急服务

POST /phone_numbers/{id}/actions/enable_emergency
— Required:
emergency_enabled
,
emergency_address_id
ruby
response = client.phone_numbers.actions.enable_emergency(
  "1293384261075731499",
  emergency_address_id: "53829456729313",
  emergency_enabled: true
)

puts(response)
Returns:
call_forwarding
(object),
call_recording
(object),
cnam_listing
(object),
connection_id
(string),
customer_reference
(string),
emergency
(object),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
media_features
(object),
phone_number
(string),
record_type
(string),
tech_prefix_enabled
(boolean),
translated_number
(string),
usage_payment_method
(enum: pay-per-minute, channel)
POST /phone_numbers/{id}/actions/enable_emergency
— 必填参数:
emergency_enabled
emergency_address_id
ruby
response = client.phone_numbers.actions.enable_emergency(
  "1293384261075731499",
  emergency_address_id: "53829456729313",
  emergency_enabled: true
)

puts(response)
返回参数:
call_forwarding
(对象)、
call_recording
(对象)、
cnam_listing
(对象)、
connection_id
(字符串)、
customer_reference
(字符串)、
emergency
(对象)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
media_features
(对象)、
phone_number
(字符串)、
record_type
(字符串)、
tech_prefix_enabled
(布尔值)、
translated_number
(字符串)、
usage_payment_method
(枚举值:pay-per-minute、channel)

Retrieve a phone number with messaging settings

查询单条带消息配置的电话号码

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

puts(messaging)
Returns:
country_code
(string),
created_at
(date-time),
eligible_messaging_products
(array[string]),
features
(object),
health
(object),
id
(string),
messaging_product
(string),
messaging_profile_id
(string | null),
organization_id
(string),
phone_number
(string),
record_type
(enum: messaging_phone_number, messaging_settings),
tags
(array[string]),
traffic_type
(string),
type
(enum: long-code, toll-free, short-code, longcode, tollfree, shortcode),
updated_at
(date-time)
GET /phone_numbers/{id}/messaging
ruby
messaging = client.phone_numbers.messaging.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(messaging)
返回参数:
country_code
(字符串)、
created_at
(日期时间)、
eligible_messaging_products
(字符串数组)、
features
(对象)、
health
(对象)、
id
(字符串)、
messaging_product
(字符串)、
messaging_profile_id
(字符串 / 空)、
organization_id
(字符串)、
phone_number
(字符串)、
record_type
(枚举值:messaging_phone_number、messaging_settings)、
tags
(字符串数组)、
traffic_type
(字符串)、
type
(枚举值:long-code、toll-free、short-code、longcode、tollfree、shortcode)、
updated_at
(日期时间)

Update the messaging profile and/or messaging product of a phone number

更新电话号码的消息配置和/或消息产品

PATCH /phone_numbers/{id}/messaging
Optional:
messaging_product
(string),
messaging_profile_id
(string),
tags
(array[string])
ruby
messaging = client.phone_numbers.messaging.update("550e8400-e29b-41d4-a716-446655440000")

puts(messaging)
Returns:
country_code
(string),
created_at
(date-time),
eligible_messaging_products
(array[string]),
features
(object),
health
(object),
id
(string),
messaging_product
(string),
messaging_profile_id
(string | null),
organization_id
(string),
phone_number
(string),
record_type
(enum: messaging_phone_number, messaging_settings),
tags
(array[string]),
traffic_type
(string),
type
(enum: long-code, toll-free, short-code, longcode, tollfree, shortcode),
updated_at
(date-time)
PATCH /phone_numbers/{id}/messaging
可选参数:
messaging_product
(字符串)、
messaging_profile_id
(字符串)、
tags
(字符串数组)
ruby
messaging = client.phone_numbers.messaging.update("550e8400-e29b-41d4-a716-446655440000")

puts(messaging)
返回参数:
country_code
(字符串)、
created_at
(日期时间)、
eligible_messaging_products
(字符串数组)、
features
(对象)、
health
(对象)、
id
(字符串)、
messaging_product
(字符串)、
messaging_profile_id
(字符串 / 空)、
organization_id
(字符串)、
phone_number
(字符串)、
record_type
(枚举值:messaging_phone_number、messaging_settings)、
tags
(字符串数组)、
traffic_type
(字符串)、
type
(枚举值:long-code、toll-free、short-code、longcode、tollfree、shortcode)、
updated_at
(日期时间)

Retrieve a phone number with voice settings

查询单条带语音配置的电话号码

GET /phone_numbers/{id}/voice
ruby
voice = client.phone_numbers.voice.retrieve("1293384261075731499")

puts(voice)
Returns:
call_forwarding
(object),
call_recording
(object),
cnam_listing
(object),
connection_id
(string),
customer_reference
(string),
emergency
(object),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
media_features
(object),
phone_number
(string),
record_type
(string),
tech_prefix_enabled
(boolean),
translated_number
(string),
usage_payment_method
(enum: pay-per-minute, channel)
GET /phone_numbers/{id}/voice
ruby
voice = client.phone_numbers.voice.retrieve("1293384261075731499")

puts(voice)
返回参数:
call_forwarding
(对象)、
call_recording
(对象)、
cnam_listing
(对象)、
connection_id
(字符串)、
customer_reference
(字符串)、
emergency
(对象)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
media_features
(对象)、
phone_number
(字符串)、
record_type
(字符串)、
tech_prefix_enabled
(布尔值)、
translated_number
(字符串)、
usage_payment_method
(枚举值:pay-per-minute、channel)

Update a phone number with voice settings

更新电话号码的语音配置

PATCH /phone_numbers/{id}/voice
Optional:
call_forwarding
(object),
call_recording
(object),
caller_id_name_enabled
(boolean),
cnam_listing
(object),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
media_features
(object),
tech_prefix_enabled
(boolean),
translated_number
(string),
usage_payment_method
(enum: pay-per-minute, channel)
ruby
voice = client.phone_numbers.voice.update("1293384261075731499")

puts(voice)
Returns:
call_forwarding
(object),
call_recording
(object),
cnam_listing
(object),
connection_id
(string),
customer_reference
(string),
emergency
(object),
id
(string),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
media_features
(object),
phone_number
(string),
record_type
(string),
tech_prefix_enabled
(boolean),
translated_number
(string),
usage_payment_method
(enum: pay-per-minute, channel)
PATCH /phone_numbers/{id}/voice
可选参数:
call_forwarding
(对象)、
call_recording
(对象)、
caller_id_name_enabled
(布尔值)、
cnam_listing
(对象)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
media_features
(对象)、
tech_prefix_enabled
(布尔值)、
translated_number
(字符串)、
usage_payment_method
(枚举值:pay-per-minute、channel)
ruby
voice = client.phone_numbers.voice.update("1293384261075731499")

puts(voice)
返回参数:
call_forwarding
(对象)、
call_recording
(对象)、
cnam_listing
(对象)、
connection_id
(字符串)、
customer_reference
(字符串)、
emergency
(对象)、
id
(字符串)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
media_features
(对象)、
phone_number
(字符串)、
record_type
(字符串)、
tech_prefix_enabled
(布尔值)、
translated_number
(字符串)、
usage_payment_method
(枚举值:pay-per-minute、channel)

List Mobile Phone Numbers

查询手机号码列表

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

puts(page)
Returns:
call_forwarding
(object),
call_recording
(object),
caller_id_name_enabled
(boolean),
cnam_listing
(object),
connection_id
(string | null),
connection_name
(string | null),
connection_type
(string | null),
country_iso_alpha2
(string),
created_at
(date-time),
customer_reference
(string | null),
id
(string),
inbound
(object),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
mobile_voice_enabled
(boolean),
noise_suppression
(enum: inbound, outbound, both, disabled),
outbound
(object),
phone_number
(string),
record_type
(string),
sim_card_id
(uuid),
status
(string),
tags
(array[string]),
updated_at
(date-time)
GET /v2/mobile_phone_numbers
ruby
page = client.mobile_phone_numbers.list

puts(page)
返回参数:
call_forwarding
(对象)、
call_recording
(对象)、
caller_id_name_enabled
(布尔值)、
cnam_listing
(对象)、
connection_id
(字符串 / 空)、
connection_name
(字符串 / 空)、
connection_type
(字符串 / 空)、
country_iso_alpha2
(字符串)、
created_at
(日期时间)、
customer_reference
(字符串 / 空)、
id
(字符串)、
inbound
(对象)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
mobile_voice_enabled
(布尔值)、
noise_suppression
(枚举值:inbound、outbound、both、disabled)、
outbound
(对象)、
phone_number
(字符串)、
record_type
(字符串)、
sim_card_id
(UUID)、
status
(字符串)、
tags
(字符串数组)、
updated_at
(日期时间)

Retrieve a Mobile Phone Number

查询单条手机号码

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

puts(mobile_phone_number)
Returns:
call_forwarding
(object),
call_recording
(object),
caller_id_name_enabled
(boolean),
cnam_listing
(object),
connection_id
(string | null),
connection_name
(string | null),
connection_type
(string | null),
country_iso_alpha2
(string),
created_at
(date-time),
customer_reference
(string | null),
id
(string),
inbound
(object),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
mobile_voice_enabled
(boolean),
noise_suppression
(enum: inbound, outbound, both, disabled),
outbound
(object),
phone_number
(string),
record_type
(string),
sim_card_id
(uuid),
status
(string),
tags
(array[string]),
updated_at
(date-time)
GET /v2/mobile_phone_numbers/{id}
ruby
mobile_phone_number = client.mobile_phone_numbers.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_phone_number)
返回参数:
call_forwarding
(对象)、
call_recording
(对象)、
caller_id_name_enabled
(布尔值)、
cnam_listing
(对象)、
connection_id
(字符串 / 空)、
connection_name
(字符串 / 空)、
connection_type
(字符串 / 空)、
country_iso_alpha2
(字符串)、
created_at
(日期时间)、
customer_reference
(字符串 / 空)、
id
(字符串)、
inbound
(对象)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
mobile_voice_enabled
(布尔值)、
noise_suppression
(枚举值:inbound、outbound、both、disabled)、
outbound
(对象)、
phone_number
(字符串)、
record_type
(字符串)、
sim_card_id
(UUID)、
status
(字符串)、
tags
(字符串数组)、
updated_at
(日期时间)

Update a Mobile Phone Number

更新单条手机号码

PATCH /v2/mobile_phone_numbers/{id}
Optional:
call_forwarding
(object),
call_recording
(object),
caller_id_name_enabled
(boolean),
cnam_listing
(object),
connection_id
(string | null),
customer_reference
(string | null),
inbound
(object),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
noise_suppression
(boolean),
outbound
(object),
tags
(array[string])
ruby
mobile_phone_number = client.mobile_phone_numbers.update("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_phone_number)
Returns:
call_forwarding
(object),
call_recording
(object),
caller_id_name_enabled
(boolean),
cnam_listing
(object),
connection_id
(string | null),
connection_name
(string | null),
connection_type
(string | null),
country_iso_alpha2
(string),
created_at
(date-time),
customer_reference
(string | null),
id
(string),
inbound
(object),
inbound_call_screening
(enum: disabled, reject_calls, flag_calls),
mobile_voice_enabled
(boolean),
noise_suppression
(enum: inbound, outbound, both, disabled),
outbound
(object),
phone_number
(string),
record_type
(string),
sim_card_id
(uuid),
status
(string),
tags
(array[string]),
updated_at
(date-time)
PATCH /v2/mobile_phone_numbers/{id}
可选参数:
call_forwarding
(对象)、
call_recording
(对象)、
caller_id_name_enabled
(布尔值)、
cnam_listing
(对象)、
connection_id
(字符串 / 空)、
customer_reference
(字符串 / 空)、
inbound
(对象)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
noise_suppression
(布尔值)、
outbound
(对象)、
tags
(字符串数组)
ruby
mobile_phone_number = client.mobile_phone_numbers.update("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_phone_number)
返回参数:
call_forwarding
(对象)、
call_recording
(对象)、
caller_id_name_enabled
(布尔值)、
cnam_listing
(对象)、
connection_id
(字符串 / 空)、
connection_name
(字符串 / 空)、
connection_type
(字符串 / 空)、
country_iso_alpha2
(字符串)、
created_at
(日期时间)、
customer_reference
(字符串 / 空)、
id
(字符串)、
inbound
(对象)、
inbound_call_screening
(枚举值:disabled、reject_calls、flag_calls)、
mobile_voice_enabled
(布尔值)、
noise_suppression
(枚举值:inbound、outbound、both、disabled)、
outbound
(对象)、
phone_number
(字符串)、
record_type
(字符串)、
sim_card_id
(UUID)、
status
(字符串)、
tags
(字符串数组)、
updated_at
(日期时间)