telnyx-numbers-java

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Telnyx Numbers - Java

Installation

安装

text

<!-- Maven -->
<dependency>
    <groupId>com.telnyx.sdk</groupId>
    <artifactId>telnyx</artifactId>
    <version>6.36.0</version>
</dependency>

// Gradle
implementation("com.telnyx.sdk:telnyx:6.36.0")

text

<!-- Maven -->
<dependency>
    <groupId>com.telnyx.sdk</groupId>
    <artifactId>telnyx</artifactId>
    <version>6.36.0</version>
</dependency>

// Gradle
implementation("com.telnyx.sdk:telnyx:6.36.0")

Setup

初始化配置

java

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();

All examples below assume

client

is already initialized as shown above.

java

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.fromEnv();

以下所有示例均假设

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:

java

import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListParams;
import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListResponse;
AvailablePhoneNumberListResponse availablePhoneNumbers = client.availablePhoneNumbers().list();

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)失败，生产环境代码中请务必做好错误处理：

java

import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListParams;
import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListResponse;
AvailablePhoneNumberListResponse availablePhoneNumbers = client.availablePhoneNumbers().list();

常见错误码：

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 a page. Use
```
.autoPager()
```
for automatic iteration:
```
for (var item : page.autoPager()) { ... }
```
. For manual control, use
```
.hasNextPage()
```
and
```
.nextPage()
```
.

电话号码必须采用E.164格式（例如
```
+13125550001
```
），需包含
```
+
```
前缀和国家代码，不可包含空格、短横线或括号。
分页： 列表方法返回单页数据，使用
```
.autoPager()
```
可实现自动遍历：
```
for (var item : page.autoPager()) { ... }
```
。如需手动控制，可使用
```
.hasNextPage()
```
和
```
.nextPage()
```
方法。

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。
使用
```
## 其他操作
```
中的任意接口前，请先阅读可选参数章节和响应Schema章节，请勿猜测缺失字段。

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).

java

import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListParams;
import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListResponse;

AvailablePhoneNumberListResponse availablePhoneNumbers = client.availablePhoneNumbers().list();

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格式）

java

import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListParams;
import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListResponse;

AvailablePhoneNumberListResponse availablePhoneNumbers = client.availablePhoneNumbers().list();

响应包装结构：

数据项:
```
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

java

import com.telnyx.sdk.models.numberorders.NumberOrderCreateParams;
import com.telnyx.sdk.models.numberorders.NumberOrderCreateResponse;

NumberOrderCreateParams params = NumberOrderCreateParams.builder()

    .addPhoneNumber(

        NumberOrderCreateParams.PhoneNumber.builder()

            .phoneNumber("+18005550101")

            .build()

        )

    .build();

NumberOrderCreateResponse numberOrder = client.numberOrders().create(params);

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)	否	标识与该电话号码关联的账单组
...			更多可选参数见references/api-details.md

java

import com.telnyx.sdk.models.numberorders.NumberOrderCreateParams;
import com.telnyx.sdk.models.numberorders.NumberOrderCreateResponse;

NumberOrderCreateParams params = NumberOrderCreateParams.builder()

    .addPhoneNumber(

        NumberOrderCreateParams.PhoneNumber.builder()

            .phoneNumber("+18005550101")

            .build()

        )

    .build();

NumberOrderCreateResponse numberOrder = client.numberOrders().create(params);

核心响应字段：

```
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.

java

import com.telnyx.sdk.models.numberorders.NumberOrderRetrieveParams;
import com.telnyx.sdk.models.numberorders.NumberOrderRetrieveResponse;

NumberOrderRetrieveResponse numberOrder = client.numberOrders().retrieve("550e8400-e29b-41d4-a716-446655440000");

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

java

import com.telnyx.sdk.models.numberorders.NumberOrderRetrieveParams;
import com.telnyx.sdk.models.numberorders.NumberOrderRetrieveResponse;

NumberOrderRetrieveResponse numberOrder = client.numberOrders().retrieve("550e8400-e29b-41d4-a716-446655440000");

核心响应字段：

```
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

java

import com.telnyx.sdk.models.numberreservations.NumberReservationCreateParams;
import com.telnyx.sdk.models.numberreservations.NumberReservationCreateResponse;

NumberReservationCreateParams params = NumberReservationCreateParams.builder()

    .addPhoneNumber(

        NumberReservationCreateParams.PhoneNumber.builder()

            .phoneNumber("+18005550101")

            .build()

        )

    .build();

NumberReservationCreateResponse numberReservation = client.numberReservations().create(params);

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

java

import com.telnyx.sdk.models.numberreservations.NumberReservationCreateParams;
import com.telnyx.sdk.models.numberreservations.NumberReservationCreateResponse;

NumberReservationCreateParams params = NumberReservationCreateParams.builder()

    .addPhoneNumber(

        NumberReservationCreateParams.PhoneNumber.builder()

            .phoneNumber("+18005550101")

            .build()

        )

    .build();

NumberReservationCreateResponse numberReservation = client.numberReservations().create(params);

核心响应字段：

```
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.

java

import com.telnyx.sdk.models.numberreservations.NumberReservationRetrieveParams;
import com.telnyx.sdk.models.numberreservations.NumberReservationRetrieveResponse;

NumberReservationRetrieveResponse numberReservation = client.numberReservations().retrieve("550e8400-e29b-41d4-a716-446655440000");

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

java

import com.telnyx.sdk.models.numberreservations.NumberReservationRetrieveParams;
import com.telnyx.sdk.models.numberreservations.NumberReservationRetrieveResponse;

NumberReservationRetrieveResponse numberReservation = client.numberReservations().retrieve("550e8400-e29b-41d4-a716-446655440000");

核心响应字段：

```
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

java

import com.telnyx.sdk.models.advancedorders.AdvancedOrderListParams;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderListResponse;

AdvancedOrderListResponse advancedOrders = client.advancedOrders().list();

Response wrapper:

items:
```
advancedOrders.data
```

Primary item fields:

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

在修改资源前查看可用资源或选择已有资源。

client.advancedOrders().list()

—

GET /advanced_orders

java

import com.telnyx.sdk.models.advancedorders.AdvancedOrderListParams;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderListResponse;

AdvancedOrderListResponse advancedOrders = client.advancedOrders().list();

响应包装结构：

数据项:
```
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

java

import com.telnyx.sdk.models.advancedorders.AdvancedOrder;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderCreateParams;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderCreateResponse;

AdvancedOrder params = AdvancedOrder.builder().build();
AdvancedOrderCreateResponse advancedOrder = client.advancedOrders().create(params);

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

java

import com.telnyx.sdk.models.advancedorders.AdvancedOrder;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderCreateParams;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderCreateResponse;

AdvancedOrder params = AdvancedOrder.builder().build();
AdvancedOrderCreateResponse advancedOrder = client.advancedOrders().create(params);

核心响应字段：

```
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

java

import com.telnyx.sdk.models.advancedorders.AdvancedOrder;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderUpdateRequirementGroupParams;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderUpdateRequirementGroupResponse;

AdvancedOrderUpdateRequirementGroupParams params = AdvancedOrderUpdateRequirementGroupParams.builder()
    .advancedOrderId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .advancedOrder(AdvancedOrder.builder().build())
    .build();
AdvancedOrderUpdateRequirementGroupResponse response = client.advancedOrders().updateRequirementGroup(params);

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

java

import com.telnyx.sdk.models.advancedorders.AdvancedOrder;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderUpdateRequirementGroupParams;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderUpdateRequirementGroupResponse;

AdvancedOrderUpdateRequirementGroupParams params = AdvancedOrderUpdateRequirementGroupParams.builder()
    .advancedOrderId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .advancedOrder(AdvancedOrder.builder().build())
    .build();
AdvancedOrderUpdateRequirementGroupResponse response = client.advancedOrders().updateRequirementGroup(params);

核心响应字段：

```
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

java

import com.telnyx.sdk.models.advancedorders.AdvancedOrderRetrieveParams;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderRetrieveResponse;

AdvancedOrderRetrieveResponse advancedOrder = client.advancedOrders().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

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)	是

java

import com.telnyx.sdk.models.advancedorders.AdvancedOrderRetrieveParams;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderRetrieveResponse;

AdvancedOrderRetrieveResponse advancedOrder = client.advancedOrders().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");

核心响应字段：

```
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).

java

import com.telnyx.sdk.models.availablephonenumberblocks.AvailablePhoneNumberBlockListParams;
import com.telnyx.sdk.models.availablephonenumberblocks.AvailablePhoneNumberBlockListResponse;

AvailablePhoneNumberBlockListResponse availablePhoneNumberBlocks = client.availablePhoneNumberBlocks().list();

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格式）

java

import com.telnyx.sdk.models.availablephonenumberblocks.AvailablePhoneNumberBlockListParams;
import com.telnyx.sdk.models.availablephonenumberblocks.AvailablePhoneNumberBlockListResponse;

AvailablePhoneNumberBlockListResponse availablePhoneNumberBlocks = client.availablePhoneNumberBlocks().list();

响应包装结构：

数据项:
```
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).

java

import com.telnyx.sdk.models.comments.CommentListParams;
import com.telnyx.sdk.models.comments.CommentListResponse;

CommentListResponse comments = client.comments().list();

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格式）

java

import com.telnyx.sdk.models.comments.CommentListParams;
import com.telnyx.sdk.models.comments.CommentListResponse;

CommentListResponse comments = client.comments().list();

响应包装结构：

数据项:
```
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方法和必填参数，完整可选参数、响应Schema和低频Webhook payload请参考references/api-details.md。使用以下任意操作前，请先阅读可选参数章节和响应Schema章节，请勿猜测缺失字段。

操作	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`	号码订单状态更新

如需完整的可选参数、全量响应Schema和完整Webhook payload，请查看references/api-details.md。