telnyx-numbers-javascript

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Telnyx Numbers - 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'], // 这是默认值，可省略
});

以下所有示例均假设

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 availablePhoneNumbers = await client.availablePhoneNumbers.list();
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    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:

invalid API key,

insufficient permissions,

resource not found,

validation error (check field formats),

rate limited (retry with exponential backoff).

所有API调用都可能因网络错误、速率限制（429）、验证错误（422）或身份验证错误（401）而失败。在生产代码中务必处理错误：

javascript

try {
  const availablePhoneNumbers = await client.availablePhoneNumbers.list();
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('网络错误 — 检查连接性并重试');
  } else if (err instanceof Telnyx.RateLimitError) {
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API错误 ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('验证错误 — 检查必填字段和格式');
    }
  }
}

常见错误码：

无效API密钥，

权限不足，

资源未找到，

验证错误（检查字段格式），

速率限制（使用指数退避重试）。

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) { ... }
```
自动遍历所有页面。

Reference Use Rules

参考使用规则

Do not invent Telnyx parameters, enums, response fields, or webhook fields.

If the parameter, enum, or response field you need is not shown inline in this skill, read references/api-details.md before writing code.
Before using any operation in
```
## Additional Operations
```
, read the optional-parameters section and the response-schemas section.

请勿自行杜撰Telnyx的参数、枚举、响应字段或Webhook字段。

如果您需要的参数、枚举或响应字段未在本技能中直接显示，请在编写代码前阅读references/api-details.md。
在使用
```
## 额外操作
```
中的任何操作前，请阅读可选参数章节和响应模式章节。

Core Tasks

核心任务

Search available phone numbers

搜索可用电话号码

Number search is the entrypoint for provisioning. Agents need the search method, key query filters, and the fields returned for candidate numbers.

client.availablePhoneNumbers.list()

—

GET /available_phone_numbers

Parameter	Type	Required	Description
`filter`	object	No	Consolidated filter parameter (deepObject style).

javascript

const availablePhoneNumbers = await client.availablePhoneNumbers.list();

console.log(availablePhoneNumbers.data);

Response wrapper:

items:
```
availablePhoneNumbers.data
```
pagination:
```
availablePhoneNumbers.meta
```

Primary item fields:

```
phoneNumber
```
```
recordType
```
```
quickship
```
```
reservable
```
```
bestEffort
```
```
costInformation
```

号码搜索是配置流程的入口。开发人员需要了解搜索方法、关键查询过滤器以及候选号码返回的字段。

client.availablePhoneNumbers.list()

—

GET /available_phone_numbers

参数	类型	是否必填	描述
`filter`	object	否	合并的过滤参数（deepObject格式）。

javascript

const availablePhoneNumbers = await client.availablePhoneNumbers.list();

console.log(availablePhoneNumbers.data);

响应包装器：

条目:
```
availablePhoneNumbers.data
```
分页:
```
availablePhoneNumbers.meta
```

主要条目字段：

```
phoneNumber
```
```
recordType
```
```
quickship
```
```
reservable
```
```
bestEffort
```
```
costInformation
```

Create a number order

创建号码订单

Number ordering is the production provisioning step after number selection.

client.numberOrders.create()

—

POST /number_orders

Parameter	Type	Required	Description
`phoneNumbers`	array[object]	Yes
`connectionId`	string (UUID)	No	Identifies the connection associated with this phone number.
`messagingProfileId`	string (UUID)	No	Identifies the messaging profile associated with the phone n...
`billingGroupId`	string (UUID)	No	Identifies the billing group associated with the phone numbe...
...			+1 optional params in references/api-details.md

javascript

const numberOrder = await client.numberOrders.create({
    phoneNumbers: [{"phone_number": "+18005550101"}],
});

console.log(numberOrder.data);

Primary response fields:

```
numberOrder.data.id
```
```
numberOrder.data.status
```
```
numberOrder.data.phoneNumbersCount
```
```
numberOrder.data.requirementsMet
```
```
numberOrder.data.messagingProfileId
```
```
numberOrder.data.connectionId
```

号码订购是选号完成后的生产配置步骤。

client.numberOrders.create()

—

POST /number_orders

参数	类型	是否必填	描述
`phoneNumbers`	array[object]	是
`connectionId`	string (UUID)	否	标识与此电话号码关联的连接。
`messagingProfileId`	string (UUID)	否	标识与此电话号码关联的消息配置文件。
`billingGroupId`	string (UUID)	否	标识与此电话号码关联的计费组。
...			+1个可选参数请查看references/api-details.md

javascript

const numberOrder = await client.numberOrders.create({
    phoneNumbers: [{"phone_number": "+18005550101"}],
});

console.log(numberOrder.data);

主要响应字段：

```
numberOrder.data.id
```
```
numberOrder.data.status
```
```
numberOrder.data.phoneNumbersCount
```
```
numberOrder.data.requirementsMet
```
```
numberOrder.data.messagingProfileId
```
```
numberOrder.data.connectionId
```

Check number order status

检查号码订单状态

Order status determines whether provisioning completed or additional requirements are still blocking fulfillment.

client.numberOrders.retrieve()

—

GET /number_orders/{number_order_id}

Parameter	Type	Required	Description
`numberOrderId`	string (UUID)	Yes	The number order ID.

javascript

const numberOrder = await client.numberOrders.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(numberOrder.data);

Primary response fields:

```
numberOrder.data.id
```
```
numberOrder.data.status
```
```
numberOrder.data.requirementsMet
```
```
numberOrder.data.phoneNumbersCount
```
```
numberOrder.data.phoneNumbers
```
```
numberOrder.data.connectionId
```

订单状态决定配置是否完成，或者是否仍有额外要求阻碍完成。

client.numberOrders.retrieve()

—

GET /number_orders/{number_order_id}

参数	类型	是否必填	描述
`numberOrderId`	string (UUID)	是	号码订单ID。

javascript

const numberOrder = await client.numberOrders.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(numberOrder.data);

主要响应字段：

```
numberOrder.data.id
```
```
numberOrder.data.status
```
```
numberOrder.data.requirementsMet
```
```
numberOrder.data.phoneNumbersCount
```
```
numberOrder.data.phoneNumbers
```
```
numberOrder.data.connectionId
```

Important Supporting Operations

重要支持操作

Use these when the core tasks above are close to your flow, but you need a common variation or follow-up step.

当核心任务接近您的流程，但您需要常见变体或后续步骤时使用这些操作。

Create a number reservation

创建号码预留

Create or provision an additional resource when the core tasks do not cover this flow.

client.numberReservations.create()

—

POST /number_reservations

Parameter	Type	Required	Description
`phoneNumbers`	array[object]	Yes
`status`	enum (pending, success, failure)	No	The status of the entire reservation.
`id`	string (UUID)	No
`recordType`	string	No
...			+3 optional params in references/api-details.md

javascript

const numberReservation = await client.numberReservations.create({
    phoneNumbers: [{"phone_number": "+18005550101"}],
});

console.log(numberReservation.data);

Primary response fields:

```
numberReservation.data.id
```
```
numberReservation.data.status
```
```
numberReservation.data.createdAt
```
```
numberReservation.data.updatedAt
```

numberReservation.data.customerReference

```
numberReservation.data.errors
```

当核心任务未涵盖此流程时，创建或配置额外资源。

client.numberReservations.create()

—

POST /number_reservations

参数	类型	是否必填	描述
`phoneNumbers`	array[object]	是
`status`	enum (pending, success, failure)	否	整个预留的状态。
`id`	string (UUID)	否
`recordType`	string	否
...			+3个可选参数请查看references/api-details.md

javascript

const numberReservation = await client.numberReservations.create({
    phoneNumbers: [{"phone_number": "+18005550101"}],
});

console.log(numberReservation.data);

主要响应字段：

```
numberReservation.data.id
```
```
numberReservation.data.status
```
```
numberReservation.data.createdAt
```
```
numberReservation.data.updatedAt
```

numberReservation.data.customerReference

```
numberReservation.data.errors
```

Retrieve a number reservation

获取号码预留

Fetch the current state before updating, deleting, or making control-flow decisions.

client.numberReservations.retrieve()

—

GET /number_reservations/{number_reservation_id}

Parameter	Type	Required	Description
`numberReservationId`	string (UUID)	Yes	The number reservation ID.

javascript

const numberReservation = await client.numberReservations.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(numberReservation.data);

Primary response fields:

```
numberReservation.data.id
```
```
numberReservation.data.status
```
```
numberReservation.data.createdAt
```
```
numberReservation.data.updatedAt
```

numberReservation.data.customerReference

```
numberReservation.data.errors
```

在更新、删除或做出控制流决策前获取当前状态。

client.numberReservations.retrieve()

—

GET /number_reservations/{number_reservation_id}

参数	类型	是否必填	描述
`numberReservationId`	string (UUID)	是	号码预留ID。

javascript

const numberReservation = await client.numberReservations.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(numberReservation.data);

主要响应字段：

```
numberReservation.data.id
```
```
numberReservation.data.status
```
```
numberReservation.data.createdAt
```
```
numberReservation.data.updatedAt
```

numberReservation.data.customerReference

```
numberReservation.data.errors
```

List Advanced Orders

列出高级订单

Inspect available resources or choose an existing resource before mutating it.

client.advancedOrders.list()

—

GET /advanced_orders

javascript

const advancedOrders = await client.advancedOrders.list();

console.log(advancedOrders.data);

Response wrapper:

items:
```
advancedOrders.data
```

Primary item fields:

```
id
```
```
status
```
```
areaCode
```
```
comments
```
```
countryCode
```
```
customerReference
```

在修改资源前检查可用资源或选择现有资源。

client.advancedOrders.list()

—

GET /advanced_orders

javascript

const advancedOrders = await client.advancedOrders.list();

console.log(advancedOrders.data);

响应包装器：

条目:
```
advancedOrders.data
```

主要条目字段：

```
id
```
```
status
```
```
areaCode
```
```
comments
```
```
countryCode
```
```
customerReference
```

Create Advanced Order

创建高级订单

Create or provision an additional resource when the core tasks do not cover this flow.

client.advancedOrders.create()

—

POST /advanced_orders

Parameter	Type	Required	Description
`phoneNumberType`	enum (local, mobile, toll_free, shared_cost, national, ...)	No
`requirementGroupId`	string (UUID)	No	The ID of the requirement group to associate with this advan...
`countryCode`	string (ISO 3166-1 alpha-2)	No
...			+5 optional params in references/api-details.md

javascript

const advancedOrder = await client.advancedOrders.create();

console.log(advancedOrder.id);

Primary response fields:

```
advancedOrder.id
```
```
advancedOrder.status
```
```
advancedOrder.areaCode
```
```
advancedOrder.comments
```
```
advancedOrder.countryCode
```
```
advancedOrder.customerReference
```

当核心任务未涵盖此流程时，创建或配置额外资源。

client.advancedOrders.create()

—

POST /advanced_orders

参数	类型	是否必填	描述
`phoneNumberType`	enum (local, mobile, toll_free, shared_cost, national, ...)	否
`requirementGroupId`	string (UUID)	否	标识与此高级订单关联的要求组ID。
`countryCode`	string (ISO 3166-1 alpha-2)	否
...			+5个可选参数请查看references/api-details.md

javascript

const advancedOrder = await client.advancedOrders.create();

console.log(advancedOrder.id);

主要响应字段：

```
advancedOrder.id
```
```
advancedOrder.status
```
```
advancedOrder.areaCode
```
```
advancedOrder.comments
```
```
advancedOrder.countryCode
```
```
advancedOrder.customerReference
```

Update Advanced Order

更新高级订单

Modify an existing resource without recreating it.

client.advancedOrders.updateRequirementGroup()

—

PATCH /advanced_orders/{advanced-order-id}/requirement_group

Parameter	Type	Required	Description
`advanced-order-id`	string (UUID)	Yes
`phoneNumberType`	enum (local, mobile, toll_free, shared_cost, national, ...)	No
`requirementGroupId`	string (UUID)	No	The ID of the requirement group to associate with this advan...
`countryCode`	string (ISO 3166-1 alpha-2)	No
...			+5 optional params in references/api-details.md

javascript

const response = await client.advancedOrders.updateRequirementGroup(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.id);

Primary response fields:

```
response.id
```
```
response.status
```
```
response.areaCode
```
```
response.comments
```
```
response.countryCode
```
```
response.customerReference
```

无需重新创建即可修改现有资源。

client.advancedOrders.updateRequirementGroup()

—

PATCH /advanced_orders/{advanced-order-id}/requirement_group

参数	类型	是否必填	描述
`advanced-order-id`	string (UUID)	是
`phoneNumberType`	enum (local, mobile, toll_free, shared_cost, national, ...)	否
`requirementGroupId`	string (UUID)	否	标识与此高级订单关联的要求组ID。
`countryCode`	string (ISO 3166-1 alpha-2)	否
...			+5个可选参数请查看references/api-details.md

javascript

const response = await client.advancedOrders.updateRequirementGroup(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.id);

主要响应字段：

```
response.id
```
```
response.status
```
```
response.areaCode
```
```
response.comments
```
```
response.countryCode
```
```
response.customerReference
```

Get Advanced Order

获取高级订单

Fetch the current state before updating, deleting, or making control-flow decisions.

client.advancedOrders.retrieve()

—

GET /advanced_orders/{order_id}

Parameter	Type	Required	Description
`orderId`	string (UUID)	Yes

javascript

const advancedOrder = await client.advancedOrders.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(advancedOrder.id);

Primary response fields:

```
advancedOrder.id
```
```
advancedOrder.status
```
```
advancedOrder.areaCode
```
```
advancedOrder.comments
```
```
advancedOrder.countryCode
```
```
advancedOrder.customerReference
```

在更新、删除或做出控制流决策前获取当前状态。

client.advancedOrders.retrieve()

—

GET /advanced_orders/{order_id}

参数	类型	是否必填	描述
`orderId`	string (UUID)	是

javascript

const advancedOrder = await client.advancedOrders.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(advancedOrder.id);

主要响应字段：

```
advancedOrder.id
```
```
advancedOrder.status
```
```
advancedOrder.areaCode
```
```
advancedOrder.comments
```
```
advancedOrder.countryCode
```
```
advancedOrder.customerReference
```

List available phone number blocks

列出可用电话号码块

Inspect available resources or choose an existing resource before mutating it.

client.availablePhoneNumberBlocks.list()

—

GET /available_phone_number_blocks

Parameter	Type	Required	Description
`filter`	object	No	Consolidated filter parameter (deepObject style).

javascript

const availablePhoneNumberBlocks = await client.availablePhoneNumberBlocks.list();

console.log(availablePhoneNumberBlocks.data);

Response wrapper:

items:
```
availablePhoneNumberBlocks.data
```
pagination:
```
availablePhoneNumberBlocks.meta
```

Primary item fields:

```
phoneNumber
```
```
costInformation
```
```
features
```
```
range
```
```
recordType
```
```
regionInformation
```

在修改资源前检查可用资源或选择现有资源。

client.availablePhoneNumberBlocks.list()

—

GET /available_phone_number_blocks

参数	类型	是否必填	描述
`filter`	object	否	合并的过滤参数（deepObject格式）。

javascript

const availablePhoneNumberBlocks = await client.availablePhoneNumberBlocks.list();

console.log(availablePhoneNumberBlocks.data);

响应包装器：

条目:
```
availablePhoneNumberBlocks.data
```
分页:
```
availablePhoneNumberBlocks.meta
```

主要条目字段：

```
phoneNumber
```
```
costInformation
```
```
features
```
```
range
```
```
recordType
```
```
regionInformation
```

Retrieve all comments

获取所有评论

Inspect available resources or choose an existing resource before mutating it.

client.comments.list()

—

GET /comments

Parameter	Type	Required	Description
`filter`	object	No	Consolidated filter parameter (deepObject style).

javascript

const comments = await client.comments.list();

console.log(comments.data);

Response wrapper:

items:
```
comments.data
```
pagination:
```
comments.meta
```

Primary item fields:

```
id
```
```
body
```
```
createdAt
```
```
updatedAt
```
```
commentRecordId
```
```
commentRecordType
```

在修改资源前检查可用资源或选择现有资源。

client.comments.list()

—

GET /comments

参数	类型	是否必填	描述
`filter`	object	否	合并的过滤参数（deepObject格式）。

javascript

const comments = await client.comments.list();

console.log(comments.data);

响应包装器：

条目:
```
comments.data
```
分页:
```
comments.meta
```

主要条目字段：

```
id
```
```
body
```
```
createdAt
```
```
updatedAt
```
```
commentRecordId
```
```
commentRecordType
```

Additional Operations

额外操作

Use the core tasks above first. The operations below are indexed here with exact SDK methods and required params; use references/api-details.md for full optional params, response schemas, and lower-frequency webhook payloads. Before using any operation below, read the optional-parameters section and the response-schemas section so you do not guess missing fields.

Operation	SDK method	Endpoint	Use when	Required params
Create a comment	`client.comments.create()`	`POST /comments`	Create or provision an additional resource when the core tasks do not cover this flow.	None
Retrieve a comment	`client.comments.retrieve()`	`GET /comments/{id}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`id`
Mark a comment as read	`client.comments.markAsRead()`	`PATCH /comments/{id}/read`	Modify an existing resource without recreating it.	`id`
Get country coverage	`client.countryCoverage.retrieve()`	`GET /country_coverage`	Inspect available resources or choose an existing resource before mutating it.	None
Get coverage for a specific country	`client.countryCoverage.retrieveCountry()`	`GET /country_coverage/countries/{country_code}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`countryCode`
List customer service records	`client.customerServiceRecords.list()`	`GET /customer_service_records`	Inspect available resources or choose an existing resource before mutating it.	None
Create a customer service record	`client.customerServiceRecords.create()`	`POST /customer_service_records`	Create or provision an additional resource when the core tasks do not cover this flow.	None
Verify CSR phone number coverage	`client.customerServiceRecords.verifyPhoneNumberCoverage()`	`POST /customer_service_records/phone_number_coverages`	Create or provision an additional resource when the core tasks do not cover this flow.	None
Get a customer service record	`client.customerServiceRecords.retrieve()`	`GET /customer_service_records/{customer_service_record_id}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`customerServiceRecordId`
List inexplicit number orders	`client.inexplicitNumberOrders.list()`	`GET /inexplicit_number_orders`	Inspect available resources or choose an existing resource before mutating it.	None
Create an inexplicit number order	`client.inexplicitNumberOrders.create()`	`POST /inexplicit_number_orders`	Create or provision an additional resource when the core tasks do not cover this flow.	`orderingGroups`
Retrieve an inexplicit number order	`client.inexplicitNumberOrders.retrieve()`	`GET /inexplicit_number_orders/{id}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`id`
Create an inventory coverage request	`client.inventoryCoverage.list()`	`GET /inventory_coverage`	Inspect available resources or choose an existing resource before mutating it.	None
List mobile network operators	`client.mobileNetworkOperators.list()`	`GET /mobile_network_operators`	Inspect available resources or choose an existing resource before mutating it.	None
List network coverage locations	`client.networkCoverage.list()`	`GET /network_coverage`	Inspect available resources or choose an existing resource before mutating it.	None
List number block orders	`client.numberBlockOrders.list()`	`GET /number_block_orders`	Inspect available resources or choose an existing resource before mutating it.	None
Create a number block order	`client.numberBlockOrders.create()`	`POST /number_block_orders`	Create or provision an additional resource when the core tasks do not cover this flow.	`startingNumber` , `range`
Retrieve a number block order	`client.numberBlockOrders.retrieve()`	`GET /number_block_orders/{number_block_order_id}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`numberBlockOrderId`
Retrieve a list of phone numbers associated to orders	`client.numberOrderPhoneNumbers.list()`	`GET /number_order_phone_numbers`	Inspect available resources or choose an existing resource before mutating it.	None
Retrieve a single phone number within a number order.	`client.numberOrderPhoneNumbers.retrieve()`	`GET /number_order_phone_numbers/{number_order_phone_number_id}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`numberOrderPhoneNumberId`
Update requirements for a single phone number within a number order.	`client.numberOrderPhoneNumbers.updateRequirements()`	`PATCH /number_order_phone_numbers/{number_order_phone_number_id}`	Modify an existing resource without recreating it.	`numberOrderPhoneNumberId`
List number orders	`client.numberOrders.list()`	`GET /number_orders`	Create or inspect provisioning orders for number purchases.	None
Update a number order	`client.numberOrders.update()`	`PATCH /number_orders/{number_order_id}`	Modify an existing resource without recreating it.	`numberOrderId`
List number reservations	`client.numberReservations.list()`	`GET /number_reservations`	Inspect available resources or choose an existing resource before mutating it.	None
Extend a number reservation	`client.numberReservations.actions.extend()`	`POST /number_reservations/{number_reservation_id}/actions/extend`	Trigger a follow-up action in an existing workflow rather than creating a new top-level resource.	`numberReservationId`
Retrieve the features for a list of numbers	`client.numbersFeatures.create()`	`POST /numbers_features`	Create or provision an additional resource when the core tasks do not cover this flow.	`phoneNumbers`
Lists the phone number blocks jobs	`client.phoneNumberBlocks.jobs.list()`	`GET /phone_number_blocks/jobs`	Inspect available resources or choose an existing resource before mutating it.	None
Deletes all numbers associated with a phone number block	`client.phoneNumberBlocks.jobs.deletePhoneNumberBlock()`	`POST /phone_number_blocks/jobs/delete_phone_number_block`	Create or provision an additional resource when the core tasks do not cover this flow.	`phoneNumberBlockId`
Retrieves a phone number blocks job	`client.phoneNumberBlocks.jobs.retrieve()`	`GET /phone_number_blocks/jobs/{id}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`id`
List sub number orders	`client.subNumberOrders.list()`	`GET /sub_number_orders`	Inspect available resources or choose an existing resource before mutating it.	None
Retrieve a sub number order	`client.subNumberOrders.retrieve()`	`GET /sub_number_orders/{sub_number_order_id}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`subNumberOrderId`
Update a sub number order's requirements	`client.subNumberOrders.update()`	`PATCH /sub_number_orders/{sub_number_order_id}`	Modify an existing resource without recreating it.	`subNumberOrderId`
Cancel a sub number order	`client.subNumberOrders.cancel()`	`PATCH /sub_number_orders/{sub_number_order_id}/cancel`	Modify an existing resource without recreating it.	`subNumberOrderId`
Create a sub number orders report	`client.subNumberOrdersReport.create()`	`POST /sub_number_orders_report`	Create or provision an additional resource when the core tasks do not cover this flow.	None
Retrieve a sub number orders report	`client.subNumberOrdersReport.retrieve()`	`GET /sub_number_orders_report/{report_id}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`reportId`
Download a sub number orders report	`client.subNumberOrdersReport.download()`	`GET /sub_number_orders_report/{report_id}/download`	Fetch the current state before updating, deleting, or making control-flow decisions.	`reportId`

优先使用上述核心任务。以下操作在此处列出了确切的SDK方法和必填参数；如需完整的可选参数、响应模式和低频Webhook负载，请查看references/api-details.md。使用以下任何操作前，请阅读可选参数章节和响应模式章节，避免猜测缺失字段。

操作	SDK方法	端点	使用场景	必填参数
创建评论	`client.comments.create()`	`POST /comments`	当核心任务未涵盖此流程时，创建或配置额外资源。	无
获取评论	`client.comments.retrieve()`	`GET /comments/{id}`	在更新、删除或做出控制流决策前获取当前状态。	`id`
标记评论为已读	`client.comments.markAsRead()`	`PATCH /comments/{id}/read`	无需重新创建即可修改现有资源。	`id`
获取国家覆盖范围	`client.countryCoverage.retrieve()`	`GET /country_coverage`	在修改资源前检查可用资源或选择现有资源。	无
获取特定国家的覆盖范围	`client.countryCoverage.retrieveCountry()`	`GET /country_coverage/countries/{country_code}`	在更新、删除或做出控制流决策前获取当前状态。	`countryCode`
列出客户服务记录	`client.customerServiceRecords.list()`	`GET /customer_service_records`	在修改资源前检查可用资源或选择现有资源。	无
创建客户服务记录	`client.customerServiceRecords.create()`	`POST /customer_service_records`	当核心任务未涵盖此流程时，创建或配置额外资源。	无
验证CSR电话号码覆盖范围	`client.customerServiceRecords.verifyPhoneNumberCoverage()`	`POST /customer_service_records/phone_number_coverages`	当核心任务未涵盖此流程时，创建或配置额外资源。	无
获取客户服务记录	`client.customerServiceRecords.retrieve()`	`GET /customer_service_records/{customer_service_record_id}`	在更新、删除或做出控制流决策前获取当前状态。	`customerServiceRecordId`
列出非明确号码订单	`client.inexplicitNumberOrders.list()`	`GET /inexplicit_number_orders`	在修改资源前检查可用资源或选择现有资源。	无
创建非明确号码订单	`client.inexplicitNumberOrders.create()`	`POST /inexplicit_number_orders`	当核心任务未涵盖此流程时，创建或配置额外资源。	`orderingGroups`
获取非明确号码订单	`client.inexplicitNumberOrders.retrieve()`	`GET /inexplicit_number_orders/{id}`	在更新、删除或做出控制流决策前获取当前状态。	`id`
创建库存覆盖范围请求	`client.inventoryCoverage.list()`	`GET /inventory_coverage`	在修改资源前检查可用资源或选择现有资源。	无
列出移动网络运营商	`client.mobileNetworkOperators.list()`	`GET /mobile_network_operators`	在修改资源前检查可用资源或选择现有资源。	无
列出网络覆盖位置	`client.networkCoverage.list()`	`GET /network_coverage`	在修改资源前检查可用资源或选择现有资源。	无
列出号码块订单	`client.numberBlockOrders.list()`	`GET /number_block_orders`	在修改资源前检查可用资源或选择现有资源。	无
创建号码块订单	`client.numberBlockOrders.create()`	`POST /number_block_orders`	当核心任务未涵盖此流程时，创建或配置额外资源。	`startingNumber` , `range`
获取号码块订单	`client.numberBlockOrders.retrieve()`	`GET /number_block_orders/{number_block_order_id}`	在更新、删除或做出控制流决策前获取当前状态。	`numberBlockOrderId`
获取与订单关联的电话号码列表	`client.numberOrderPhoneNumbers.list()`	`GET /number_order_phone_numbers`	在修改资源前检查可用资源或选择现有资源。	无
获取号码订单中的单个电话号码	`client.numberOrderPhoneNumbers.retrieve()`	`GET /number_order_phone_numbers/{number_order_phone_number_id}`	在更新、删除或做出控制流决策前获取当前状态。	`numberOrderPhoneNumberId`
更新号码订单中单个电话号码的要求	`client.numberOrderPhoneNumbers.updateRequirements()`	`PATCH /number_order_phone_numbers/{number_order_phone_number_id}`	无需重新创建即可修改现有资源。	`numberOrderPhoneNumberId`
列出号码订单	`client.numberOrders.list()`	`GET /number_orders`	创建或检查号码购买的配置订单。	无
更新号码订单	`client.numberOrders.update()`	`PATCH /number_orders/{number_order_id}`	无需重新创建即可修改现有资源。	`numberOrderId`
列出号码预留	`client.numberReservations.list()`	`GET /number_reservations`	在修改资源前检查可用资源或选择现有资源。	无
延长号码预留期限	`client.numberReservations.actions.extend()`	`POST /number_reservations/{number_reservation_id}/actions/extend`	在现有工作流中触发后续操作，而非创建新的顶级资源。	`numberReservationId`
获取号码列表的功能	`client.numbersFeatures.create()`	`POST /numbers_features`	当核心任务未涵盖此流程时，创建或配置额外资源。	`phoneNumbers`
列出电话号码块任务	`client.phoneNumberBlocks.jobs.list()`	`GET /phone_number_blocks/jobs`	在修改资源前检查可用资源或选择现有资源。	无
删除与电话号码块关联的所有号码	`client.phoneNumberBlocks.jobs.deletePhoneNumberBlock()`	`POST /phone_number_blocks/jobs/delete_phone_number_block`	当核心任务未涵盖此流程时，创建或配置额外资源。	`phoneNumberBlockId`
获取电话号码块任务	`client.phoneNumberBlocks.jobs.retrieve()`	`GET /phone_number_blocks/jobs/{id}`	在更新、删除或做出控制流决策前获取当前状态。	`id`
列出子号码订单	`client.subNumberOrders.list()`	`GET /sub_number_orders`	在修改资源前检查可用资源或选择现有资源。	无
获取子号码订单	`client.subNumberOrders.retrieve()`	`GET /sub_number_orders/{sub_number_order_id}`	在更新、删除或做出控制流决策前获取当前状态。	`subNumberOrderId`
更新子号码订单的要求	`client.subNumberOrders.update()`	`PATCH /sub_number_orders/{sub_number_order_id}`	无需重新创建即可修改现有资源。	`subNumberOrderId`
取消子号码订单	`client.subNumberOrders.cancel()`	`PATCH /sub_number_orders/{sub_number_order_id}/cancel`	无需重新创建即可修改现有资源。	`subNumberOrderId`
创建子号码订单报告	`client.subNumberOrdersReport.create()`	`POST /sub_number_orders_report`	当核心任务未涵盖此流程时，创建或配置额外资源。	无
获取子号码订单报告	`client.subNumberOrdersReport.retrieve()`	`GET /sub_number_orders_report/{report_id}`	在更新、删除或做出控制流决策前获取当前状态。	`reportId`
下载子号码订单报告	`client.subNumberOrdersReport.download()`	`GET /sub_number_orders_report/{report_id}/download`	在更新、删除或做出控制流决策前获取当前状态。	`reportId`

Other Webhook Events

其他Webhook事件

Event	`data.event_type`	Description
`numberOrderStatusUpdate`	`number.order.status.update`	Number Order Status Update

For exhaustive optional parameters, full response schemas, and complete webhook payloads, see references/api-details.md.

事件	`data.event_type`	描述
`numberOrderStatusUpdate`	`number.order.status.update`	号码订单状态更新

如需完整的可选参数、响应模式和Webhook负载，请查看references/api-details.md。