Back to Details

telnyx-porting-in-ruby

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

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

Telnyx Porting In - 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 "Network error — check connectivity and retry"
rescue Telnyx::Errors::RateLimitError
  # 429: 触发速率限制 — 等待后使用指数退避重试
  sleep(1) # 可查看Retry-After响应头获取准确的等待时间
rescue Telnyx::Errors::APIStatusError => e
  puts "API error #{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 }
    。

Run a portability check

执行可迁移性检查

Runs a portability check, returning the results immediately.
POST /portability_checks
Optional: 
phone_numbers
(array[string])
ruby
response = client.portability_checks.run(phone_numbers: ["+18005550101"])
puts(response)
Returns: 
fast_portable
(boolean), 
not_portable_reason
(string), 
phone_number
(string), 
portable
(boolean), 
record_type
(string)
执行可迁移性检查，立即返回结果。
POST /portability_checks
可选参数：
phone_numbers
(字符串数组)
ruby
response = client.portability_checks.run(phone_numbers: ["+18005550101"])
puts(response)
返回：
fast_portable
(布尔值), 
not_portable_reason
(字符串), 
phone_number
(字符串), 
portable
(布尔值), 
record_type
(字符串)

List all porting events

列出所有迁移事件

Returns a list of all porting events.
GET /porting/events
ruby
page = client.porting.events.list

puts(page)
Returns: 
available_notification_methods
(array[string]), 
event_type
(enum: porting_order.deleted), 
id
(uuid), 
payload
(object), 
payload_status
(enum: created, completed), 
porting_order_id
(uuid)
返回所有迁移事件的列表。
GET /porting/events
ruby
page = client.porting.events.list

puts(page)
返回：
available_notification_methods
(字符串数组), 
event_type
(枚举值: porting_order.deleted), 
id
(uuid), 
payload
(对象), 
payload_status
(枚举值: created, completed), 
porting_order_id
(uuid)

Show a porting event

查询单个迁移事件

Show a specific porting event.
GET /porting/events/{id}
ruby
event = client.porting.events.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(event)
Returns: 
available_notification_methods
(array[string]), 
event_type
(enum: porting_order.deleted), 
id
(uuid), 
payload
(object), 
payload_status
(enum: created, completed), 
porting_order_id
(uuid)
查询指定迁移事件的详情。
GET /porting/events/{id}
ruby
event = client.porting.events.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(event)
返回：
available_notification_methods
(字符串数组), 
event_type
(枚举值: porting_order.deleted), 
id
(uuid), 
payload
(对象), 
payload_status
(枚举值: created, completed), 
porting_order_id
(uuid)

Republish a porting event

重新发布迁移事件

Republish a specific porting event.
POST /porting/events/{id}/republish
ruby
result = client.porting.events.republish("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)
重新发布指定的迁移事件。
POST /porting/events/{id}/republish
ruby
result = client.porting.events.republish("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)

List LOA configurations

列出LOA配置

List the LOA configurations.
GET /porting/loa_configurations
ruby
page = client.porting.loa_configurations.list

puts(page)
Returns: 
address
(object), 
company_name
(string), 
contact
(object), 
created_at
(date-time), 
id
(uuid), 
logo
(object), 
name
(string), 
organization_id
(string), 
record_type
(string), 
updated_at
(date-time)
列出所有LOA配置。
GET /porting/loa_configurations
ruby
page = client.porting.loa_configurations.list

puts(page)
返回：
address
(对象), 
company_name
(字符串), 
contact
(对象), 
created_at
(日期时间), 
id
(uuid), 
logo
(对象), 
name
(字符串), 
organization_id
(字符串), 
record_type
(字符串), 
updated_at
(日期时间)

Create a LOA configuration

创建LOA配置

Create a LOA configuration.
POST /porting/loa_configurations
ruby
loa_configuration = client.porting.loa_configurations.create(
  address: {city: "Austin", country_code: "US", state: "TX", street_address: "600 Congress Avenue", zip_code: "78701"},
  company_name: "Telnyx",
  contact: {email: "testing@client.com", phone_number: "+12003270001"},
  logo: {document_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},
  name: "My LOA Configuration"
)

puts(loa_configuration)
Returns: 
address
(object), 
company_name
(string), 
contact
(object), 
created_at
(date-time), 
id
(uuid), 
logo
(object), 
name
(string), 
organization_id
(string), 
record_type
(string), 
updated_at
(date-time)
创建新的LOA配置。
POST /porting/loa_configurations
ruby
loa_configuration = client.porting.loa_configurations.create(
  address: {city: "Austin", country_code: "US", state: "TX", street_address: "600 Congress Avenue", zip_code: "78701"},
  company_name: "Telnyx",
  contact: {email: "testing@client.com", phone_number: "+12003270001"},
  logo: {document_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},
  name: "My LOA Configuration"
)

puts(loa_configuration)
返回：
address
(对象), 
company_name
(字符串), 
contact
(对象), 
created_at
(日期时间), 
id
(uuid), 
logo
(对象), 
name
(字符串), 
organization_id
(字符串), 
record_type
(字符串), 
updated_at
(日期时间)

Preview the LOA configuration parameters

预览LOA配置参数

Preview the LOA template that would be generated without need to create LOA configuration.
POST /porting/loa_configurations/preview
ruby
response = client.porting.loa_configurations.preview(
  address: {city: "Austin", country_code: "US", state: "TX", street_address: "600 Congress Avenue", zip_code: "78701"},
  company_name: "Telnyx",
  contact: {email: "testing@client.com", phone_number: "+12003270001"},
  logo: {document_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},
  name: "My LOA Configuration"
)

puts(response)
无需创建LOA配置即可预览生成的LOA模板。
POST /porting/loa_configurations/preview
ruby
response = client.porting.loa_configurations.preview(
  address: {city: "Austin", country_code: "US", state: "TX", street_address: "600 Congress Avenue", zip_code: "78701"},
  company_name: "Telnyx",
  contact: {email: "testing@client.com", phone_number: "+12003270001"},
  logo: {document_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},
  name: "My LOA Configuration"
)

puts(response)

Retrieve a LOA configuration

查询单个LOA配置

Retrieve a specific LOA configuration.
GET /porting/loa_configurations/{id}
ruby
loa_configuration = client.porting.loa_configurations.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(loa_configuration)
Returns: 
address
(object), 
company_name
(string), 
contact
(object), 
created_at
(date-time), 
id
(uuid), 
logo
(object), 
name
(string), 
organization_id
(string), 
record_type
(string), 
updated_at
(date-time)
查询指定LOA配置的详情。
GET /porting/loa_configurations/{id}
ruby
loa_configuration = client.porting.loa_configurations.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(loa_configuration)
返回：
address
(对象), 
company_name
(字符串), 
contact
(对象), 
created_at
(日期时间), 
id
(uuid), 
logo
(对象), 
name
(字符串), 
organization_id
(字符串), 
record_type
(字符串), 
updated_at
(日期时间)

Update a LOA configuration

更新LOA配置

Update a specific LOA configuration.
PATCH /porting/loa_configurations/{id}
ruby
loa_configuration = client.porting.loa_configurations.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  address: {city: "Austin", country_code: "US", state: "TX", street_address: "600 Congress Avenue", zip_code: "78701"},
  company_name: "Telnyx",
  contact: {email: "testing@client.com", phone_number: "+12003270001"},
  logo: {document_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},
  name: "My LOA Configuration"
)

puts(loa_configuration)
Returns: 
address
(object), 
company_name
(string), 
contact
(object), 
created_at
(date-time), 
id
(uuid), 
logo
(object), 
name
(string), 
organization_id
(string), 
record_type
(string), 
updated_at
(date-time)
更新指定LOA配置的信息。
PATCH /porting/loa_configurations/{id}
ruby
loa_configuration = client.porting.loa_configurations.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  address: {city: "Austin", country_code: "US", state: "TX", street_address: "600 Congress Avenue", zip_code: "78701"},
  company_name: "Telnyx",
  contact: {email: "testing@client.com", phone_number: "+12003270001"},
  logo: {document_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"},
  name: "My LOA Configuration"
)

puts(loa_configuration)
返回：
address
(对象), 
company_name
(字符串), 
contact
(对象), 
created_at
(日期时间), 
id
(uuid), 
logo
(对象), 
name
(字符串), 
organization_id
(字符串), 
record_type
(字符串), 
updated_at
(日期时间)

Delete a LOA configuration

删除LOA配置

Delete a specific LOA configuration.
DELETE /porting/loa_configurations/{id}
ruby
result = client.porting.loa_configurations.delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)
删除指定的LOA配置。
DELETE /porting/loa_configurations/{id}
ruby
result = client.porting.loa_configurations.delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)

Preview a LOA configuration

预览LOA配置

Preview a specific LOA configuration.
GET /porting/loa_configurations/{id}/preview
ruby
response = client.porting.loa_configurations.preview_1("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
预览指定LOA配置的内容。
GET /porting/loa_configurations/{id}/preview
ruby
response = client.porting.loa_configurations.preview_1("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)

List porting related reports

列出迁移相关报告

List the reports generated about porting operations.
GET /porting/reports
ruby
page = client.porting.reports.list

puts(page)
Returns: 
created_at
(date-time), 
document_id
(uuid), 
id
(uuid), 
params
(object), 
record_type
(string), 
report_type
(enum: export_porting_orders_csv), 
status
(enum: pending, completed), 
updated_at
(date-time)
列出迁移操作生成的所有报告。
GET /porting/reports
ruby
page = client.porting.reports.list

puts(page)
返回：
created_at
(日期时间), 
document_id
(uuid), 
id
(uuid), 
params
(对象), 
record_type
(字符串), 
report_type
(枚举值: export_porting_orders_csv), 
status
(枚举值: pending, completed), 
updated_at
(日期时间)

Create a porting related report

创建迁移相关报告

Generate reports about porting operations.
POST /porting/reports
ruby
report = client.porting.reports.create(params: {filters: {}}, report_type: :export_porting_orders_csv)

puts(report)
Returns: 
created_at
(date-time), 
document_id
(uuid), 
id
(uuid), 
params
(object), 
record_type
(string), 
report_type
(enum: export_porting_orders_csv), 
status
(enum: pending, completed), 
updated_at
(date-time)
生成迁移操作的相关报告。
POST /porting/reports
ruby
report = client.porting.reports.create(params: {filters: {}}, report_type: :export_porting_orders_csv)

puts(report)
返回：
created_at
(日期时间), 
document_id
(uuid), 
id
(uuid), 
params
(对象), 
record_type
(字符串), 
report_type
(枚举值: export_porting_orders_csv), 
status
(枚举值: pending, completed), 
updated_at
(日期时间)

Retrieve a report

查询单个报告

Retrieve a specific report generated.
GET /porting/reports/{id}
ruby
report = client.porting.reports.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(report)
Returns: 
created_at
(date-time), 
document_id
(uuid), 
id
(uuid), 
params
(object), 
record_type
(string), 
report_type
(enum: export_porting_orders_csv), 
status
(enum: pending, completed), 
updated_at
(date-time)
查询指定生成报告的详情。
GET /porting/reports/{id}
ruby
report = client.porting.reports.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(report)
返回：
created_at
(日期时间), 
document_id
(uuid), 
id
(uuid), 
params
(对象), 
record_type
(字符串), 
report_type
(枚举值: export_porting_orders_csv), 
status
(枚举值: pending, completed), 
updated_at
(日期时间)

List available carriers in the UK

列出英国可用运营商

List available carriers in the UK.
GET /porting/uk_carriers
ruby
response = client.porting.list_uk_carriers

puts(response)
Returns: 
alternative_cupids
(array[string]), 
created_at
(date-time), 
cupid
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(date-time)
列出英国地区可用的运营商。
GET /porting/uk_carriers
ruby
response = client.porting.list_uk_carriers

puts(response)
返回：
alternative_cupids
(字符串数组), 
created_at
(日期时间), 
cupid
(字符串), 
id
(uuid), 
name
(字符串), 
record_type
(字符串), 
updated_at
(日期时间)

List all porting orders

列出所有迁移工单

Returns a list of your porting order.
GET /porting_orders
ruby
page = client.porting_orders.list

puts(page)
Returns: 
activation_settings
(object), 
additional_steps
(array[string]), 
created_at
(date-time), 
customer_group_reference
(string | null), 
customer_reference
(string | null), 
description
(string), 
documents
(object), 
end_user
(object), 
id
(uuid), 
messaging
(object), 
misc
(object), 
old_service_provider_ocn
(string), 
parent_support_key
(string | null), 
phone_number_configuration
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(array[object]), 
porting_phone_numbers_count
(integer), 
record_type
(string), 
requirements
(array[object]), 
requirements_met
(boolean), 
status
(object), 
support_key
(string | null), 
updated_at
(date-time), 
user_feedback
(object), 
user_id
(uuid), 
webhook_url
(uri)
返回你的所有迁移工单列表。
GET /porting_orders
ruby
page = client.porting_orders.list

puts(page)
返回：
activation_settings
(对象), 
additional_steps
(字符串数组), 
created_at
(日期时间), 
customer_group_reference
(字符串 | null), 
customer_reference
(字符串 | null), 
description
(字符串), 
documents
(对象), 
end_user
(对象), 
id
(uuid), 
messaging
(对象), 
misc
(对象), 
old_service_provider_ocn
(字符串), 
parent_support_key
(字符串 | null), 
phone_number_configuration
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(对象数组), 
porting_phone_numbers_count
(整数), 
record_type
(字符串), 
requirements
(对象数组), 
requirements_met
(布尔值), 
status
(对象), 
support_key
(字符串 | null), 
updated_at
(日期时间), 
user_feedback
(对象), 
user_id
(uuid), 
webhook_url
(uri)

Create a porting order

创建迁移工单

Creates a new porting order object.
POST /porting_orders
— Required: 
phone_numbers
Optional: 
customer_group_reference
(string), 
customer_reference
(string | null)
ruby
porting_order = client.porting_orders.create(phone_numbers: ["+13035550000", "+13035550001", "+13035550002"])

puts(porting_order)
Returns: 
activation_settings
(object), 
additional_steps
(array[string]), 
created_at
(date-time), 
customer_group_reference
(string | null), 
customer_reference
(string | null), 
description
(string), 
documents
(object), 
end_user
(object), 
id
(uuid), 
messaging
(object), 
misc
(object), 
old_service_provider_ocn
(string), 
parent_support_key
(string | null), 
phone_number_configuration
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(array[object]), 
porting_phone_numbers_count
(integer), 
record_type
(string), 
requirements
(array[object]), 
requirements_met
(boolean), 
status
(object), 
support_key
(string | null), 
updated_at
(date-time), 
user_feedback
(object), 
user_id
(uuid), 
webhook_url
(uri)
创建新的迁移工单对象。
POST /porting_orders
— 必填参数：
phone_numbers
可选参数：
customer_group_reference
(字符串), 
customer_reference
(字符串 | null)
ruby
porting_order = client.porting_orders.create(phone_numbers: ["+13035550000", "+13035550001", "+13035550002"])

puts(porting_order)
返回：
activation_settings
(对象), 
additional_steps
(字符串数组), 
created_at
(日期时间), 
customer_group_reference
(字符串 | null), 
customer_reference
(字符串 | null), 
description
(字符串), 
documents
(对象), 
end_user
(对象), 
id
(uuid), 
messaging
(对象), 
misc
(对象), 
old_service_provider_ocn
(字符串), 
parent_support_key
(字符串 | null), 
phone_number_configuration
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(对象数组), 
porting_phone_numbers_count
(整数), 
record_type
(字符串), 
requirements
(对象数组), 
requirements_met
(布尔值), 
status
(对象), 
support_key
(字符串 | null), 
updated_at
(日期时间), 
user_feedback
(对象), 
user_id
(uuid), 
webhook_url
(uri)

List all exception types

列出所有异常类型

Returns a list of all possible exception types for a porting order.
GET /porting_orders/exception_types
ruby
response = client.porting_orders.retrieve_exception_types

puts(response)
Returns: 
code
(enum: ACCOUNT_NUMBER_MISMATCH, AUTH_PERSON_MISMATCH, BTN_ATN_MISMATCH, ENTITY_NAME_MISMATCH, FOC_EXPIRED, FOC_REJECTED, LOCATION_MISMATCH, LSR_PENDING, MAIN_BTN_PORTING, OSP_IRRESPONSIVE, OTHER, PASSCODE_PIN_INVALID, PHONE_NUMBER_HAS_SPECIAL_FEATURE, PHONE_NUMBER_MISMATCH, PHONE_NUMBER_NOT_PORTABLE, PORT_TYPE_INCORRECT, PORTING_ORDER_SPLIT_REQUIRED, POSTAL_CODE_MISMATCH, RATE_CENTER_NOT_PORTABLE, SV_CONFLICT, SV_UNKNOWN_FAILURE), 
description
(string)
返回迁移工单所有可能的异常类型列表。
GET /porting_orders/exception_types
ruby
response = client.porting_orders.retrieve_exception_types

puts(response)
返回：
code
(枚举值: ACCOUNT_NUMBER_MISMATCH, AUTH_PERSON_MISMATCH, BTN_ATN_MISMATCH, ENTITY_NAME_MISMATCH, FOC_EXPIRED, FOC_REJECTED, LOCATION_MISMATCH, LSR_PENDING, MAIN_BTN_PORTING, OSP_IRRESPONSIVE, OTHER, PASSCODE_PIN_INVALID, PHONE_NUMBER_HAS_SPECIAL_FEATURE, PHONE_NUMBER_MISMATCH, PHONE_NUMBER_NOT_PORTABLE, PORT_TYPE_INCORRECT, PORTING_ORDER_SPLIT_REQUIRED, POSTAL_CODE_MISMATCH, RATE_CENTER_NOT_PORTABLE, SV_CONFLICT, SV_UNKNOWN_FAILURE), 
description
(字符串)

List all phone number configurations

列出所有手机号码配置

Returns a list of phone number configurations paginated.
GET /porting_orders/phone_number_configurations
ruby
page = client.porting_orders.phone_number_configurations.list

puts(page)
Returns: 
created_at
(date-time), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(string), 
updated_at
(date-time), 
user_bundle_id
(uuid)
返回分页的手机号码配置列表。
GET /porting_orders/phone_number_configurations
ruby
page = client.porting_orders.phone_number_configurations.list

puts(page)
返回：
created_at
(日期时间), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间), 
user_bundle_id
(uuid)

Create a list of phone number configurations

批量创建手机号码配置

Creates a list of phone number configurations.
POST /porting_orders/phone_number_configurations
ruby
phone_number_configuration = client.porting_orders.phone_number_configurations.create

puts(phone_number_configuration)
Returns: 
created_at
(date-time), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(string), 
updated_at
(date-time), 
user_bundle_id
(uuid)
创建手机号码配置列表。
POST /porting_orders/phone_number_configurations
ruby
phone_number_configuration = client.porting_orders.phone_number_configurations.create

puts(phone_number_configuration)
返回：
created_at
(日期时间), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间), 
user_bundle_id
(uuid)

Retrieve a porting order

查询单个迁移工单

Retrieves the details of an existing porting order.
GET /porting_orders/{id}
ruby
porting_order = client.porting_orders.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(porting_order)
Returns: 
activation_settings
(object), 
additional_steps
(array[string]), 
created_at
(date-time), 
customer_group_reference
(string | null), 
customer_reference
(string | null), 
description
(string), 
documents
(object), 
end_user
(object), 
id
(uuid), 
messaging
(object), 
misc
(object), 
old_service_provider_ocn
(string), 
parent_support_key
(string | null), 
phone_number_configuration
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(array[object]), 
porting_phone_numbers_count
(integer), 
record_type
(string), 
requirements
(array[object]), 
requirements_met
(boolean), 
status
(object), 
support_key
(string | null), 
updated_at
(date-time), 
user_feedback
(object), 
user_id
(uuid), 
webhook_url
(uri)
查询已有迁移工单的详情。
GET /porting_orders/{id}
ruby
porting_order = client.porting_orders.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(porting_order)
返回：
activation_settings
(对象), 
additional_steps
(字符串数组), 
created_at
(日期时间), 
customer_group_reference
(字符串 | null), 
customer_reference
(字符串 | null), 
description
(字符串), 
documents
(对象), 
end_user
(对象), 
id
(uuid), 
messaging
(对象), 
misc
(对象), 
old_service_provider_ocn
(字符串), 
parent_support_key
(字符串 | null), 
phone_number_configuration
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(对象数组), 
porting_phone_numbers_count
(整数), 
record_type
(字符串), 
requirements
(对象数组), 
requirements_met
(布尔值), 
status
(对象), 
support_key
(字符串 | null), 
updated_at
(日期时间), 
user_feedback
(对象), 
user_id
(uuid), 
webhook_url
(uri)

Edit a porting order

编辑迁移工单

Edits the details of an existing porting order. Any or all of a porting orders attributes may be included in the resource object included in a PATCH request. If a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values.
PATCH /porting_orders/{id}
Optional: 
activation_settings
(object), 
customer_group_reference
(string), 
customer_reference
(string), 
documents
(object), 
end_user
(object), 
messaging
(object), 
misc
(object), 
phone_number_configuration
(object), 
requirement_group_id
(uuid), 
requirements
(array[object]), 
user_feedback
(object), 
webhook_url
(uri)
ruby
porting_order = client.porting_orders.update("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(porting_order)
Returns: 
activation_settings
(object), 
additional_steps
(array[string]), 
created_at
(date-time), 
customer_group_reference
(string | null), 
customer_reference
(string | null), 
description
(string), 
documents
(object), 
end_user
(object), 
id
(uuid), 
messaging
(object), 
misc
(object), 
old_service_provider_ocn
(string), 
parent_support_key
(string | null), 
phone_number_configuration
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(array[object]), 
porting_phone_numbers_count
(integer), 
record_type
(string), 
requirements
(array[object]), 
requirements_met
(boolean), 
status
(object), 
support_key
(string | null), 
updated_at
(date-time), 
user_feedback
(object), 
user_id
(uuid), 
webhook_url
(uri)
编辑已有迁移工单的详情。PATCH请求的资源对象中可包含迁移工单的任意或全部属性。如果请求未包含资源的所有属性，系统会将缺失属性视为保持当前值不变。
PATCH /porting_orders/{id}
可选参数：
activation_settings
(对象), 
customer_group_reference
(字符串), 
customer_reference
(字符串), 
documents
(对象), 
end_user
(对象), 
messaging
(对象), 
misc
(对象), 
phone_number_configuration
(对象), 
requirement_group_id
(uuid), 
requirements
(对象数组), 
user_feedback
(对象), 
webhook_url
(uri)
ruby
porting_order = client.porting_orders.update("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(porting_order)
返回：
activation_settings
(对象), 
additional_steps
(字符串数组), 
created_at
(日期时间), 
customer_group_reference
(字符串 | null), 
customer_reference
(字符串 | null), 
description
(字符串), 
documents
(对象), 
end_user
(对象), 
id
(uuid), 
messaging
(对象), 
misc
(对象), 
old_service_provider_ocn
(字符串), 
parent_support_key
(字符串 | null), 
phone_number_configuration
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(对象数组), 
porting_phone_numbers_count
(整数), 
record_type
(字符串), 
requirements
(对象数组), 
requirements_met
(布尔值), 
status
(对象), 
support_key
(字符串 | null), 
updated_at
(日期时间), 
user_feedback
(对象), 
user_id
(uuid), 
webhook_url
(uri)

Delete a porting order

删除迁移工单

Deletes an existing porting order. This operation is restrict to porting orders in draft state.
DELETE /porting_orders/{id}
ruby
result = client.porting_orders.delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)
删除已有迁移工单。此操作仅适用于草稿状态的迁移工单。
DELETE /porting_orders/{id}
ruby
result = client.porting_orders.delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)

Activate every number in a porting order asynchronously.

异步激活迁移工单内所有号码

Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only.
POST /porting_orders/{id}/actions/activate
ruby
response = client.porting_orders.actions.activate("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
Returns: 
activate_at
(date-time), 
activation_type
(enum: scheduled, on-demand), 
activation_windows
(array[object]), 
created_at
(date-time), 
id
(uuid), 
record_type
(string), 
status
(enum: created, in-process, completed, failed), 
updated_at
(date-time)
异步激活迁移工单中的每个号码。此操作仅适用于美国FastPort工单。
POST /porting_orders/{id}/actions/activate
ruby
response = client.porting_orders.actions.activate("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
返回：
activate_at
(日期时间), 
activation_type
(枚举值: scheduled, on-demand), 
activation_windows
(对象数组), 
created_at
(日期时间), 
id
(uuid), 
record_type
(字符串), 
status
(枚举值: created, in-process, completed, failed), 
updated_at
(日期时间)

Cancel a porting order

取消迁移工单

POST /porting_orders/{id}/actions/cancel
ruby
response = client.porting_orders.actions.cancel("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
Returns: 
activation_settings
(object), 
additional_steps
(array[string]), 
created_at
(date-time), 
customer_group_reference
(string | null), 
customer_reference
(string | null), 
description
(string), 
documents
(object), 
end_user
(object), 
id
(uuid), 
messaging
(object), 
misc
(object), 
old_service_provider_ocn
(string), 
parent_support_key
(string | null), 
phone_number_configuration
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(array[object]), 
porting_phone_numbers_count
(integer), 
record_type
(string), 
requirements
(array[object]), 
requirements_met
(boolean), 
status
(object), 
support_key
(string | null), 
updated_at
(date-time), 
user_feedback
(object), 
user_id
(uuid), 
webhook_url
(uri)
POST /porting_orders/{id}/actions/cancel
ruby
response = client.porting_orders.actions.cancel("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
返回：
activation_settings
(对象), 
additional_steps
(字符串数组), 
created_at
(日期时间), 
customer_group_reference
(字符串 | null), 
customer_reference
(字符串 | null), 
description
(字符串), 
documents
(对象), 
end_user
(对象), 
id
(uuid), 
messaging
(对象), 
misc
(对象), 
old_service_provider_ocn
(字符串), 
parent_support_key
(字符串 | null), 
phone_number_configuration
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(对象数组), 
porting_phone_numbers_count
(整数), 
record_type
(字符串), 
requirements
(对象数组), 
requirements_met
(布尔值), 
status
(对象), 
support_key
(字符串 | null), 
updated_at
(日期时间), 
user_feedback
(对象), 
user_id
(uuid), 
webhook_url
(uri)

Submit a porting order.

提交迁移工单

Confirm and submit your porting order.
POST /porting_orders/{id}/actions/confirm
ruby
response = client.porting_orders.actions.confirm("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
Returns: 
activation_settings
(object), 
additional_steps
(array[string]), 
created_at
(date-time), 
customer_group_reference
(string | null), 
customer_reference
(string | null), 
description
(string), 
documents
(object), 
end_user
(object), 
id
(uuid), 
messaging
(object), 
misc
(object), 
old_service_provider_ocn
(string), 
parent_support_key
(string | null), 
phone_number_configuration
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(array[object]), 
porting_phone_numbers_count
(integer), 
record_type
(string), 
requirements
(array[object]), 
requirements_met
(boolean), 
status
(object), 
support_key
(string | null), 
updated_at
(date-time), 
user_feedback
(object), 
user_id
(uuid), 
webhook_url
(uri)
确认并提交你的迁移工单。
POST /porting_orders/{id}/actions/confirm
ruby
response = client.porting_orders.actions.confirm("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
返回：
activation_settings
(对象), 
additional_steps
(字符串数组), 
created_at
(日期时间), 
customer_group_reference
(字符串 | null), 
customer_reference
(字符串 | null), 
description
(字符串), 
documents
(对象), 
end_user
(对象), 
id
(uuid), 
messaging
(对象), 
misc
(对象), 
old_service_provider_ocn
(字符串), 
parent_support_key
(字符串 | null), 
phone_number_configuration
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
phone_numbers
(对象数组), 
porting_phone_numbers_count
(整数), 
record_type
(字符串), 
requirements
(对象数组), 
requirements_met
(布尔值), 
status
(对象), 
support_key
(字符串 | null), 
updated_at
(日期时间), 
user_feedback
(对象), 
user_id
(uuid), 
webhook_url
(uri)

Share a porting order

共享迁移工单

Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users.
POST /porting_orders/{id}/actions/share
ruby
response = client.porting_orders.actions.share("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
Returns: 
created_at
(date-time), 
expires_at
(date-time), 
expires_in_seconds
(integer), 
id
(uuid), 
permissions
(array[string]), 
porting_order_id
(uuid), 
record_type
(string), 
token
(string)
为迁移工单创建共享令牌。该令牌可用于与非Telnyx用户共享迁移工单。
POST /porting_orders/{id}/actions/share
ruby
response = client.porting_orders.actions.share("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
返回：
created_at
(日期时间), 
expires_at
(日期时间), 
expires_in_seconds
(整数), 
id
(uuid), 
permissions
(字符串数组), 
porting_order_id
(uuid), 
record_type
(字符串), 
token
(字符串)

List all porting activation jobs

列出所有迁移激活任务

Returns a list of your porting activation jobs.
GET /porting_orders/{id}/activation_jobs
ruby
page = client.porting_orders.activation_jobs.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
Returns: 
activate_at
(date-time), 
activation_type
(enum: scheduled, on-demand), 
activation_windows
(array[object]), 
created_at
(date-time), 
id
(uuid), 
record_type
(string), 
status
(enum: created, in-process, completed, failed), 
updated_at
(date-time)
返回你的所有迁移激活任务列表。
GET /porting_orders/{id}/activation_jobs
ruby
page = client.porting_orders.activation_jobs.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
返回：
activate_at
(日期时间), 
activation_type
(枚举值: scheduled, on-demand), 
activation_windows
(对象数组), 
created_at
(日期时间), 
id
(uuid), 
record_type
(字符串), 
status
(枚举值: created, in-process, completed, failed), 
updated_at
(日期时间)

Retrieve a porting activation job

查询单个迁移激活任务

Returns a porting activation job.
GET /porting_orders/{id}/activation_jobs/{activationJobId}
ruby
activation_job = client.porting_orders.activation_jobs.retrieve(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(activation_job)
Returns: 
activate_at
(date-time), 
activation_type
(enum: scheduled, on-demand), 
activation_windows
(array[object]), 
created_at
(date-time), 
id
(uuid), 
record_type
(string), 
status
(enum: created, in-process, completed, failed), 
updated_at
(date-time)
返回指定迁移激活任务的详情。
GET /porting_orders/{id}/activation_jobs/{activationJobId}
ruby
activation_job = client.porting_orders.activation_jobs.retrieve(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(activation_job)
返回：
activate_at
(日期时间), 
activation_type
(枚举值: scheduled, on-demand), 
activation_windows
(对象数组), 
created_at
(日期时间), 
id
(uuid), 
record_type
(字符串), 
status
(枚举值: created, in-process, completed, failed), 
updated_at
(日期时间)

Update a porting activation job

更新迁移激活任务

Updates the activation time of a porting activation job.
PATCH /porting_orders/{id}/activation_jobs/{activationJobId}
ruby
activation_job = client.porting_orders.activation_jobs.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(activation_job)
Returns: 
activate_at
(date-time), 
activation_type
(enum: scheduled, on-demand), 
activation_windows
(array[object]), 
created_at
(date-time), 
id
(uuid), 
record_type
(string), 
status
(enum: created, in-process, completed, failed), 
updated_at
(date-time)
更新迁移激活任务的激活时间。
PATCH /porting_orders/{id}/activation_jobs/{activationJobId}
ruby
activation_job = client.porting_orders.activation_jobs.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(activation_job)
返回：
activate_at
(日期时间), 
activation_type
(枚举值: scheduled, on-demand), 
activation_windows
(对象数组), 
created_at
(日期时间), 
id
(uuid), 
record_type
(字符串), 
status
(枚举值: created, in-process, completed, failed), 
updated_at
(日期时间)

List additional documents

列出附加文档

Returns a list of additional documents for a porting order.
GET /porting_orders/{id}/additional_documents
ruby
page = client.porting_orders.additional_documents.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
Returns: 
content_type
(string), 
created_at
(date-time), 
document_id
(uuid), 
document_type
(enum: loa, invoice, csr, other), 
filename
(string), 
id
(uuid), 
porting_order_id
(uuid), 
record_type
(string), 
updated_at
(date-time)
返回迁移工单的所有附加文档列表。
GET /porting_orders/{id}/additional_documents
ruby
page = client.porting_orders.additional_documents.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
返回：
content_type
(字符串), 
created_at
(日期时间), 
document_id
(uuid), 
document_type
(枚举值: loa, invoice, csr, other), 
filename
(字符串), 
id
(uuid), 
porting_order_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间)

Create a list of additional documents

批量创建附加文档

Creates a list of additional documents for a porting order.
POST /porting_orders/{id}/additional_documents
ruby
additional_document = client.porting_orders.additional_documents.create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(additional_document)
Returns: 
content_type
(string), 
created_at
(date-time), 
document_id
(uuid), 
document_type
(enum: loa, invoice, csr, other), 
filename
(string), 
id
(uuid), 
porting_order_id
(uuid), 
record_type
(string), 
updated_at
(date-time)
为迁移工单创建附加文档列表。
POST /porting_orders/{id}/additional_documents
ruby
additional_document = client.porting_orders.additional_documents.create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(additional_document)
返回：
content_type
(字符串), 
created_at
(日期时间), 
document_id
(uuid), 
document_type
(枚举值: loa, invoice, csr, other), 
filename
(字符串), 
id
(uuid), 
porting_order_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间)

Delete an additional document

删除附加文档

Deletes an additional document for a porting order.
DELETE /porting_orders/{id}/additional_documents/{additional_document_id}
ruby
result = client.porting_orders.additional_documents.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(result)
删除迁移工单的指定附加文档。
DELETE /porting_orders/{id}/additional_documents/{additional_document_id}
ruby
result = client.porting_orders.additional_documents.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(result)

List allowed FOC dates

列出允许的FOC日期

Returns a list of allowed FOC dates for a porting order.
GET /porting_orders/{id}/allowed_foc_windows
ruby
response = client.porting_orders.retrieve_allowed_foc_windows("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
Returns: 
ended_at
(date-time), 
record_type
(string), 
started_at
(date-time)
返回迁移工单允许的FOC日期列表。
GET /porting_orders/{id}/allowed_foc_windows
ruby
response = client.porting_orders.retrieve_allowed_foc_windows("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
返回：
ended_at
(日期时间), 
record_type
(字符串), 
started_at
(日期时间)

List all comments of a porting order

列出迁移工单所有评论

Returns a list of all comments of a porting order.
GET /porting_orders/{id}/comments
ruby
page = client.porting_orders.comments.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
Returns: 
body
(string), 
created_at
(date-time), 
id
(uuid), 
porting_order_id
(uuid), 
record_type
(string), 
user_type
(enum: admin, user, system)
返回迁移工单的所有评论列表。
GET /porting_orders/{id}/comments
ruby
page = client.porting_orders.comments.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
返回：
body
(字符串), 
created_at
(日期时间), 
id
(uuid), 
porting_order_id
(uuid), 
record_type
(字符串), 
user_type
(枚举值: admin, user, system)

Create a comment for a porting order

创建迁移工单评论

Creates a new comment for a porting order.
POST /porting_orders/{id}/comments
Optional: 
body
(string)
ruby
comment = client.porting_orders.comments.create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(comment)
Returns: 
body
(string), 
created_at
(date-time), 
id
(uuid), 
porting_order_id
(uuid), 
record_type
(string), 
user_type
(enum: admin, user, system)
为迁移工单创建新评论。
POST /porting_orders/{id}/comments
可选参数：
body
(字符串)
ruby
comment = client.porting_orders.comments.create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(comment)
返回：
body
(字符串), 
created_at
(日期时间), 
id
(uuid), 
porting_order_id
(uuid), 
record_type
(字符串), 
user_type
(枚举值: admin, user, system)

Download a porting order loa template

下载迁移工单LOA模板

GET /porting_orders/{id}/loa_template
ruby
response = client.porting_orders.retrieve_loa_template("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
GET /porting_orders/{id}/loa_template
ruby
response = client.porting_orders.retrieve_loa_template("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)

List porting order requirements

列出迁移工单要求

Returns a list of all requirements based on country/number type for this porting order.
GET /porting_orders/{id}/requirements
ruby
page = client.porting_orders.retrieve_requirements("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
Returns: 
field_type
(enum: document, textual), 
field_value
(string), 
record_type
(string), 
requirement_status
(string), 
requirement_type
(object)
返回该迁移工单基于国家/号码类型的所有要求列表。
GET /porting_orders/{id}/requirements
ruby
page = client.porting_orders.retrieve_requirements("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
返回：
field_type
(枚举值: document, textual), 
field_value
(字符串), 
record_type
(字符串), 
requirement_status
(字符串), 
requirement_type
(对象)

Retrieve the associated V1 sub_request_id and port_request_id

查询关联的V1 sub_request_id和port_request_id

GET /porting_orders/{id}/sub_request
ruby
response = client.porting_orders.retrieve_sub_request("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
Returns: 
port_request_id
(string), 
sub_request_id
(string)
GET /porting_orders/{id}/sub_request
ruby
response = client.porting_orders.retrieve_sub_request("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
返回：
port_request_id
(字符串), 
sub_request_id
(字符串)

List verification codes

列出验证码

Returns a list of verification codes for a porting order.
GET /porting_orders/{id}/verification_codes
ruby
page = client.porting_orders.verification_codes.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
Returns: 
created_at
(date-time), 
id
(uuid), 
phone_number
(string), 
porting_order_id
(uuid), 
record_type
(string), 
updated_at
(date-time), 
verified
(boolean)
返回迁移工单的验证码列表。
GET /porting_orders/{id}/verification_codes
ruby
page = client.porting_orders.verification_codes.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
返回：
created_at
(日期时间), 
id
(uuid), 
phone_number
(字符串), 
porting_order_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间), 
verified
(布尔值)

Send the verification codes

发送验证码

Send the verification code for all porting phone numbers.
POST /porting_orders/{id}/verification_codes/send
ruby
result = client.porting_orders.verification_codes.send_("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)
为所有待迁移的手机号码发送验证码。
POST /porting_orders/{id}/verification_codes/send
ruby
result = client.porting_orders.verification_codes.send_("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(result)

Verify the verification code for a list of phone numbers

验证手机号码验证码

Verifies the verification code for a list of phone numbers.
POST /porting_orders/{id}/verification_codes/verify
ruby
response = client.porting_orders.verification_codes.verify("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
Returns: 
created_at
(date-time), 
id
(uuid), 
phone_number
(string), 
porting_order_id
(uuid), 
record_type
(string), 
updated_at
(date-time), 
verified
(boolean)
验证指定手机号码列表的验证码。
POST /porting_orders/{id}/verification_codes/verify
ruby
response = client.porting_orders.verification_codes.verify("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)
返回：
created_at
(日期时间), 
id
(uuid), 
phone_number
(字符串), 
porting_order_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间), 
verified
(布尔值)

List action requirements for a porting order

列出迁移工单操作要求

Returns a list of action requirements for a specific porting order.
GET /porting_orders/{porting_order_id}/action_requirements
ruby
page = client.porting_orders.action_requirements.list("porting_order_id")

puts(page)
Returns: 
action_type
(string), 
action_url
(string | null), 
cancel_reason
(string | null), 
created_at
(date-time), 
id
(string), 
porting_order_id
(string), 
record_type
(enum: porting_action_requirement), 
requirement_type_id
(string), 
status
(enum: created, pending, completed, cancelled, failed), 
updated_at
(date-time)
返回指定迁移工单的操作要求列表。
GET /porting_orders/{porting_order_id}/action_requirements
ruby
page = client.porting_orders.action_requirements.list("porting_order_id")

puts(page)
返回：
action_type
(字符串), 
action_url
(字符串 | null), 
cancel_reason
(字符串 | null), 
created_at
(日期时间), 
id
(字符串), 
porting_order_id
(字符串), 
record_type
(枚举值: porting_action_requirement), 
requirement_type_id
(字符串), 
status
(枚举值: created, pending, completed, cancelled, failed), 
updated_at
(日期时间)

Initiate an action requirement

触发操作要求

Initiates a specific action requirement for a porting order.
POST /porting_orders/{porting_order_id}/action_requirements/{id}/initiate
ruby
response = client.porting_orders.action_requirements.initiate(
  "id",
  porting_order_id: "550e8400-e29b-41d4-a716-446655440000",
  params: {first_name: "John", last_name: "Doe"}
)

puts(response)
Returns: 
action_type
(string), 
action_url
(string | null), 
cancel_reason
(string | null), 
created_at
(date-time), 
id
(string), 
porting_order_id
(string), 
record_type
(enum: porting_action_requirement), 
requirement_type_id
(string), 
status
(enum: created, pending, completed, cancelled, failed), 
updated_at
(date-time)
触发迁移工单的指定操作要求。
POST /porting_orders/{porting_order_id}/action_requirements/{id}/initiate
ruby
response = client.porting_orders.action_requirements.initiate(
  "id",
  porting_order_id: "550e8400-e29b-41d4-a716-446655440000",
  params: {first_name: "John", last_name: "Doe"}
)

puts(response)
返回：
action_type
(字符串), 
action_url
(字符串 | null), 
cancel_reason
(字符串 | null), 
created_at
(日期时间), 
id
(字符串), 
porting_order_id
(字符串), 
record_type
(枚举值: porting_action_requirement), 
requirement_type_id
(字符串), 
status
(枚举值: created, pending, completed, cancelled, failed), 
updated_at
(日期时间)

List all associated phone numbers

列出所有关联手机号码

Returns a list of all associated phone numbers for a porting order. Associated phone numbers are used for partial porting in GB to specify which phone numbers should be kept or disconnected.
GET /porting_orders/{porting_order_id}/associated_phone_numbers
ruby
page = client.porting_orders.associated_phone_numbers.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
Returns: 
action
(enum: keep, disconnect), 
country_code
(string), 
created_at
(date-time), 
id
(uuid), 
phone_number_range
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
porting_order_id
(uuid), 
record_type
(string), 
updated_at
(date-time)
返回迁移工单的所有关联手机号码列表。关联手机号码用于英国地区的部分迁移，用于指定哪些号码应该保留或注销。
GET /porting_orders/{porting_order_id}/associated_phone_numbers
ruby
page = client.porting_orders.associated_phone_numbers.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
返回：
action
(枚举值: keep, disconnect), 
country_code
(字符串), 
created_at
(日期时间), 
id
(uuid), 
phone_number_range
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
porting_order_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间)

Create an associated phone number

创建关联手机号码

Creates a new associated phone number for a porting order. This is used for partial porting in GB to specify which phone numbers should be kept or disconnected.
POST /porting_orders/{porting_order_id}/associated_phone_numbers
ruby
associated_phone_number = client.porting_orders.associated_phone_numbers.create(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  action: :keep,
  phone_number_range: {}
)

puts(associated_phone_number)
Returns: 
action
(enum: keep, disconnect), 
country_code
(string), 
created_at
(date-time), 
id
(uuid), 
phone_number_range
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
porting_order_id
(uuid), 
record_type
(string), 
updated_at
(date-time)
为迁移工单创建新的关联手机号码。用于英国地区的部分迁移，指定哪些号码应该保留或注销。
POST /porting_orders/{porting_order_id}/associated_phone_numbers
ruby
associated_phone_number = client.porting_orders.associated_phone_numbers.create(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  action: :keep,
  phone_number_range: {}
)

puts(associated_phone_number)
返回：
action
(枚举值: keep, disconnect), 
country_code
(字符串), 
created_at
(日期时间), 
id
(uuid), 
phone_number_range
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
porting_order_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间)

Delete an associated phone number

删除关联手机号码

Deletes an associated phone number from a porting order.
DELETE /porting_orders/{porting_order_id}/associated_phone_numbers/{id}
ruby
associated_phone_number = client.porting_orders.associated_phone_numbers.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  porting_order_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(associated_phone_number)
Returns: 
action
(enum: keep, disconnect), 
country_code
(string), 
created_at
(date-time), 
id
(uuid), 
phone_number_range
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
porting_order_id
(uuid), 
record_type
(string), 
updated_at
(date-time)
从迁移工单中删除指定的关联手机号码。
DELETE /porting_orders/{porting_order_id}/associated_phone_numbers/{id}
ruby
associated_phone_number = client.porting_orders.associated_phone_numbers.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  porting_order_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(associated_phone_number)
返回：
action
(枚举值: keep, disconnect), 
country_code
(字符串), 
created_at
(日期时间), 
id
(uuid), 
phone_number_range
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
porting_order_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间)

List all phone number blocks

列出所有号码段

Returns a list of all phone number blocks of a porting order.
GET /porting_orders/{porting_order_id}/phone_number_blocks
ruby
page = client.porting_orders.phone_number_blocks.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
Returns: 
activation_ranges
(array[object]), 
country_code
(string), 
created_at
(date-time), 
id
(uuid), 
phone_number_range
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
record_type
(string), 
updated_at
(date-time)
返回迁移工单的所有号码段列表。
GET /porting_orders/{porting_order_id}/phone_number_blocks
ruby
page = client.porting_orders.phone_number_blocks.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
返回：
activation_ranges
(对象数组), 
country_code
(字符串), 
created_at
(日期时间), 
id
(uuid), 
phone_number_range
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
record_type
(字符串), 
updated_at
(日期时间)

Create a phone number block

创建号码段

Creates a new phone number block.
POST /porting_orders/{porting_order_id}/phone_number_blocks
ruby
phone_number_block = client.porting_orders.phone_number_blocks.create(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  activation_ranges: [{end_at: "+4930244999910", start_at: "+4930244999901"}],
  phone_number_range: {end_at: "+4930244999910", start_at: "+4930244999901"}
)

puts(phone_number_block)
Returns: 
activation_ranges
(array[object]), 
country_code
(string), 
created_at
(date-time), 
id
(uuid), 
phone_number_range
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
record_type
(string), 
updated_at
(date-time)
创建新的号码段。
POST /porting_orders/{porting_order_id}/phone_number_blocks
ruby
phone_number_block = client.porting_orders.phone_number_blocks.create(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  activation_ranges: [{end_at: "+4930244999910", start_at: "+4930244999901"}],
  phone_number_range: {end_at: "+4930244999910", start_at: "+4930244999901"}
)

puts(phone_number_block)
返回：
activation_ranges
(对象数组), 
country_code
(字符串), 
created_at
(日期时间), 
id
(uuid), 
phone_number_range
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
record_type
(字符串), 
updated_at
(日期时间)

Delete a phone number block

删除号码段

Deletes a phone number block.
DELETE /porting_orders/{porting_order_id}/phone_number_blocks/{id}
ruby
phone_number_block = client.porting_orders.phone_number_blocks.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  porting_order_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(phone_number_block)
Returns: 
activation_ranges
(array[object]), 
country_code
(string), 
created_at
(date-time), 
id
(uuid), 
phone_number_range
(object), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
record_type
(string), 
updated_at
(date-time)
删除指定号码段。
DELETE /porting_orders/{porting_order_id}/phone_number_blocks/{id}
ruby
phone_number_block = client.porting_orders.phone_number_blocks.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  porting_order_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(phone_number_block)
返回：
activation_ranges
(对象数组), 
country_code
(字符串), 
created_at
(日期时间), 
id
(uuid), 
phone_number_range
(对象), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
record_type
(字符串), 
updated_at
(日期时间)

List all phone number extensions

列出所有分机号

Returns a list of all phone number extensions of a porting order.
GET /porting_orders/{porting_order_id}/phone_number_extensions
ruby
page = client.porting_orders.phone_number_extensions.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
Returns: 
activation_ranges
(array[object]), 
created_at
(date-time), 
extension_range
(object), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(string), 
updated_at
(date-time)
返回迁移工单的所有分机号列表。
GET /porting_orders/{porting_order_id}/phone_number_extensions
ruby
page = client.porting_orders.phone_number_extensions.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
返回：
activation_ranges
(对象数组), 
created_at
(日期时间), 
extension_range
(对象), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间)

Create a phone number extension

创建分机号

Creates a new phone number extension.
POST /porting_orders/{porting_order_id}/phone_number_extensions
ruby
phone_number_extension = client.porting_orders.phone_number_extensions.create(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  activation_ranges: [{end_at: 10, start_at: 1}],
  extension_range: {end_at: 10, start_at: 1},
  porting_phone_number_id: "f24151b6-3389-41d3-8747-7dd8c681e5e2"
)

puts(phone_number_extension)
Returns: 
activation_ranges
(array[object]), 
created_at
(date-time), 
extension_range
(object), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(string), 
updated_at
(date-time)
创建新的分机号。
POST /porting_orders/{porting_order_id}/phone_number_extensions
ruby
phone_number_extension = client.porting_orders.phone_number_extensions.create(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  activation_ranges: [{end_at: 10, start_at: 1}],
  extension_range: {end_at: 10, start_at: 1},
  porting_phone_number_id: "f24151b6-3389-41d3-8747-7dd8c681e5e2"
)

puts(phone_number_extension)
返回：
activation_ranges
(对象数组), 
created_at
(日期时间), 
extension_range
(对象), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间)

Delete a phone number extension

删除分机号

Deletes a phone number extension.
DELETE /porting_orders/{porting_order_id}/phone_number_extensions/{id}
ruby
phone_number_extension = client.porting_orders.phone_number_extensions.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  porting_order_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(phone_number_extension)
Returns: 
activation_ranges
(array[object]), 
created_at
(date-time), 
extension_range
(object), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(string), 
updated_at
(date-time)
删除指定分机号。
DELETE /porting_orders/{porting_order_id}/phone_number_extensions/{id}
ruby
phone_number_extension = client.porting_orders.phone_number_extensions.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  porting_order_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(phone_number_extension)
返回：
activation_ranges
(对象数组), 
created_at
(日期时间), 
extension_range
(对象), 
id
(uuid), 
porting_phone_number_id
(uuid), 
record_type
(字符串), 
updated_at
(日期时间)

List all porting phone numbers

列出所有待迁移号码

Returns a list of your porting phone numbers.
GET /porting_phone_numbers
ruby
page = client.porting_phone_numbers.list

puts(page)
Returns: 
activation_status
(enum: New, Pending, Conflict, Cancel Pending, Failed, Concurred, Activate RDY, Disconnect Pending, Concurrence Sent, Old, Sending, Active, Cancelled), 
phone_number
(string), 
phone_number_type
(enum: landline, local, mobile, national, shared_cost, toll_free), 
portability_status
(enum: pending, confirmed, provisional), 
porting_order_id
(uuid), 
porting_order_status
(enum: draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled), 
record_type
(string), 
requirements_status
(enum: requirement-info-pending, requirement-info-under-review, requirement-info-exception, approved), 
support_key
(string)
返回你的所有待迁移号码列表。
GET /porting_phone_numbers
ruby
page = client.porting_phone_numbers.list

puts(page)
返回：
activation_status
(枚举值: New, Pending, Conflict, Cancel Pending, Failed, Concurred, Activate RDY, Disconnect Pending, Concurrence Sent, Old, Sending, Active, Cancelled), 
phone_number
(字符串), 
phone_number_type
(枚举值: landline, local, mobile, national, shared_cost, toll_free), 
portability_status
(枚举值: pending, confirmed, provisional), 
porting_order_id
(uuid), 
porting_order_status
(枚举值: draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled), 
record_type
(字符串), 
requirements_status
(枚举值: requirement-info-pending, requirement-info-under-review, requirement-info-exception, approved), 
support_key
(字符串)