telnyx-numbers-compliance-java

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Telnyx Numbers Compliance - Java

Telnyx 号码合规 - 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.errors.TelnyxServiceException;

try {
    var result = client.messages().send(params);
} catch (TelnyxServiceException e) {
    System.err.println("API error " + e.statusCode() + ": " + e.getMessage());
    if (e.statusCode() == 422) {
        System.err.println("Validation error — check required fields and formats");
    } else if (e.statusCode() == 429) {
        // Rate limited — wait and retry with exponential backoff
        Thread.sleep(1000);
    }
}

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.errors.TelnyxServiceException;

try {
    var result = client.messages().send(params);
} catch (TelnyxServiceException e) {
    System.err.println("API error " + e.statusCode() + ": " + e.getMessage());
    if (e.statusCode() == 422) {
        System.err.println("Validation error — check required fields and formats");
    } else if (e.statusCode() == 429) {
        // Rate limited — wait and retry with exponential backoff
        Thread.sleep(1000);
    }
}

常见错误码：

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()
```
方法。

Retrieve Bundles

查询号码包列表

Get all allowed bundles.

GET /bundle_pricing/billing_bundles

java

import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleListPage;
import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleListParams;

BillingBundleListPage page = client.bundlePricing().billingBundles().list();

Returns:

cost_code

(string),

created_at

(date),

currency

(string),

id

(uuid),

is_public

(boolean),

mrc_price

(float),

name

(string),

slug

(string),

specs

(array[string])

获取所有可用的号码包。

GET /bundle_pricing/billing_bundles

java

import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleListPage;
import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleListParams;

BillingBundleListPage page = client.bundlePricing().billingBundles().list();

返回参数：

cost_code

(string),

created_at

(date),

currency

(string),

id

(uuid),

is_public

(boolean),

mrc_price

(float),

name

(string),

slug

(string),

specs

(array[string])

Get Bundle By Id

根据ID查询号码包

Get a single bundle by ID.

GET /bundle_pricing/billing_bundles/{bundle_id}

java

import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleRetrieveParams;
import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleRetrieveResponse;

BillingBundleRetrieveResponse billingBundle = client.bundlePricing().billingBundles().retrieve("8661948c-a386-4385-837f-af00f40f111a");

Returns:

active

(boolean),

bundle_limits

(array[object]),

cost_code

(string),

created_at

(date),

id

(uuid),

is_public

(boolean),

name

(string),

slug

(string)

通过ID获取单个号码包信息。

GET /bundle_pricing/billing_bundles/{bundle_id}

java

import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleRetrieveParams;
import com.telnyx.sdk.models.bundlepricing.billingbundles.BillingBundleRetrieveResponse;

BillingBundleRetrieveResponse billingBundle = client.bundlePricing().billingBundles().retrieve("8661948c-a386-4385-837f-af00f40f111a");

返回参数：

active

(boolean),

bundle_limits

(array[object]),

cost_code

(string),

created_at

(date),

id

(uuid),

is_public

(boolean),

name

(string),

slug

(string)

Get User Bundles

查询用户号码包列表

Get a paginated list of user bundles.

GET /bundle_pricing/user_bundles

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListPage;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListParams;

UserBundleListPage page = client.bundlePricing().userBundles().list();

Returns:

active

(boolean),

billing_bundle

(object),

created_at

(date),

id

(uuid),

resources

(array[object]),

updated_at

(date),

user_id

(uuid)

获取用户号码包的分页列表。

GET /bundle_pricing/user_bundles

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListPage;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListParams;

UserBundleListPage page = client.bundlePricing().userBundles().list();

返回参数：

active

(boolean),

billing_bundle

(object),

created_at

(date),

id

(uuid),

resources

(array[object]),

updated_at

(date),

user_id

(uuid)

Create User Bundles

批量创建用户号码包

Creates multiple user bundles for the user.

POST /bundle_pricing/user_bundles/bulk

Optional:

idempotency_key

(uuid),

items

(array[object])

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleCreateParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleCreateResponse;

UserBundleCreateResponse userBundle = client.bundlePricing().userBundles().create();

Returns:

active

(boolean),

billing_bundle

(object),

created_at

(date),

id

(uuid),

resources

(array[object]),

updated_at

(date),

user_id

(uuid)

为用户创建多个用户号码包。

POST /bundle_pricing/user_bundles/bulk

可选参数：

idempotency_key

(uuid),

items

(array[object])

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleCreateParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleCreateResponse;

UserBundleCreateResponse userBundle = client.bundlePricing().userBundles().create();

返回参数：

active

(boolean),

billing_bundle

(object),

created_at

(date),

id

(uuid),

resources

(array[object]),

updated_at

(date),

user_id

(uuid)

Get Unused User Bundles

查询未使用的用户号码包

Returns all user bundles that aren't in use.

GET /bundle_pricing/user_bundles/unused

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListUnusedParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListUnusedResponse;

UserBundleListUnusedResponse response = client.bundlePricing().userBundles().listUnused();

Returns:

billing_bundle

(object),

user_bundle_ids

(array[string])

返回所有未投入使用的用户号码包。

GET /bundle_pricing/user_bundles/unused

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListUnusedParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListUnusedResponse;

UserBundleListUnusedResponse response = client.bundlePricing().userBundles().listUnused();

返回参数：

billing_bundle

(object),

user_bundle_ids

(array[string])

Get User Bundle by Id

根据ID查询用户号码包

Retrieves a user bundle by its ID.

GET /bundle_pricing/user_bundles/{user_bundle_id}

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleRetrieveParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleRetrieveResponse;

UserBundleRetrieveResponse userBundle = client.bundlePricing().userBundles().retrieve("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");

Returns:

active

(boolean),

billing_bundle

(object),

created_at

(date),

id

(uuid),

resources

(array[object]),

updated_at

(date),

user_id

(uuid)

通过ID获取单个用户号码包的信息。

GET /bundle_pricing/user_bundles/{user_bundle_id}

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleRetrieveParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleRetrieveResponse;

UserBundleRetrieveResponse userBundle = client.bundlePricing().userBundles().retrieve("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");

返回参数：

active

(boolean),

billing_bundle

(object),

created_at

(date),

id

(uuid),

resources

(array[object]),

updated_at

(date),

user_id

(uuid)

Deactivate User Bundle

停用用户号码包

Deactivates a user bundle by its ID.

DELETE /bundle_pricing/user_bundles/{user_bundle_id}

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleDeactivateParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleDeactivateResponse;

UserBundleDeactivateResponse response = client.bundlePricing().userBundles().deactivate("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");

Returns:

active

(boolean),

billing_bundle

(object),

created_at

(date),

id

(uuid),

resources

(array[object]),

updated_at

(date),

user_id

(uuid)

通过ID停用指定用户号码包。

DELETE /bundle_pricing/user_bundles/{user_bundle_id}

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleDeactivateParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleDeactivateResponse;

UserBundleDeactivateResponse response = client.bundlePricing().userBundles().deactivate("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");

返回参数：

active

(boolean),

billing_bundle

(object),

created_at

(date),

id

(uuid),

resources

(array[object]),

updated_at

(date),

user_id

(uuid)

Get User Bundle Resources

查询用户号码包关联资源

Retrieves the resources of a user bundle by its ID.

GET /bundle_pricing/user_bundles/{user_bundle_id}/resources

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListResourcesParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListResourcesResponse;

UserBundleListResourcesResponse response = client.bundlePricing().userBundles().listResources("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");

Returns:

created_at

(date),

id

(uuid),

resource

(string),

resource_type

(string),

updated_at

(date)

通过ID获取指定用户号码包的关联资源。

GET /bundle_pricing/user_bundles/{user_bundle_id}/resources

java

import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListResourcesParams;
import com.telnyx.sdk.models.bundlepricing.userbundles.UserBundleListResourcesResponse;

UserBundleListResourcesResponse response = client.bundlePricing().userBundles().listResources("ca1d2263-d1f1-43ac-ba53-248e7a4bb26a");

返回参数：

created_at

(date),

id

(uuid),

resource

(string),

resource_type

(string),

updated_at

(date)

List all document links

查询所有文档关联记录

List all documents links ordered by created_at descending.

GET /document_links

java

import com.telnyx.sdk.models.documentlinks.DocumentLinkListPage;
import com.telnyx.sdk.models.documentlinks.DocumentLinkListParams;

DocumentLinkListPage page = client.documentLinks().list();

Returns:

created_at

(string),

document_id

(uuid),

id

(uuid),

linked_record_type

(string),

linked_resource_id

(string),

record_type

(string),

updated_at

(string)

按创建时间倒序排列所有文档关联记录。

GET /document_links

java

import com.telnyx.sdk.models.documentlinks.DocumentLinkListPage;
import com.telnyx.sdk.models.documentlinks.DocumentLinkListParams;

DocumentLinkListPage page = client.documentLinks().list();

返回参数：

created_at

(string),

document_id

(uuid),

id

(uuid),

linked_record_type

(string),

linked_resource_id

(string),

record_type

(string),

updated_at

(string)

List all documents

查询所有文档列表

List all documents ordered by created_at descending.

GET /documents

java

import com.telnyx.sdk.models.documents.DocumentListPage;
import com.telnyx.sdk.models.documents.DocumentListParams;

DocumentListPage page = client.documents().list();

Returns:

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

按创建时间倒序排列所有文档。

GET /documents

java

import com.telnyx.sdk.models.documents.DocumentListPage;
import com.telnyx.sdk.models.documents.DocumentListParams;

DocumentListPage page = client.documents().list();

返回参数：

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

Upload a document

上传文档

Upload a document. Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.

POST /documents

Optional:

customer_reference

(string),

file

(byte),

filename

(string),

url

(string)

java

import com.telnyx.sdk.models.documents.DocumentUploadJsonParams;
import com.telnyx.sdk.models.documents.DocumentUploadJsonResponse;

DocumentUploadJsonResponse response = client.documents().uploadJson();

Returns:

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

上传文档。上传的文件必须在30分钟内关联到对应服务，否则会被自动删除。

POST /documents

可选参数：

customer_reference

(string),

file

(byte),

filename

(string),

url

(string)

java

import com.telnyx.sdk.models.documents.DocumentUploadJsonParams;
import com.telnyx.sdk.models.documents.DocumentUploadJsonResponse;

DocumentUploadJsonResponse response = client.documents().uploadJson();

返回参数：

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

Retrieve a document

查询文档详情

Retrieve a document.

GET /documents/{id}

java

import com.telnyx.sdk.models.documents.DocumentRetrieveParams;
import com.telnyx.sdk.models.documents.DocumentRetrieveResponse;

DocumentRetrieveResponse document = client.documents().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns:

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

获取指定文档的详情。

GET /documents/{id}

java

import com.telnyx.sdk.models.documents.DocumentRetrieveParams;
import com.telnyx.sdk.models.documents.DocumentRetrieveResponse;

DocumentRetrieveResponse document = client.documents().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

返回参数：

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

Update a document

更新文档信息

Update a document.

PATCH /documents/{id}

Optional:

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

java

import com.telnyx.sdk.models.documents.DocServiceDocument;
import com.telnyx.sdk.models.documents.DocumentUpdateParams;
import com.telnyx.sdk.models.documents.DocumentUpdateResponse;

DocumentUpdateParams params = DocumentUpdateParams.builder()
    .documentId("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
    .docServiceDocument(DocServiceDocument.builder().build())
    .build();
DocumentUpdateResponse document = client.documents().update(params);

Returns:

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

更新指定文档的信息。

PATCH /documents/{id}

可选参数：

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

java

import com.telnyx.sdk.models.documents.DocServiceDocument;
import com.telnyx.sdk.models.documents.DocumentUpdateParams;
import com.telnyx.sdk.models.documents.DocumentUpdateResponse;

DocumentUpdateParams params = DocumentUpdateParams.builder()
    .documentId("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
    .docServiceDocument(DocServiceDocument.builder().build())
    .build();
DocumentUpdateResponse document = client.documents().update(params);

返回参数：

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

Delete a document

删除文档

Delete a document. A document can only be deleted if it's not linked to a service. If it is linked to a service, it must be unlinked prior to deleting.

DELETE /documents/{id}

java

import com.telnyx.sdk.models.documents.DocumentDeleteParams;
import com.telnyx.sdk.models.documents.DocumentDeleteResponse;

DocumentDeleteResponse document = client.documents().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Returns:

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

删除指定文档。仅未关联到任何服务的文档可被删除，如果文档已关联服务，需先解除关联再删除。

DELETE /documents/{id}

java

import com.telnyx.sdk.models.documents.DocumentDeleteParams;
import com.telnyx.sdk.models.documents.DocumentDeleteResponse;

DocumentDeleteResponse document = client.documents().delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

返回参数：

av_scan_status

(enum: scanned, infected, pending_scan, not_scanned),

content_type

(string),

created_at

(string),

customer_reference

(string),

filename

(string),

id

(uuid),

record_type

(string),

sha256

(string),

size

(object),

status

(enum: pending, verified, denied),

updated_at

(string)

Download a document

下载文档

Download a document.

GET /documents/{id}/download

java

import com.telnyx.sdk.core.http.HttpResponse;
import com.telnyx.sdk.models.documents.DocumentDownloadParams;

HttpResponse response = client.documents().download("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

下载指定文档。

GET /documents/{id}/download

java

import com.telnyx.sdk.core.http.HttpResponse;
import com.telnyx.sdk.models.documents.DocumentDownloadParams;

HttpResponse response = client.documents().download("6a09cdc3-8948-47f0-aa62-74ac943d6c58");

Generate a temporary download link for a document

生成文档临时下载链接

Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication.

GET /documents/{id}/download_link

java

import com.telnyx.sdk.models.documents.DocumentGenerateDownloadLinkParams;
import com.telnyx.sdk.models.documents.DocumentGenerateDownloadLinkResponse;

DocumentGenerateDownloadLinkResponse response = client.documents().generateDownloadLink("550e8400-e29b-41d4-a716-446655440000");

Returns:

url

(uri)

生成临时预签名URL，无需身份验证即可直接从存储后端下载文档。

GET /documents/{id}/download_link

java

import com.telnyx.sdk.models.documents.DocumentGenerateDownloadLinkParams;
import com.telnyx.sdk.models.documents.DocumentGenerateDownloadLinkResponse;

DocumentGenerateDownloadLinkResponse response = client.documents().generateDownloadLink("550e8400-e29b-41d4-a716-446655440000");

返回参数：

url

(uri)

Update requirement group for a phone number order

更新号码订单的要求组

POST /number_order_phone_numbers/{id}/requirement_group

— Required:

requirement_group_id

java

import com.telnyx.sdk.models.numberorderphonenumbers.NumberOrderPhoneNumberUpdateRequirementGroupParams;
import com.telnyx.sdk.models.numberorderphonenumbers.NumberOrderPhoneNumberUpdateRequirementGroupResponse;

NumberOrderPhoneNumberUpdateRequirementGroupParams params = NumberOrderPhoneNumberUpdateRequirementGroupParams.builder()
    .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .requirementGroupId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .build();
NumberOrderPhoneNumberUpdateRequirementGroupResponse response = client.numberOrderPhoneNumbers().updateRequirementGroup(params);

Returns:

bundle_id

(uuid),

country_code

(string),

deadline

(date-time),

id

(uuid),

is_block_number

(boolean),

locality

(string),

order_request_id

(uuid),

phone_number

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

requirements_met

(boolean),

requirements_status

(string),

status

(string),

sub_number_order_id

(uuid)

POST /number_order_phone_numbers/{id}/requirement_group

— 必填参数：

requirement_group_id

java

import com.telnyx.sdk.models.numberorderphonenumbers.NumberOrderPhoneNumberUpdateRequirementGroupParams;
import com.telnyx.sdk.models.numberorderphonenumbers.NumberOrderPhoneNumberUpdateRequirementGroupResponse;

NumberOrderPhoneNumberUpdateRequirementGroupParams params = NumberOrderPhoneNumberUpdateRequirementGroupParams.builder()
    .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .requirementGroupId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .build();
NumberOrderPhoneNumberUpdateRequirementGroupResponse response = client.numberOrderPhoneNumbers().updateRequirementGroup(params);

返回参数：

bundle_id

(uuid),

country_code

(string),

deadline

(date-time),

id

(uuid),

is_block_number

(boolean),

locality

(string),

order_request_id

(uuid),

phone_number

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

requirements_met

(boolean),

requirements_status

(string),

status

(string),

sub_number_order_id

(uuid)

Retrieve regulatory requirements for a list of phone numbers

批量查询电话号码的监管要求

GET /phone_numbers_regulatory_requirements

java

import com.telnyx.sdk.models.phonenumbersregulatoryrequirements.PhoneNumbersRegulatoryRequirementRetrieveParams;
import com.telnyx.sdk.models.phonenumbersregulatoryrequirements.PhoneNumbersRegulatoryRequirementRetrieveResponse;

PhoneNumbersRegulatoryRequirementRetrieveResponse phoneNumbersRegulatoryRequirement = client.phoneNumbersRegulatoryRequirements().retrieve();

Returns:

phone_number

(string),

phone_number_type

(string),

record_type

(string),

region_information

(array[object]),

regulatory_requirements

(array[object])

GET /phone_numbers_regulatory_requirements

java

import com.telnyx.sdk.models.phonenumbersregulatoryrequirements.PhoneNumbersRegulatoryRequirementRetrieveParams;
import com.telnyx.sdk.models.phonenumbersregulatoryrequirements.PhoneNumbersRegulatoryRequirementRetrieveResponse;

PhoneNumbersRegulatoryRequirementRetrieveResponse phoneNumbersRegulatoryRequirement = client.phoneNumbersRegulatoryRequirements().retrieve();

返回参数：

phone_number

(string),

phone_number_type

(string),

record_type

(string),

region_information

(array[object]),

regulatory_requirements

(array[object])

Retrieve regulatory requirements

查询监管要求

GET /regulatory_requirements

java

import com.telnyx.sdk.models.regulatoryrequirements.RegulatoryRequirementRetrieveParams;
import com.telnyx.sdk.models.regulatoryrequirements.RegulatoryRequirementRetrieveResponse;

RegulatoryRequirementRetrieveResponse regulatoryRequirement = client.regulatoryRequirements().retrieve();

Returns:

action

(string),

country_code

(string),

phone_number_type

(string),

regulatory_requirements

(array[object])

GET /regulatory_requirements

java

import com.telnyx.sdk.models.regulatoryrequirements.RegulatoryRequirementRetrieveParams;
import com.telnyx.sdk.models.regulatoryrequirements.RegulatoryRequirementRetrieveResponse;

RegulatoryRequirementRetrieveResponse regulatoryRequirement = client.regulatoryRequirements().retrieve();

返回参数：

action

(string),

country_code

(string),

phone_number_type

(string),

regulatory_requirements

(array[object])

List requirement groups

查询要求组列表

GET /requirement_groups

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupListParams;

List<RequirementGroup> requirementGroups = client.requirementGroups().list();

GET /requirement_groups

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupListParams;

List<RequirementGroup> requirementGroups = client.requirementGroups().list();

Create a new requirement group

创建新要求组

POST /requirement_groups

— Required:

country_code

phone_number_type

action

Optional:

customer_reference

(string),

regulatory_requirements

(array[object])

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupCreateParams;

RequirementGroupCreateParams params = RequirementGroupCreateParams.builder()
    .action(RequirementGroupCreateParams.Action.ORDERING)
    .countryCode("US")
    .phoneNumberType(RequirementGroupCreateParams.PhoneNumberType.LOCAL)
    .build();
RequirementGroup requirementGroup = client.requirementGroups().create(params);

Returns:

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

POST /requirement_groups

— 必填参数：

country_code

phone_number_type

action

可选参数：

customer_reference

(string),

regulatory_requirements

(array[object])

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupCreateParams;

RequirementGroupCreateParams params = RequirementGroupCreateParams.builder()
    .action(RequirementGroupCreateParams.Action.ORDERING)
    .countryCode("US")
    .phoneNumberType(RequirementGroupCreateParams.PhoneNumberType.LOCAL)
    .build();
RequirementGroup requirementGroup = client.requirementGroups().create(params);

返回参数：

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

Get a single requirement group by ID

根据ID查询要求组详情

GET /requirement_groups/{id}

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupRetrieveParams;

RequirementGroup requirementGroup = client.requirementGroups().retrieve("550e8400-e29b-41d4-a716-446655440000");

Returns:

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

GET /requirement_groups/{id}

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupRetrieveParams;

RequirementGroup requirementGroup = client.requirementGroups().retrieve("550e8400-e29b-41d4-a716-446655440000");

返回参数：

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

Update requirement values in requirement group

更新要求组中的要求值

PATCH /requirement_groups/{id}

Optional:

customer_reference

(string),

regulatory_requirements

(array[object])

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupUpdateParams;

RequirementGroup requirementGroup = client.requirementGroups().update("550e8400-e29b-41d4-a716-446655440000");

Returns:

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

PATCH /requirement_groups/{id}

可选参数：

customer_reference

(string),

regulatory_requirements

(array[object])

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupUpdateParams;

RequirementGroup requirementGroup = client.requirementGroups().update("550e8400-e29b-41d4-a716-446655440000");

返回参数：

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

Delete a requirement group by ID

根据ID删除要求组

DELETE /requirement_groups/{id}

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupDeleteParams;

RequirementGroup requirementGroup = client.requirementGroups().delete("550e8400-e29b-41d4-a716-446655440000");

Returns:

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

DELETE /requirement_groups/{id}

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupDeleteParams;

RequirementGroup requirementGroup = client.requirementGroups().delete("550e8400-e29b-41d4-a716-446655440000");

返回参数：

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

Submit a Requirement Group for Approval

提交要求组审核

POST /requirement_groups/{id}/submit_for_approval

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupSubmitForApprovalParams;

RequirementGroup requirementGroup = client.requirementGroups().submitForApproval("550e8400-e29b-41d4-a716-446655440000");

Returns:

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

POST /requirement_groups/{id}/submit_for_approval

java

import com.telnyx.sdk.models.requirementgroups.RequirementGroup;
import com.telnyx.sdk.models.requirementgroups.RequirementGroupSubmitForApprovalParams;

RequirementGroup requirementGroup = client.requirementGroups().submitForApproval("550e8400-e29b-41d4-a716-446655440000");

返回参数：

action

(string),

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(string),

phone_number_type

(string),

record_type

(string),

regulatory_requirements

(array[object]),

status

(enum: approved, unapproved, pending-approval, declined, expired),

updated_at

(date-time)

List all requirement types

查询所有要求类型

List all requirement types ordered by created_at descending

GET /requirement_types

java

import com.telnyx.sdk.models.requirementtypes.RequirementTypeListParams;
import com.telnyx.sdk.models.requirementtypes.RequirementTypeListResponse;

RequirementTypeListResponse requirementTypes = client.requirementTypes().list();

Returns:

acceptance_criteria

(object),

created_at

(string),

description

(string),

example

(string),

id

(uuid),

name

(string),

record_type

(string),

type

(enum: document, address, textual),

updated_at

(string)

按创建时间倒序排列所有要求类型

GET /requirement_types

java

import com.telnyx.sdk.models.requirementtypes.RequirementTypeListParams;
import com.telnyx.sdk.models.requirementtypes.RequirementTypeListResponse;

RequirementTypeListResponse requirementTypes = client.requirementTypes().list();

返回参数：

acceptance_criteria

(object),

created_at

(string),

description

(string),

example

(string),

id

(uuid),

name

(string),

record_type

(string),

type

(enum: document, address, textual),

updated_at

(string)

Retrieve a requirement types

根据ID查询要求类型

Retrieve a requirement type by id

GET /requirement_types/{id}

java

import com.telnyx.sdk.models.requirementtypes.RequirementTypeRetrieveParams;
import com.telnyx.sdk.models.requirementtypes.RequirementTypeRetrieveResponse;

RequirementTypeRetrieveResponse requirementType = client.requirementTypes().retrieve("a38c217a-8019-48f8-bff6-0fdd9939075b");

Returns:

acceptance_criteria

(object),

created_at

(string),

description

(string),

example

(string),

id

(uuid),

name

(string),

record_type

(string),

type

(enum: document, address, textual),

updated_at

(string)

通过ID获取指定要求类型的信息

GET /requirement_types/{id}

java

import com.telnyx.sdk.models.requirementtypes.RequirementTypeRetrieveParams;
import com.telnyx.sdk.models.requirementtypes.RequirementTypeRetrieveResponse;

RequirementTypeRetrieveResponse requirementType = client.requirementTypes().retrieve("a38c217a-8019-48f8-bff6-0fdd9939075b");

返回参数：

acceptance_criteria

(object),

created_at

(string),

description

(string),

example

(string),

id

(uuid),

name

(string),

record_type

(string),

type

(enum: document, address, textual),

updated_at

(string)

List all requirements

查询所有要求

List all requirements with filtering, sorting, and pagination

GET /requirements

java

import com.telnyx.sdk.models.requirements.RequirementListPage;
import com.telnyx.sdk.models.requirements.RequirementListParams;

RequirementListPage page = client.requirements().list();

Returns:

action

(enum: both, branded_calling, ordering, porting),

country_code

(string),

created_at

(string),

id

(uuid),

locality

(string),

phone_number_type

(enum: local, national, toll_free),

record_type

(string),

requirements_types

(array[object]),

updated_at

(string)

支持筛选、排序和分页

GET /requirements

java

import com.telnyx.sdk.models.requirements.RequirementListPage;
import com.telnyx.sdk.models.requirements.RequirementListParams;

RequirementListPage page = client.requirements().list();

返回参数：

action

(enum: both, branded_calling, ordering, porting),

country_code

(string),

created_at

(string),

id

(uuid),

locality

(string),

phone_number_type

(enum: local, national, toll_free),

record_type

(string),

requirements_types

(array[object]),

updated_at

(string)

Retrieve a document requirement

查询文档要求记录

Retrieve a document requirement record

GET /requirements/{id}

java

import com.telnyx.sdk.models.requirements.RequirementRetrieveParams;
import com.telnyx.sdk.models.requirements.RequirementRetrieveResponse;

RequirementRetrieveResponse requirement = client.requirements().retrieve("a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa");

Returns:

action

(enum: both, branded_calling, ordering, porting),

country_code

(string),

created_at

(string),

id

(uuid),

locality

(string),

phone_number_type

(enum: local, national, toll_free),

record_type

(string),

requirements_types

(array[object]),

updated_at

(string)

获取指定文档要求的记录

GET /requirements/{id}

java

import com.telnyx.sdk.models.requirements.RequirementRetrieveParams;
import com.telnyx.sdk.models.requirements.RequirementRetrieveResponse;

RequirementRetrieveResponse requirement = client.requirements().retrieve("a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa");

返回参数：

action

(enum: both, branded_calling, ordering, porting),

country_code

(string),

created_at

(string),

id

(uuid),

locality

(string),

phone_number_type

(enum: local, national, toll_free),

record_type

(string),

requirements_types

(array[object]),

updated_at

(string)

Update requirement group for a sub number order

更新子号码订单的要求组

POST /sub_number_orders/{id}/requirement_group

— Required:

requirement_group_id

java

import com.telnyx.sdk.models.subnumberorders.SubNumberOrderUpdateRequirementGroupParams;
import com.telnyx.sdk.models.subnumberorders.SubNumberOrderUpdateRequirementGroupResponse;

SubNumberOrderUpdateRequirementGroupParams params = SubNumberOrderUpdateRequirementGroupParams.builder()
    .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .requirementGroupId("a4b201f9-8646-4e54-a7d2-b2e403eeaf8c")
    .build();
SubNumberOrderUpdateRequirementGroupResponse response = client.subNumberOrders().updateRequirementGroup(params);

Returns:

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(uuid),

is_block_sub_number_order

(boolean),

order_request_id

(uuid),

phone_number_type

(string),

phone_numbers

(array[object]),

phone_numbers_count

(integer),

record_type

(string),

regulatory_requirements

(array[object]),

requirements_met

(boolean),

status

(string),

updated_at

(date-time)

POST /sub_number_orders/{id}/requirement_group

— 必填参数：

requirement_group_id

java

import com.telnyx.sdk.models.subnumberorders.SubNumberOrderUpdateRequirementGroupParams;
import com.telnyx.sdk.models.subnumberorders.SubNumberOrderUpdateRequirementGroupResponse;

SubNumberOrderUpdateRequirementGroupParams params = SubNumberOrderUpdateRequirementGroupParams.builder()
    .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .requirementGroupId("a4b201f9-8646-4e54-a7d2-b2e403eeaf8c")
    .build();
SubNumberOrderUpdateRequirementGroupResponse response = client.subNumberOrders().updateRequirementGroup(params);

返回参数：

country_code

(string),

created_at

(date-time),

customer_reference

(string),

id

(uuid),

is_block_sub_number_order

(boolean),

order_request_id

(uuid),

phone_number_type

(string),

phone_numbers

(array[object]),

phone_numbers_count

(integer),

record_type

(string),

regulatory_requirements

(array[object]),

requirements_met

(boolean),

status

(string),

updated_at

(date-time)

List all user addresses

查询所有用户地址

Returns a list of your user addresses.

GET /user_addresses

java

import com.telnyx.sdk.models.useraddresses.UserAddressListPage;
import com.telnyx.sdk.models.useraddresses.UserAddressListParams;

UserAddressListPage page = client.userAddresses().list();

Returns:

administrative_area

(string),

borough

(string),

business_name

(string),

country_code

(string),

created_at

(string),

customer_reference

(string),

extended_address

(string),

first_name

(string),

id

(uuid),

last_name

(string),

locality

(string),

neighborhood

(string),

phone_number

(string),

postal_code

(string),

record_type

(string),

street_address

(string),

updated_at

(string)

返回你的所有用户地址列表。

GET /user_addresses

java

import com.telnyx.sdk.models.useraddresses.UserAddressListPage;
import com.telnyx.sdk.models.useraddresses.UserAddressListParams;

UserAddressListPage page = client.userAddresses().list();

返回参数：

administrative_area

(string),

borough

(string),

business_name

(string),

country_code

(string),

created_at

(string),

customer_reference

(string),

extended_address

(string),

first_name

(string),

id

(uuid),

last_name

(string),

locality

(string),

neighborhood

(string),

phone_number

(string),

postal_code

(string),

record_type

(string),

street_address

(string),

updated_at

(string)

Creates a user address

创建用户地址

Creates a user address.

POST /user_addresses

— Required:

first_name

last_name

business_name

street_address

locality

country_code

Optional:

administrative_area

(string),

borough

(string),

customer_reference

(string),

extended_address

(string),

neighborhood

(string),

phone_number

(string),

postal_code

(string),

skip_address_verification

(boolean)

java

import com.telnyx.sdk.models.useraddresses.UserAddressCreateParams;
import com.telnyx.sdk.models.useraddresses.UserAddressCreateResponse;

UserAddressCreateParams params = UserAddressCreateParams.builder()
    .businessName("Toy-O'Kon")
    .countryCode("US")
    .firstName("Alfred")
    .lastName("Foster")
    .locality("Austin")
    .streetAddress("600 Congress Avenue")
    .build();
UserAddressCreateResponse userAddress = client.userAddresses().create(params);

Returns:

administrative_area

(string),

borough

(string),

business_name

(string),

country_code

(string),

created_at

(string),

customer_reference

(string),

extended_address

(string),

first_name

(string),

id

(uuid),

last_name

(string),

locality

(string),

neighborhood

(string),

phone_number

(string),

postal_code

(string),

record_type

(string),

street_address

(string),

updated_at

(string)

创建新的用户地址。

POST /user_addresses

— 必填参数：

first_name

last_name

business_name

street_address

locality

country_code

可选参数：

administrative_area

(string),

borough

(string),

customer_reference

(string),

extended_address

(string),

neighborhood

(string),

phone_number

(string),

postal_code

(string),

skip_address_verification

(boolean)

java

import com.telnyx.sdk.models.useraddresses.UserAddressCreateParams;
import com.telnyx.sdk.models.useraddresses.UserAddressCreateResponse;

UserAddressCreateParams params = UserAddressCreateParams.builder()
    .businessName("Toy-O'Kon")
    .countryCode("US")
    .firstName("Alfred")
    .lastName("Foster")
    .locality("Austin")
    .streetAddress("600 Congress Avenue")
    .build();
UserAddressCreateResponse userAddress = client.userAddresses().create(params);

返回参数：

administrative_area

(string),

borough

(string),

business_name

(string),

country_code

(string),

created_at

(string),

customer_reference

(string),

extended_address

(string),

first_name

(string),

id

(uuid),

last_name

(string),

locality

(string),

neighborhood

(string),

phone_number

(string),

postal_code

(string),

record_type

(string),

street_address

(string),

updated_at

(string)

Retrieve a user address

查询用户地址详情

Retrieves the details of an existing user address.

GET /user_addresses/{id}

java

import com.telnyx.sdk.models.useraddresses.UserAddressRetrieveParams;
import com.telnyx.sdk.models.useraddresses.UserAddressRetrieveResponse;

UserAddressRetrieveResponse userAddress = client.userAddresses().retrieve("550e8400-e29b-41d4-a716-446655440000");

Returns:

administrative_area

(string),

borough

(string),

business_name

(string),

country_code

(string),

created_at

(string),

customer_reference

(string),

extended_address

(string),

first_name

(string),

id

(uuid),

last_name

(string),

locality

(string),

neighborhood

(string),

phone_number

(string),

postal_code

(string),

record_type

(string),

street_address

(string),

updated_at

(string)

获取指定现有用户地址的详细信息。

GET /user_addresses/{id}

java

import com.telnyx.sdk.models.useraddresses.UserAddressRetrieveParams;
import com.telnyx.sdk.models.useraddresses.UserAddressRetrieveResponse;

UserAddressRetrieveResponse userAddress = client.userAddresses().retrieve("550e8400-e29b-41d4-a716-446655440000");

返回参数：

administrative_area

(string),

borough

(string),

business_name

(string),

country_code

(string),

created_at

(string),

customer_reference

(string),

extended_address

(string),

first_name

(string),

id

(uuid),

last_name

(string),

locality

(string),

neighborhood

(string),

phone_number

(string),

postal_code

(string),

record_type

(string),

street_address

(string),

updated_at

(string)

List all Verified Numbers

查询所有已验证号码

Gets a paginated list of Verified Numbers.

GET /verified_numbers

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberListPage;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberListParams;

VerifiedNumberListPage page = client.verifiedNumbers().list();

Returns:

phone_number

(string),

record_type

(enum: verified_number),

verified_at

(string)

获取已验证号码的分页列表。

GET /verified_numbers

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberListPage;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberListParams;

VerifiedNumberListPage page = client.verifiedNumbers().list();

返回参数：

phone_number

(string),

record_type

(enum: verified_number),

verified_at

(string)

Request phone number verification

发起电话号码验证

Initiates phone number verification procedure. Supports DTMF extension dialing for voice calls to numbers behind IVR systems.

POST /verified_numbers

— Required:

phone_number

verification_method

Optional:

extension

(string)

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateParams;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateResponse;

VerifiedNumberCreateParams params = VerifiedNumberCreateParams.builder()
    .phoneNumber("+15551234567")
    .verificationMethod(VerifiedNumberCreateParams.VerificationMethod.SMS)
    .build();
VerifiedNumberCreateResponse verifiedNumber = client.verifiedNumbers().create(params);

Returns:

phone_number

(string),

verification_method

(string)

启动电话号码验证流程，支持IVR系统后的语音呼叫DTMF分机拨号。

POST /verified_numbers

— 必填参数：

phone_number

verification_method

可选参数：

extension

(string)

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateParams;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberCreateResponse;

VerifiedNumberCreateParams params = VerifiedNumberCreateParams.builder()
    .phoneNumber("+15551234567")
    .verificationMethod(VerifiedNumberCreateParams.VerificationMethod.SMS)
    .build();
VerifiedNumberCreateResponse verifiedNumber = client.verifiedNumbers().create(params);

返回参数：

phone_number

(string),

verification_method

(string)

Retrieve a verified number

查询已验证号码详情

GET /verified_numbers/{phone_number}

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberRetrieveParams;

VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().retrieve("+15551234567");

Returns:

phone_number

(string),

record_type

(enum: verified_number),

verified_at

(string)

GET /verified_numbers/{phone_number}

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberRetrieveParams;

VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().retrieve("+15551234567");

返回参数：

phone_number

(string),

record_type

(enum: verified_number),

verified_at

(string)

Delete a verified number

删除已验证号码

DELETE /verified_numbers/{phone_number}

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDeleteParams;

VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().delete("+15551234567");

Returns:

phone_number

(string),

record_type

(enum: verified_number),

verified_at

(string)

DELETE /verified_numbers/{phone_number}

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDeleteParams;

VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().delete("+15551234567");

返回参数：

phone_number

(string),

record_type

(enum: verified_number),

verified_at

(string)

Submit verification code

提交验证码

POST /verified_numbers/{phone_number}/actions/verify

— Required:

verification_code

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.actions.ActionSubmitVerificationCodeParams;

ActionSubmitVerificationCodeParams params = ActionSubmitVerificationCodeParams.builder()
    .phoneNumber("+15551234567")
    .verificationCode("123456")
    .build();
VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().actions().submitVerificationCode(params);

Returns:

phone_number

(string),

record_type

(enum: verified_number),

verified_at

(string)

POST /verified_numbers/{phone_number}/actions/verify

— 必填参数：

verification_code

java

import com.telnyx.sdk.models.verifiednumbers.VerifiedNumberDataWrapper;
import com.telnyx.sdk.models.verifiednumbers.actions.ActionSubmitVerificationCodeParams;

ActionSubmitVerificationCodeParams params = ActionSubmitVerificationCodeParams.builder()
    .phoneNumber("+15551234567")
    .verificationCode("123456")
    .build();
VerifiedNumberDataWrapper verifiedNumberDataWrapper = client.verifiedNumbers().actions().submitVerificationCode(params);

返回参数：

phone_number

(string),

record_type

(enum: verified_number),

verified_at

(string)