Back to Details

telnyx-porting-in-javascript

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Porting In - JavaScript

Telnyx 号码转入 - JavaScript

Installation

安装

bash
npm install telnyx
bash
npm install telnyx

Setup

初始化

javascript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
All examples below assume 
client
is already initialized as shown above.
javascript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
所有以下示例均假设
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:
javascript
try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}
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）而失败。在生产代码中务必处理错误：
javascript
try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}
常见错误代码：
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: List methods return an auto-paginating iterator. Use 
    for await (const item of result) { ... }
    to iterate through all pages automatically.
  • 电话号码必须采用E.164格式（例如：
    +13125550001
    ）。包含
    +
    前缀和国家代码。不允许有空格、短横线或括号。
  • 分页：列表方法返回自动分页的迭代器。使用
    for await (const item of result) { ... }
    自动遍历所有页面。

Run a portability check

执行号码可携性核查

Runs a portability check, returning the results immediately.
POST /portability_checks
Optional: 
phone_numbers
(array[string])
javascript
const response = await client.portabilityChecks.run({
    phoneNumbers: ["+18005550101"],
});

console.log(response.data);
Returns: 
fast_portable
(boolean), 
not_portable_reason
(string), 
phone_number
(string), 
portable
(boolean), 
record_type
(string)
执行号码可携性核查，立即返回结果。
POST /portability_checks
可选参数：
phone_numbers
（array[string]）
javascript
const response = await client.portabilityChecks.run({
    phoneNumbers: ["+18005550101"],
});

console.log(response.data);
返回：
fast_portable
（布尔值），
not_portable_reason
（字符串），
phone_number
（字符串），
portable
（布尔值），
record_type
（字符串）

List all porting events

列出所有转网事件

Returns a list of all porting events.
GET /porting/events
javascript
// Automatically fetches more pages as needed.
for await (const eventListResponse of client.porting.events.list()) {
  console.log(eventListResponse);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const eventListResponse of client.porting.events.list()) {
  console.log(eventListResponse);
}
返回：
available_notification_methods
（array[string]），
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}
javascript
const event = await client.porting.events.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(event.data);
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}
javascript
const event = await client.porting.events.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(event.data);
返回：
available_notification_methods
（array[string]），
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
javascript
await client.porting.events.republish('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
重新发布特定的转网事件。
POST /porting/events/{id}/republish
javascript
await client.porting.events.republish('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

List LOA configurations

列出LOA配置

List the LOA configurations.
GET /porting/loa_configurations
javascript
// Automatically fetches more pages as needed.
for await (const portingLoaConfiguration of client.porting.loaConfigurations.list()) {
  console.log(portingLoaConfiguration.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const portingLoaConfiguration of client.porting.loaConfigurations.list()) {
  console.log(portingLoaConfiguration.id);
}
返回：
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
javascript
const loaConfiguration = await client.porting.loaConfigurations.create({
  address: {
    city: 'Austin',
    country_code: 'US',
    state: 'TX',
    street_address: '600 Congress Avenue',
    zip_code: '78701',
  },
  company_name: 'Telnyx',
  contact: { email: 'testing@telnyx.com', phone_number: '+12003270001' },
  logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
  name: 'My LOA Configuration',
});

console.log(loaConfiguration.data);
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
javascript
const loaConfiguration = await client.porting.loaConfigurations.create({
  address: {
    city: 'Austin',
    country_code: 'US',
    state: 'TX',
    street_address: '600 Congress Avenue',
    zip_code: '78701',
  },
  company_name: 'Telnyx',
  contact: { email: 'testing@telnyx.com', phone_number: '+12003270001' },
  logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
  name: 'My LOA Configuration',
});

console.log(loaConfiguration.data);
返回：
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
javascript
const response = await client.porting.loaConfigurations.preview({
  address: {
    city: 'Austin',
    country_code: 'US',
    state: 'TX',
    street_address: '600 Congress Avenue',
    zip_code: '78701',
  },
  company_name: 'Telnyx',
  contact: { email: 'testing@telnyx.com', phone_number: '+12003270001' },
  logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
  name: 'My LOA Configuration',
});

console.log(response);

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

console.log(response);

const content = await response.blob();
console.log(content);

Retrieve a LOA configuration

查询LOA配置

Retrieve a specific LOA configuration.
GET /porting/loa_configurations/{id}
javascript
const loaConfiguration = await client.porting.loaConfigurations.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(loaConfiguration.data);
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}
javascript
const loaConfiguration = await client.porting.loaConfigurations.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(loaConfiguration.data);
返回：
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}
javascript
const loaConfiguration = await client.porting.loaConfigurations.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@telnyx.com', phone_number: '+12003270001' },
    logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    name: 'My LOA Configuration',
  },
);

console.log(loaConfiguration.data);
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}
javascript
const loaConfiguration = await client.porting.loaConfigurations.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@telnyx.com', phone_number: '+12003270001' },
    logo: { document_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    name: 'My LOA Configuration',
  },
);

console.log(loaConfiguration.data);
返回：
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}
javascript
await client.porting.loaConfigurations.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
删除特定的LOA配置。
DELETE /porting/loa_configurations/{id}
javascript
await client.porting.loaConfigurations.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

Preview a LOA configuration

预览LOA配置

Preview a specific LOA configuration.
GET /porting/loa_configurations/{id}/preview
javascript
const response = await client.porting.loaConfigurations.preview1(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response);

const content = await response.blob();
console.log(content);
预览特定的LOA配置。
GET /porting/loa_configurations/{id}/preview
javascript
const response = await client.porting.loaConfigurations.preview1(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response);

const content = await response.blob();
console.log(content);

List porting related reports

列出转网相关报告

List the reports generated about porting operations.
GET /porting/reports
javascript
// Automatically fetches more pages as needed.
for await (const portingReport of client.porting.reports.list()) {
  console.log(portingReport.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const portingReport of client.porting.reports.list()) {
  console.log(portingReport.id);
}
返回：
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
javascript
const report = await client.porting.reports.create({
  params: { filters: {} },
  report_type: 'export_porting_orders_csv',
});

console.log(report.data);
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
javascript
const report = await client.porting.reports.create({
  params: { filters: {} },
  report_type: 'export_porting_orders_csv',
});

console.log(report.data);
返回：
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}
javascript
const report = await client.porting.reports.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(report.data);
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}
javascript
const report = await client.porting.reports.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(report.data);
返回：
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
javascript
const response = await client.porting.listUkCarriers();

console.log(response.data);
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
javascript
const response = await client.porting.listUkCarriers();

console.log(response.data);
返回：
alternative_cupids
（array[string]），
created_at
（日期时间），
cupid
（字符串），
id
（uuid），
name
（字符串），
record_type
（字符串），
updated_at
（日期时间）

List all porting orders

列出所有转网订单

Returns a list of your porting order.
GET /porting_orders
javascript
// Automatically fetches more pages as needed.
for await (const portingOrder of client.portingOrders.list()) {
  console.log(portingOrder.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const portingOrder of client.portingOrders.list()) {
  console.log(portingOrder.id);
}
返回：
activation_settings
（对象），
additional_steps
（array[string]），
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
（array[object]），
porting_phone_numbers_count
（整数），
record_type
（字符串），
requirements
（array[object]），
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)
javascript
const portingOrder = await client.portingOrders.create({
  phone_numbers: ['+13035550000', '+13035550001', '+13035550002'],
});

console.log(portingOrder.data);
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）
javascript
const portingOrder = await client.portingOrders.create({
  phone_numbers: ['+13035550000', '+13035550001', '+13035550002'],
});

console.log(portingOrder.data);
返回：
activation_settings
（对象），
additional_steps
（array[string]），
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
（array[object]），
porting_phone_numbers_count
（整数），
record_type
（字符串），
requirements
（array[object]），
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
javascript
const response = await client.portingOrders.retrieveExceptionTypes();

console.log(response.data);
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
javascript
const response = await client.portingOrders.retrieveExceptionTypes();

console.log(response.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const phoneNumberConfigurationListResponse of client.portingOrders.phoneNumberConfigurations.list()) {
  console.log(phoneNumberConfigurationListResponse.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const phoneNumberConfigurationListResponse of client.portingOrders.phoneNumberConfigurations.list()) {
  console.log(phoneNumberConfigurationListResponse.id);
}
返回：
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
javascript
const phoneNumberConfiguration = await client.portingOrders.phoneNumberConfigurations.create();

console.log(phoneNumberConfiguration.data);
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
javascript
const phoneNumberConfiguration = await client.portingOrders.phoneNumberConfigurations.create();

console.log(phoneNumberConfiguration.data);
返回：
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}
javascript
const portingOrder = await client.portingOrders.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(portingOrder.data);
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}
javascript
const portingOrder = await client.portingOrders.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(portingOrder.data);
返回：
activation_settings
（对象），
additional_steps
（array[string]），
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
（array[object]），
porting_phone_numbers_count
（整数），
record_type
（字符串），
requirements
（array[object]），
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)
javascript
const portingOrder = await client.portingOrders.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(portingOrder.data);
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
（array[object]），
user_feedback
（对象），
webhook_url
（uri）
javascript
const portingOrder = await client.portingOrders.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(portingOrder.data);
返回：
activation_settings
（对象），
additional_steps
（array[string]），
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
（array[object]），
porting_phone_numbers_count
（整数），
record_type
（字符串），
requirements
（array[object]），
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}
javascript
await client.portingOrders.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
删除现有转网订单。此操作仅适用于草稿状态的转网订单。
DELETE /porting_orders/{id}
javascript
await client.portingOrders.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

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
javascript
const response = await client.portingOrders.actions.activate(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
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
javascript
const response = await client.portingOrders.actions.activate(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
返回：
activate_at
（日期时间），
activation_type
（枚举：scheduled, on-demand），
activation_windows
（array[object]），
created_at
（日期时间），
id
（uuid），
record_type
（字符串），
status
（枚举：created, in-process, completed, failed），
updated_at
（日期时间）

Cancel a porting order

取消转网订单

POST /porting_orders/{id}/actions/cancel
javascript
const response = await client.portingOrders.actions.cancel('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
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
javascript
const response = await client.portingOrders.actions.cancel('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
返回：
activation_settings
（对象），
additional_steps
（array[string]），
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
（array[object]），
porting_phone_numbers_count
（整数），
record_type
（字符串），
requirements
（array[object]），
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
javascript
const response = await client.portingOrders.actions.confirm('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
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
javascript
const response = await client.portingOrders.actions.confirm('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
返回：
activation_settings
（对象），
additional_steps
（array[string]），
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
（array[object]），
porting_phone_numbers_count
（整数），
record_type
（字符串），
requirements
（array[object]），
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
javascript
const response = await client.portingOrders.actions.share('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
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
javascript
const response = await client.portingOrders.actions.share('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
返回：
created_at
（日期时间），
expires_at
（日期时间），
expires_in_seconds
（整数），
id
（uuid），
permissions
（array[string]），
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
javascript
// Automatically fetches more pages as needed.
for await (const portingOrdersActivationJob of client.portingOrders.activationJobs.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingOrdersActivationJob.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const portingOrdersActivationJob of client.portingOrders.activationJobs.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingOrdersActivationJob.id);
}
返回：
activate_at
（日期时间），
activation_type
（枚举：scheduled, on-demand），
activation_windows
（array[object]），
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}
javascript
const activationJob = await client.portingOrders.activationJobs.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(activationJob.data);
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}
javascript
const activationJob = await client.portingOrders.activationJobs.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(activationJob.data);
返回：
activate_at
（日期时间），
activation_type
（枚举：scheduled, on-demand），
activation_windows
（array[object]），
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}
javascript
const activationJob = await client.portingOrders.activationJobs.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(activationJob.data);
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}
javascript
const activationJob = await client.portingOrders.activationJobs.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(activationJob.data);
返回：
activate_at
（日期时间），
activation_type
（枚举：scheduled, on-demand），
activation_windows
（array[object]），
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
javascript
// Automatically fetches more pages as needed.
for await (const additionalDocumentListResponse of client.portingOrders.additionalDocuments.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(additionalDocumentListResponse.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const additionalDocumentListResponse of client.portingOrders.additionalDocuments.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(additionalDocumentListResponse.id);
}
返回：
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
javascript
const additionalDocument = await client.portingOrders.additionalDocuments.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(additionalDocument.data);
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
javascript
const additionalDocument = await client.portingOrders.additionalDocuments.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(additionalDocument.data);
返回：
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}
javascript
await client.portingOrders.additionalDocuments.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
删除转网订单的附加文档。
DELETE /porting_orders/{id}/additional_documents/{additional_document_id}
javascript
await client.portingOrders.additionalDocuments.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

List allowed FOC dates

列出允许的FOC日期

Returns a list of allowed FOC dates for a porting order.
GET /porting_orders/{id}/allowed_foc_windows
javascript
const response = await client.portingOrders.retrieveAllowedFocWindows(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
Returns: 
ended_at
(date-time), 
record_type
(string), 
started_at
(date-time)
返回转网订单允许的FOC日期列表。
GET /porting_orders/{id}/allowed_foc_windows
javascript
const response = await client.portingOrders.retrieveAllowedFocWindows(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const commentListResponse of client.portingOrders.comments.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(commentListResponse.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const commentListResponse of client.portingOrders.comments.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(commentListResponse.id);
}
返回：
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)
javascript
const comment = await client.portingOrders.comments.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(comment.data);
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
（字符串）
javascript
const comment = await client.portingOrders.comments.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(comment.data);
返回：
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
javascript
const response = await client.portingOrders.retrieveLoaTemplate(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response);

const content = await response.blob();
console.log(content);
GET /porting_orders/{id}/loa_template
javascript
const response = await client.portingOrders.retrieveLoaTemplate(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response);

const content = await response.blob();
console.log(content);

List porting order requirements

列出转网订单要求

Returns a list of all requirements based on country/number type for this porting order.
GET /porting_orders/{id}/requirements
javascript
// Automatically fetches more pages as needed.
for await (const portingOrderRetrieveRequirementsResponse of client.portingOrders.retrieveRequirements(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingOrderRetrieveRequirementsResponse.field_type);
}
Returns: 
field_type
(enum: document, textual), 
field_value
(string), 
record_type
(string), 
requirement_status
(string), 
requirement_type
(object)
返回基于国家/号码类型的转网订单所有要求列表。
GET /porting_orders/{id}/requirements
javascript
// Automatically fetches more pages as needed.
for await (const portingOrderRetrieveRequirementsResponse of client.portingOrders.retrieveRequirements(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingOrderRetrieveRequirementsResponse.field_type);
}
返回：
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
javascript
const response = await client.portingOrders.retrieveSubRequest(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
Returns: 
port_request_id
(string), 
sub_request_id
(string)
GET /porting_orders/{id}/sub_request
javascript
const response = await client.portingOrders.retrieveSubRequest(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const verificationCodeListResponse of client.portingOrders.verificationCodes.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(verificationCodeListResponse.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const verificationCodeListResponse of client.portingOrders.verificationCodes.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(verificationCodeListResponse.id);
}
返回：
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
javascript
await client.portingOrders.verificationCodes.send('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
为所有转网电话号码发送验证码。
POST /porting_orders/{id}/verification_codes/send
javascript
await client.portingOrders.verificationCodes.send('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

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
javascript
const response = await client.portingOrders.verificationCodes.verify(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
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
javascript
const response = await client.portingOrders.verificationCodes.verify(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const actionRequirementListResponse of client.portingOrders.actionRequirements.list(
  'porting_order_id',
)) {
  console.log(actionRequirementListResponse.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const actionRequirementListResponse of client.portingOrders.actionRequirements.list(
  'porting_order_id',
)) {
  console.log(actionRequirementListResponse.id);
}
返回：
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
javascript
const response = await client.portingOrders.actionRequirements.initiate('id', {
  porting_order_id: '550e8400-e29b-41d4-a716-446655440000',
  params: { first_name: 'John', last_name: 'Doe' },
});

console.log(response.data);
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
javascript
const response = await client.portingOrders.actionRequirements.initiate('id', {
  porting_order_id: '550e8400-e29b-41d4-a716-446655440000',
  params: { first_name: 'John', last_name: 'Doe' },
});

console.log(response.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const portingAssociatedPhoneNumber of client.portingOrders.associatedPhoneNumbers.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingAssociatedPhoneNumber.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const portingAssociatedPhoneNumber of client.portingOrders.associatedPhoneNumbers.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingAssociatedPhoneNumber.id);
}
返回：
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
javascript
const associatedPhoneNumber = await client.portingOrders.associatedPhoneNumbers.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    action: 'keep',
    phone_number_range: {},
  },
);

console.log(associatedPhoneNumber.data);
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
javascript
const associatedPhoneNumber = await client.portingOrders.associatedPhoneNumbers.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    action: 'keep',
    phone_number_range: {},
  },
);

console.log(associatedPhoneNumber.data);
返回：
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}
javascript
const associatedPhoneNumber = await client.portingOrders.associatedPhoneNumbers.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(associatedPhoneNumber.data);
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}
javascript
const associatedPhoneNumber = await client.portingOrders.associatedPhoneNumbers.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(associatedPhoneNumber.data);
返回：
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
javascript
// Automatically fetches more pages as needed.
for await (const portingPhoneNumberBlock of client.portingOrders.phoneNumberBlocks.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingPhoneNumberBlock.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const portingPhoneNumberBlock of client.portingOrders.phoneNumberBlocks.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingPhoneNumberBlock.id);
}
返回：
activation_ranges
（array[object]），
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
javascript
const phoneNumberBlock = await client.portingOrders.phoneNumberBlocks.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    activation_ranges: [{ end_at: '+4930244999910', start_at: '+4930244999901' }],
    phone_number_range: { end_at: '+4930244999910', start_at: '+4930244999901' },
  },
);

console.log(phoneNumberBlock.data);
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
javascript
const phoneNumberBlock = await client.portingOrders.phoneNumberBlocks.create(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  {
    activation_ranges: [{ end_at: '+4930244999910', start_at: '+4930244999901' }],
    phone_number_range: { end_at: '+4930244999910', start_at: '+4930244999901' },
  },
);

console.log(phoneNumberBlock.data);
返回：
activation_ranges
（array[object]），
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}
javascript
const phoneNumberBlock = await client.portingOrders.phoneNumberBlocks.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(phoneNumberBlock.data);
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}
javascript
const phoneNumberBlock = await client.portingOrders.phoneNumberBlocks.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(phoneNumberBlock.data);
返回：
activation_ranges
（array[object]），
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
javascript
// Automatically fetches more pages as needed.
for await (const portingPhoneNumberExtension of client.portingOrders.phoneNumberExtensions.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingPhoneNumberExtension.id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const portingPhoneNumberExtension of client.portingOrders.phoneNumberExtensions.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingPhoneNumberExtension.id);
}
返回：
activation_ranges
（array[object]），
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
javascript
const phoneNumberExtension = await client.portingOrders.phoneNumberExtensions.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',
  },
);

console.log(phoneNumberExtension.data);
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
javascript
const phoneNumberExtension = await client.portingOrders.phoneNumberExtensions.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',
  },
);

console.log(phoneNumberExtension.data);
返回：
activation_ranges
（array[object]），
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}
javascript
const phoneNumberExtension = await client.portingOrders.phoneNumberExtensions.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(phoneNumberExtension.data);
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}
javascript
const phoneNumberExtension = await client.portingOrders.phoneNumberExtensions.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { porting_order_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(phoneNumberExtension.data);
返回：
activation_ranges
（array[object]），
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
javascript
// Automatically fetches more pages as needed.
for await (const portingPhoneNumberListResponse of client.portingPhoneNumbers.list()) {
  console.log(portingPhoneNumberListResponse.porting_order_id);
}
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
javascript
// Automatically fetches more pages as needed.
for await (const portingPhoneNumberListResponse of client.portingPhoneNumbers.list()) {
  console.log(portingPhoneNumberListResponse.porting_order_id);
}
返回：
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
（字符串）