Back to Details

telnyx-numbers-config-java

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

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

Telnyx Numbers Config - 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: 
401
invalid API key, 
403
insufficient permissions, 
404
resource not found, 
422
validation error (check field formats), 
429
rate limited (retry with exponential backoff).
所有API调用都可能因网络错误、速率限制(429)、验证错误(422)或身份验证错误(401)而失败。在生产代码中请务必做好错误处理：
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);
    }
}
常见错误码：
401
API密钥无效，
403
权限不足，
404
资源不存在，
422
验证错误（请检查字段格式），
429
触发速率限制（请使用指数退避策略重试）。

Important Notes

重要注意事项

  • Phone numbers must be in E.164 format (e.g., 
    +13125550001
    ). Include the 
    +
    prefix and country code. No spaces, dashes, or parentheses.
  • Pagination: List methods return 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()
    方法。

Bulk update phone number profiles

批量更新电话号码配置文件

POST /messaging_numbers_bulk_updates
— Required: 
messaging_profile_id
, 
numbers
Optional: 
assign_only
(boolean)
java
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateCreateParams;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateCreateResponse;
import java.util.List;

MessagingNumbersBulkUpdateCreateParams params = MessagingNumbersBulkUpdateCreateParams.builder()
    .messagingProfileId("00000000-0000-0000-0000-000000000000")
    .numbers(List.of(
      "+18880000000",
      "+18880000001",
      "+18880000002"
    ))
    .build();
MessagingNumbersBulkUpdateCreateResponse messagingNumbersBulkUpdate = client.messagingNumbersBulkUpdates().create(params);
Returns: 
failed
(array[string]), 
order_id
(uuid), 
pending
(array[string]), 
record_type
(enum: messaging_numbers_bulk_update), 
success
(array[string])
POST /messaging_numbers_bulk_updates
— 必填参数：
messaging_profile_id
、
numbers
可选参数：
assign_only
（布尔值）
java
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateCreateParams;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateCreateResponse;
import java.util.List;

MessagingNumbersBulkUpdateCreateParams params = MessagingNumbersBulkUpdateCreateParams.builder()
    .messagingProfileId("00000000-0000-0000-0000-000000000000")
    .numbers(List.of(
      "+18880000000",
      "+18880000001",
      "+18880000002"
    ))
    .build();
MessagingNumbersBulkUpdateCreateResponse messagingNumbersBulkUpdate = client.messagingNumbersBulkUpdates().create(params);
返回值：
failed
（字符串数组）、
order_id
（uuid）、
pending
（字符串数组）、
record_type
（枚举值：messaging_numbers_bulk_update）、
success
（字符串数组）

Retrieve bulk update status

查询批量更新状态

GET /messaging_numbers_bulk_updates/{order_id}
java
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateRetrieveParams;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateRetrieveResponse;

MessagingNumbersBulkUpdateRetrieveResponse messagingNumbersBulkUpdate = client.messagingNumbersBulkUpdates().retrieve("550e8400-e29b-41d4-a716-446655440000");
Returns: 
failed
(array[string]), 
order_id
(uuid), 
pending
(array[string]), 
record_type
(enum: messaging_numbers_bulk_update), 
success
(array[string])
GET /messaging_numbers_bulk_updates/{order_id}
java
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateRetrieveParams;
import com.telnyx.sdk.models.messagingnumbersbulkupdates.MessagingNumbersBulkUpdateRetrieveResponse;

MessagingNumbersBulkUpdateRetrieveResponse messagingNumbersBulkUpdate = client.messagingNumbersBulkUpdates().retrieve("550e8400-e29b-41d4-a716-446655440000");
返回值：
failed
（字符串数组）、
order_id
（uuid）、
pending
（字符串数组）、
record_type
（枚举值：messaging_numbers_bulk_update）、
success
（字符串数组）

List mobile phone numbers with messaging settings

列出带消息配置的移动电话号码

GET /mobile_phone_numbers/messaging
java
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingListPage;
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingListParams;

MessagingListPage page = client.mobilePhoneNumbers().messaging().list();
Returns: 
country_code
(string), 
created_at
(date-time), 
features
(object), 
id
(string), 
messaging_product
(string), 
messaging_profile_id
(string | null), 
organization_id
(string), 
phone_number
(string), 
record_type
(enum: messaging_phone_number, messaging_settings), 
tags
(array[string]), 
traffic_type
(string), 
type
(enum: longcode), 
updated_at
(date-time)
GET /mobile_phone_numbers/messaging
java
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingListPage;
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingListParams;

MessagingListPage page = client.mobilePhoneNumbers().messaging().list();
返回值：
country_code
（字符串）、
created_at
（日期时间）、
features
（对象）、
id
（字符串）、
messaging_product
（字符串）、
messaging_profile_id
（字符串 | 空）、
organization_id
（字符串）、
phone_number
（字符串）、
record_type
（枚举值：messaging_phone_number、messaging_settings）、
tags
（字符串数组）、
traffic_type
（字符串）、
type
（枚举值：longcode）、
updated_at
（日期时间）

Retrieve a mobile phone number with messaging settings

查询单个带消息配置的移动电话号码

GET /mobile_phone_numbers/{id}/messaging
java
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingRetrieveParams;
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingRetrieveResponse;

MessagingRetrieveResponse messaging = client.mobilePhoneNumbers().messaging().retrieve("550e8400-e29b-41d4-a716-446655440000");
Returns: 
country_code
(string), 
created_at
(date-time), 
features
(object), 
id
(string), 
messaging_product
(string), 
messaging_profile_id
(string | null), 
organization_id
(string), 
phone_number
(string), 
record_type
(enum: messaging_phone_number, messaging_settings), 
tags
(array[string]), 
traffic_type
(string), 
type
(enum: longcode), 
updated_at
(date-time)
GET /mobile_phone_numbers/{id}/messaging
java
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingRetrieveParams;
import com.telnyx.sdk.models.mobilephonenumbers.messaging.MessagingRetrieveResponse;

MessagingRetrieveResponse messaging = client.mobilePhoneNumbers().messaging().retrieve("550e8400-e29b-41d4-a716-446655440000");
返回值：
country_code
（字符串）、
created_at
（日期时间）、
features
（对象）、
id
（字符串）、
messaging_product
（字符串）、
messaging_profile_id
（字符串 | 空）、
organization_id
（字符串）、
phone_number
（字符串）、
record_type
（枚举值：messaging_phone_number、messaging_settings）、
tags
（字符串数组）、
traffic_type
（字符串）、
type
（枚举值：longcode）、
updated_at
（日期时间）

List phone numbers

列出电话号码

GET /phone_numbers
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberListPage;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberListParams;

PhoneNumberListPage page = client.phoneNumbers().list();
Returns: 
billing_group_id
(string | null), 
call_forwarding_enabled
(boolean), 
call_recording_enabled
(boolean), 
caller_id_name_enabled
(boolean), 
cnam_listing_enabled
(boolean), 
connection_id
(string | null), 
connection_name
(string | null), 
country_iso_alpha2
(string), 
created_at
(date-time), 
customer_reference
(string | null), 
deletion_lock_enabled
(boolean), 
emergency_address_id
(string | null), 
emergency_enabled
(boolean), 
emergency_status
(enum: active, deprovisioning, disabled, provisioning, provisioning-failed), 
external_pin
(string | null), 
hd_voice_enabled
(boolean), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
messaging_profile_id
(string | null), 
messaging_profile_name
(string | null), 
phone_number
(string), 
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode), 
purchased_at
(string), 
record_type
(string), 
source_type
(object), 
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), 
t38_fax_gateway_enabled
(boolean), 
tags
(array[string]), 
updated_at
(string)
GET /phone_numbers
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberListPage;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberListParams;

PhoneNumberListPage page = client.phoneNumbers().list();
返回值：
billing_group_id
（字符串 | 空）、
call_forwarding_enabled
（布尔值）、
call_recording_enabled
（布尔值）、
caller_id_name_enabled
（布尔值）、
cnam_listing_enabled
（布尔值）、
connection_id
（字符串 | 空）、
connection_name
（字符串 | 空）、
country_iso_alpha2
（字符串）、
created_at
（日期时间）、
customer_reference
（字符串 | 空）、
deletion_lock_enabled
（布尔值）、
emergency_address_id
（字符串 | 空）、
emergency_enabled
（布尔值）、
emergency_status
（枚举值：active、deprovisioning、disabled、provisioning、provisioning-failed）、
external_pin
（字符串 | 空）、
hd_voice_enabled
（布尔值）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
messaging_profile_id
（字符串 | 空）、
messaging_profile_name
（字符串 | 空）、
phone_number
（字符串）、
phone_number_type
（枚举值：local、toll_free、mobile、national、shared_cost、landline、tollfree、shortcode、longcode）、
purchased_at
（字符串）、
record_type
（字符串）、
source_type
（对象）、
status
（枚举值：purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending、requirement-info-pending、requirement-info-under-review、requirement-info-exception、provision-pending）、
t38_fax_gateway_enabled
（布尔值）、
tags
（字符串数组）、
updated_at
（字符串）

Verify ownership of phone numbers

验证电话号码所有权

Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account.
POST /phone_numbers/actions/verify_ownership
— Required: 
phone_numbers
java
import com.telnyx.sdk.models.phonenumbers.actions.ActionVerifyOwnershipParams;
import com.telnyx.sdk.models.phonenumbers.actions.ActionVerifyOwnershipResponse;

ActionVerifyOwnershipParams params = ActionVerifyOwnershipParams.builder()
    .addPhoneNumber("+15551234567")
    .build();
ActionVerifyOwnershipResponse response = client.phoneNumbers().actions().verifyOwnership(params);
Returns: 
found
(array[object]), 
not_found
(array[string]), 
record_type
(string)
验证提供的电话号码的所有权，返回号码与其ID的映射，以及账户中不存在的号码列表。
POST /phone_numbers/actions/verify_ownership
— 必填参数：
phone_numbers
java
import com.telnyx.sdk.models.phonenumbers.actions.ActionVerifyOwnershipParams;
import com.telnyx.sdk.models.phonenumbers.actions.ActionVerifyOwnershipResponse;

ActionVerifyOwnershipParams params = ActionVerifyOwnershipParams.builder()
    .addPhoneNumber("+15551234567")
    .build();
ActionVerifyOwnershipResponse response = client.phoneNumbers().actions().verifyOwnership(params);
返回值：
found
（对象数组）、
not_found
（字符串数组）、
record_type
（字符串）

Lists the phone numbers jobs

列出电话号码任务

GET /phone_numbers/jobs
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobListPage;
import com.telnyx.sdk.models.phonenumbers.jobs.JobListParams;

JobListPage page = client.phoneNumbers().jobs().list();
Returns: 
created_at
(string), 
etc
(date-time), 
failed_operations
(array[object]), 
id
(uuid), 
pending_operations
(array[object]), 
phone_numbers
(array[object]), 
record_type
(string), 
status
(enum: pending, in_progress, completed, failed, expired), 
successful_operations
(array[object]), 
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers), 
updated_at
(string)
GET /phone_numbers/jobs
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobListPage;
import com.telnyx.sdk.models.phonenumbers.jobs.JobListParams;

JobListPage page = client.phoneNumbers().jobs().list();
返回值：
created_at
（字符串）、
etc
（日期时间）、
failed_operations
（对象数组）、
id
（uuid）、
pending_operations
（对象数组）、
phone_numbers
（对象数组）、
record_type
（字符串）、
status
（枚举值：pending、in_progress、completed、failed、expired）、
successful_operations
（对象数组）、
type
（枚举值：update_emergency_settings、delete_phone_numbers、update_phone_numbers）、
updated_at
（字符串）

Delete a batch of numbers

批量删除号码

Creates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call.
POST /phone_numbers/jobs/delete_phone_numbers
— Required: 
phone_numbers
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobDeleteBatchParams;
import com.telnyx.sdk.models.phonenumbers.jobs.JobDeleteBatchResponse;
import java.util.List;

JobDeleteBatchParams params = JobDeleteBatchParams.builder()
    .phoneNumbers(List.of(
      "+19705555098",
      "+19715555098",
      "32873127836"
    ))
    .build();
JobDeleteBatchResponse response = client.phoneNumbers().jobs().deleteBatch(params);
Returns: 
created_at
(string), 
etc
(date-time), 
failed_operations
(array[object]), 
id
(uuid), 
pending_operations
(array[object]), 
phone_numbers
(array[object]), 
record_type
(string), 
status
(enum: pending, in_progress, completed, failed, expired), 
successful_operations
(array[object]), 
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers), 
updated_at
(string)
创建一个新的后台任务来批量删除号码，每次API调用最多可更新1000个号码。
POST /phone_numbers/jobs/delete_phone_numbers
— 必填参数：
phone_numbers
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobDeleteBatchParams;
import com.telnyx.sdk.models.phonenumbers.jobs.JobDeleteBatchResponse;
import java.util.List;

JobDeleteBatchParams params = JobDeleteBatchParams.builder()
    .phoneNumbers(List.of(
      "+19705555098",
      "+19715555098",
      "32873127836"
    ))
    .build();
JobDeleteBatchResponse response = client.phoneNumbers().jobs().deleteBatch(params);
返回值：
created_at
（字符串）、
etc
（日期时间）、
failed_operations
（对象数组）、
id
（uuid）、
pending_operations
（对象数组）、
phone_numbers
（对象数组）、
record_type
（字符串）、
status
（枚举值：pending、in_progress、completed、failed、expired）、
successful_operations
（对象数组）、
type
（枚举值：update_emergency_settings、delete_phone_numbers、update_phone_numbers）、
updated_at
（字符串）

Update the emergency settings from a batch of numbers

批量更新号码的紧急设置

Creates a background job to update the emergency settings of a collection of phone numbers. At most one thousand numbers can be updated per API call.
POST /phone_numbers/jobs/update_emergency_settings
— Required: 
emergency_enabled
, 
phone_numbers
Optional: 
emergency_address_id
(string | null)
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateEmergencySettingsBatchParams;
import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateEmergencySettingsBatchResponse;
import java.util.List;

JobUpdateEmergencySettingsBatchParams params = JobUpdateEmergencySettingsBatchParams.builder()
    .emergencyEnabled(true)
    .phoneNumbers(List.of(
      "+19705555098",
      "+19715555098",
      "32873127836"
    ))
    .build();
JobUpdateEmergencySettingsBatchResponse response = client.phoneNumbers().jobs().updateEmergencySettingsBatch(params);
Returns: 
created_at
(string), 
etc
(date-time), 
failed_operations
(array[object]), 
id
(uuid), 
pending_operations
(array[object]), 
phone_numbers
(array[object]), 
record_type
(string), 
status
(enum: pending, in_progress, completed, failed, expired), 
successful_operations
(array[object]), 
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers), 
updated_at
(string)
创建一个后台任务来批量更新一组电话号码的紧急设置，每次API调用最多可更新1000个号码。
POST /phone_numbers/jobs/update_emergency_settings
— 必填参数：
emergency_enabled
、
phone_numbers
可选参数：
emergency_address_id
（字符串 | 空）
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateEmergencySettingsBatchParams;
import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateEmergencySettingsBatchResponse;
import java.util.List;

JobUpdateEmergencySettingsBatchParams params = JobUpdateEmergencySettingsBatchParams.builder()
    .emergencyEnabled(true)
    .phoneNumbers(List.of(
      "+19705555098",
      "+19715555098",
      "32873127836"
    ))
    .build();
JobUpdateEmergencySettingsBatchResponse response = client.phoneNumbers().jobs().updateEmergencySettingsBatch(params);
返回值：
created_at
（字符串）、
etc
（日期时间）、
failed_operations
（对象数组）、
id
（uuid）、
pending_operations
（对象数组）、
phone_numbers
（对象数组）、
record_type
（字符串）、
status
（枚举值：pending、in_progress、completed、failed、expired）、
successful_operations
（对象数组）、
type
（枚举值：update_emergency_settings、delete_phone_numbers、update_phone_numbers）、
updated_at
（字符串）

Update a batch of numbers

批量更新号码

Creates a new background job to update a batch of numbers. At most one thousand numbers can be updated per API call. At least one of the updateable fields must be submitted.
POST /phone_numbers/jobs/update_phone_numbers
— Required: 
phone_numbers
Optional: 
billing_group_id
(string), 
connection_id
(string), 
customer_reference
(string), 
deletion_lock_enabled
(boolean), 
external_pin
(string), 
hd_voice_enabled
(boolean), 
tags
(array[string]), 
voice
(object)
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateBatchParams;
import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateBatchResponse;

JobUpdateBatchParams params = JobUpdateBatchParams.builder()
    .addPhoneNumber("1583466971586889004")
    .addPhoneNumber("+13127367254")
    .build();
JobUpdateBatchResponse response = client.phoneNumbers().jobs().updateBatch(params);
Returns: 
created_at
(string), 
etc
(date-time), 
failed_operations
(array[object]), 
id
(uuid), 
pending_operations
(array[object]), 
phone_numbers
(array[object]), 
record_type
(string), 
status
(enum: pending, in_progress, completed, failed, expired), 
successful_operations
(array[object]), 
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers), 
updated_at
(string)
创建一个新的后台任务来批量更新号码，每次API调用最多可更新1000个号码，必须至少提交一个可更新字段。
POST /phone_numbers/jobs/update_phone_numbers
— 必填参数：
phone_numbers
可选参数：
billing_group_id
（字符串）、
connection_id
（字符串）、
customer_reference
（字符串）、
deletion_lock_enabled
（布尔值）、
external_pin
（字符串）、
hd_voice_enabled
（布尔值）、
tags
（字符串数组）、
voice
（对象）
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateBatchParams;
import com.telnyx.sdk.models.phonenumbers.jobs.JobUpdateBatchResponse;

JobUpdateBatchParams params = JobUpdateBatchParams.builder()
    .addPhoneNumber("1583466971586889004")
    .addPhoneNumber("+13127367254")
    .build();
JobUpdateBatchResponse response = client.phoneNumbers().jobs().updateBatch(params);
返回值：
created_at
（字符串）、
etc
（日期时间）、
failed_operations
（对象数组）、
id
（uuid）、
pending_operations
（对象数组）、
phone_numbers
（对象数组）、
record_type
（字符串）、
status
（枚举值：pending、in_progress、completed、failed、expired）、
successful_operations
（对象数组）、
type
（枚举值：update_emergency_settings、delete_phone_numbers、update_phone_numbers）、
updated_at
（字符串）

Retrieve a phone numbers job

查询电话号码任务

GET /phone_numbers/jobs/{id}
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.jobs.JobRetrieveResponse;

JobRetrieveResponse job = client.phoneNumbers().jobs().retrieve("550e8400-e29b-41d4-a716-446655440000");
Returns: 
created_at
(string), 
etc
(date-time), 
failed_operations
(array[object]), 
id
(uuid), 
pending_operations
(array[object]), 
phone_numbers
(array[object]), 
record_type
(string), 
status
(enum: pending, in_progress, completed, failed, expired), 
successful_operations
(array[object]), 
type
(enum: update_emergency_settings, delete_phone_numbers, update_phone_numbers), 
updated_at
(string)
GET /phone_numbers/jobs/{id}
java
import com.telnyx.sdk.models.phonenumbers.jobs.JobRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.jobs.JobRetrieveResponse;

JobRetrieveResponse job = client.phoneNumbers().jobs().retrieve("550e8400-e29b-41d4-a716-446655440000");
返回值：
created_at
（字符串）、
etc
（日期时间）、
failed_operations
（对象数组）、
id
（uuid）、
pending_operations
（对象数组）、
phone_numbers
（对象数组）、
record_type
（字符串）、
status
（枚举值：pending、in_progress、completed、failed、expired）、
successful_operations
（对象数组）、
type
（枚举值：update_emergency_settings、delete_phone_numbers、update_phone_numbers）、
updated_at
（字符串）

List phone numbers with messaging settings

列出带消息配置的电话号码

GET /phone_numbers/messaging
java
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingListPage;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingListParams;

MessagingListPage page = client.phoneNumbers().messaging().list();
Returns: 
country_code
(string), 
created_at
(date-time), 
eligible_messaging_products
(array[string]), 
features
(object), 
health
(object), 
id
(string), 
messaging_product
(string), 
messaging_profile_id
(string | null), 
organization_id
(string), 
phone_number
(string), 
record_type
(enum: messaging_phone_number, messaging_settings), 
tags
(array[string]), 
traffic_type
(string), 
type
(enum: long-code, toll-free, short-code, longcode, tollfree, shortcode), 
updated_at
(date-time)
GET /phone_numbers/messaging
java
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingListPage;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingListParams;

MessagingListPage page = client.phoneNumbers().messaging().list();
返回值：
country_code
（字符串）、
created_at
（日期时间）、
eligible_messaging_products
（字符串数组）、
features
（对象）、
health
（对象）、
id
（字符串）、
messaging_product
（字符串）、
messaging_profile_id
（字符串 | 空）、
organization_id
（字符串）、
phone_number
（字符串）、
record_type
（枚举值：messaging_phone_number、messaging_settings）、
tags
（字符串数组）、
traffic_type
（字符串）、
type
（枚举值：long-code、toll-free、short-code、longcode、tollfree、shortcode）、
updated_at
（日期时间）

Slim List phone numbers

精简版电话号码列表

List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.
GET /phone_numbers/slim
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberSlimListPage;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberSlimListParams;

PhoneNumberSlimListPage page = client.phoneNumbers().slimList();
Returns: 
billing_group_id
(string), 
call_forwarding_enabled
(boolean), 
call_recording_enabled
(boolean), 
caller_id_name_enabled
(boolean), 
cnam_listing_enabled
(boolean), 
connection_id
(string), 
country_iso_alpha2
(string), 
created_at
(string), 
customer_reference
(string), 
emergency_address_id
(string), 
emergency_enabled
(boolean), 
emergency_status
(enum: active, deprovisioning, disabled, provisioning, provisioning-failed), 
external_pin
(string), 
hd_voice_enabled
(boolean), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
phone_number
(string), 
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode), 
purchased_at
(string), 
record_type
(string), 
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), 
t38_fax_gateway_enabled
(boolean), 
updated_at
(string)
列出电话号码，该接口是
/phone_numbers
接口的轻量版本，性能更高、速率限制更宽松。
GET /phone_numbers/slim
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberSlimListPage;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberSlimListParams;

PhoneNumberSlimListPage page = client.phoneNumbers().slimList();
返回值：
billing_group_id
（字符串）、
call_forwarding_enabled
（布尔值）、
call_recording_enabled
（布尔值）、
caller_id_name_enabled
（布尔值）、
cnam_listing_enabled
（布尔值）、
connection_id
（字符串）、
country_iso_alpha2
（字符串）、
created_at
（字符串）、
customer_reference
（字符串）、
emergency_address_id
（字符串）、
emergency_enabled
（布尔值）、
emergency_status
（枚举值：active、deprovisioning、disabled、provisioning、provisioning-failed）、
external_pin
（字符串）、
hd_voice_enabled
（布尔值）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
phone_number
（字符串）、
phone_number_type
（枚举值：local、toll_free、mobile、national、shared_cost、landline、tollfree、shortcode、longcode）、
purchased_at
（字符串）、
record_type
（字符串）、
status
（枚举值：purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending、requirement-info-pending、requirement-info-under-review、requirement-info-exception、provision-pending）、
t38_fax_gateway_enabled
（布尔值）、
updated_at
（字符串）

List phone numbers with voice settings

列出带语音配置的电话号码

GET /phone_numbers/voice
java
import com.telnyx.sdk.models.phonenumbers.voice.VoiceListPage;
import com.telnyx.sdk.models.phonenumbers.voice.VoiceListParams;

VoiceListPage page = client.phoneNumbers().voice().list();
Returns: 
call_forwarding
(object), 
call_recording
(object), 
cnam_listing
(object), 
connection_id
(string), 
customer_reference
(string), 
emergency
(object), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
media_features
(object), 
phone_number
(string), 
record_type
(string), 
tech_prefix_enabled
(boolean), 
translated_number
(string), 
usage_payment_method
(enum: pay-per-minute, channel)
GET /phone_numbers/voice
java
import com.telnyx.sdk.models.phonenumbers.voice.VoiceListPage;
import com.telnyx.sdk.models.phonenumbers.voice.VoiceListParams;

VoiceListPage page = client.phoneNumbers().voice().list();
返回值：
call_forwarding
（对象）、
call_recording
（对象）、
cnam_listing
（对象）、
connection_id
（字符串）、
customer_reference
（字符串）、
emergency
（对象）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
media_features
（对象）、
phone_number
（字符串）、
record_type
（字符串）、
tech_prefix_enabled
（布尔值）、
translated_number
（字符串）、
usage_payment_method
（枚举值：pay-per-minute、channel）

Retrieve a phone number

查询单个电话号码

GET /phone_numbers/{id}
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberRetrieveResponse;

PhoneNumberRetrieveResponse phoneNumber = client.phoneNumbers().retrieve("1293384261075731499");
Returns: 
billing_group_id
(string | null), 
call_forwarding_enabled
(boolean), 
call_recording_enabled
(boolean), 
caller_id_name_enabled
(boolean), 
cnam_listing_enabled
(boolean), 
connection_id
(string | null), 
connection_name
(string | null), 
country_iso_alpha2
(string), 
created_at
(date-time), 
customer_reference
(string | null), 
deletion_lock_enabled
(boolean), 
emergency_address_id
(string | null), 
emergency_enabled
(boolean), 
emergency_status
(enum: active, deprovisioning, disabled, provisioning, provisioning-failed), 
external_pin
(string | null), 
hd_voice_enabled
(boolean), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
messaging_profile_id
(string | null), 
messaging_profile_name
(string | null), 
phone_number
(string), 
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode), 
purchased_at
(string), 
record_type
(string), 
source_type
(object), 
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), 
t38_fax_gateway_enabled
(boolean), 
tags
(array[string]), 
updated_at
(string)
GET /phone_numbers/{id}
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberRetrieveResponse;

PhoneNumberRetrieveResponse phoneNumber = client.phoneNumbers().retrieve("1293384261075731499");
返回值：
billing_group_id
（字符串 | 空）、
call_forwarding_enabled
（布尔值）、
call_recording_enabled
（布尔值）、
caller_id_name_enabled
（布尔值）、
cnam_listing_enabled
（布尔值）、
connection_id
（字符串 | 空）、
connection_name
（字符串 | 空）、
country_iso_alpha2
（字符串）、
created_at
（日期时间）、
customer_reference
（字符串 | 空）、
deletion_lock_enabled
（布尔值）、
emergency_address_id
（字符串 | 空）、
emergency_enabled
（布尔值）、
emergency_status
（枚举值：active、deprovisioning、disabled、provisioning、provisioning-failed）、
external_pin
（字符串 | 空）、
hd_voice_enabled
（布尔值）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
messaging_profile_id
（字符串 | 空）、
messaging_profile_name
（字符串 | 空）、
phone_number
（字符串）、
phone_number_type
（枚举值：local、toll_free、mobile、national、shared_cost、landline、tollfree、shortcode、longcode）、
purchased_at
（字符串）、
record_type
（字符串）、
source_type
（对象）、
status
（枚举值：purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending、requirement-info-pending、requirement-info-under-review、requirement-info-exception、provision-pending）、
t38_fax_gateway_enabled
（布尔值）、
tags
（字符串数组）、
updated_at
（字符串）

Update a phone number

更新单个电话号码

PATCH /phone_numbers/{id}
Optional: 
address_id
(string), 
billing_group_id
(string), 
connection_id
(string), 
customer_reference
(string), 
external_pin
(string), 
hd_voice_enabled
(boolean), 
id
(string), 
tags
(array[string])
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberUpdateParams;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberUpdateResponse;

PhoneNumberUpdateResponse phoneNumber = client.phoneNumbers().update("1293384261075731499");
Returns: 
billing_group_id
(string | null), 
call_forwarding_enabled
(boolean), 
call_recording_enabled
(boolean), 
caller_id_name_enabled
(boolean), 
cnam_listing_enabled
(boolean), 
connection_id
(string | null), 
connection_name
(string | null), 
country_iso_alpha2
(string), 
created_at
(date-time), 
customer_reference
(string | null), 
deletion_lock_enabled
(boolean), 
emergency_address_id
(string | null), 
emergency_enabled
(boolean), 
emergency_status
(enum: active, deprovisioning, disabled, provisioning, provisioning-failed), 
external_pin
(string | null), 
hd_voice_enabled
(boolean), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
messaging_profile_id
(string | null), 
messaging_profile_name
(string | null), 
phone_number
(string), 
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode), 
purchased_at
(string), 
record_type
(string), 
source_type
(object), 
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), 
t38_fax_gateway_enabled
(boolean), 
tags
(array[string]), 
updated_at
(string)
PATCH /phone_numbers/{id}
可选参数：
address_id
（字符串）、
billing_group_id
（字符串）、
connection_id
（字符串）、
customer_reference
（字符串）、
external_pin
（字符串）、
hd_voice_enabled
（布尔值）、
id
（字符串）、
tags
（字符串数组）
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberUpdateParams;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberUpdateResponse;

PhoneNumberUpdateResponse phoneNumber = client.phoneNumbers().update("1293384261075731499");
返回值：
billing_group_id
（字符串 | 空）、
call_forwarding_enabled
（布尔值）、
call_recording_enabled
（布尔值）、
caller_id_name_enabled
（布尔值）、
cnam_listing_enabled
（布尔值）、
connection_id
（字符串 | 空）、
connection_name
（字符串 | 空）、
country_iso_alpha2
（字符串）、
created_at
（日期时间）、
customer_reference
（字符串 | 空）、
deletion_lock_enabled
（布尔值）、
emergency_address_id
（字符串 | 空）、
emergency_enabled
（布尔值）、
emergency_status
（枚举值：active、deprovisioning、disabled、provisioning、provisioning-failed）、
external_pin
（字符串 | 空）、
hd_voice_enabled
（布尔值）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
messaging_profile_id
（字符串 | 空）、
messaging_profile_name
（字符串 | 空）、
phone_number
（字符串）、
phone_number_type
（枚举值：local、toll_free、mobile、national、shared_cost、landline、tollfree、shortcode、longcode）、
purchased_at
（字符串）、
record_type
（字符串）、
source_type
（对象）、
status
（枚举值：purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending、requirement-info-pending、requirement-info-under-review、requirement-info-exception、provision-pending）、
t38_fax_gateway_enabled
（布尔值）、
tags
（字符串数组）、
updated_at
（字符串）

Delete a phone number

删除单个电话号码

DELETE /phone_numbers/{id}
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberDeleteParams;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberDeleteResponse;

PhoneNumberDeleteResponse phoneNumber = client.phoneNumbers().delete("1293384261075731499");
Returns: 
billing_group_id
(string), 
call_forwarding_enabled
(boolean), 
call_recording_enabled
(boolean), 
caller_id_name_enabled
(boolean), 
cnam_listing_enabled
(boolean), 
connection_id
(string), 
connection_name
(string), 
created_at
(string), 
customer_reference
(string), 
deletion_lock_enabled
(boolean), 
emergency_address_id
(string), 
emergency_enabled
(boolean), 
external_pin
(string), 
hd_voice_enabled
(boolean), 
id
(string), 
messaging_profile_id
(string), 
messaging_profile_name
(string), 
phone_number
(string), 
phone_number_type
(enum: local, toll_free, mobile, national, shared_cost, landline), 
purchased_at
(string), 
record_type
(string), 
status
(enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending), 
t38_fax_gateway_enabled
(boolean), 
tags
(array[string]), 
updated_at
(string)
DELETE /phone_numbers/{id}
java
import com.telnyx.sdk.models.phonenumbers.PhoneNumberDeleteParams;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberDeleteResponse;

PhoneNumberDeleteResponse phoneNumber = client.phoneNumbers().delete("1293384261075731499");
返回值：
billing_group_id
（字符串）、
call_forwarding_enabled
（布尔值）、
call_recording_enabled
（布尔值）、
caller_id_name_enabled
（布尔值）、
cnam_listing_enabled
（布尔值）、
connection_id
（字符串）、
connection_name
（字符串）、
created_at
（字符串）、
customer_reference
（字符串）、
deletion_lock_enabled
（布尔值）、
emergency_address_id
（字符串）、
emergency_enabled
（布尔值）、
external_pin
（字符串）、
hd_voice_enabled
（布尔值）、
id
（字符串）、
messaging_profile_id
（字符串）、
messaging_profile_name
（字符串）、
phone_number
（字符串）、
phone_number_type
（枚举值：local、toll_free、mobile、national、shared_cost、landline）、
purchased_at
（字符串）、
record_type
（字符串）、
status
（枚举值：purchase-pending、purchase-failed、port-pending、port-failed、active、deleted、emergency-only、ported-out、port-out-pending）、
t38_fax_gateway_enabled
（布尔值）、
tags
（字符串数组）、
updated_at
（字符串）

Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)

修改电话号码的捆绑包状态（设置为加入捆绑包或从捆绑包中移除）

PATCH /phone_numbers/{id}/actions/bundle_status_change
— Required: 
bundle_id
java
import com.telnyx.sdk.models.phonenumbers.actions.ActionChangeBundleStatusParams;
import com.telnyx.sdk.models.phonenumbers.actions.ActionChangeBundleStatusResponse;

ActionChangeBundleStatusParams params = ActionChangeBundleStatusParams.builder()
    .id("1293384261075731499")
    .bundleId("5194d8fc-87e6-4188-baa9-1c434bbe861b")
    .build();
ActionChangeBundleStatusResponse response = client.phoneNumbers().actions().changeBundleStatus(params);
Returns: 
call_forwarding
(object), 
call_recording
(object), 
cnam_listing
(object), 
connection_id
(string), 
customer_reference
(string), 
emergency
(object), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
media_features
(object), 
phone_number
(string), 
record_type
(string), 
tech_prefix_enabled
(boolean), 
translated_number
(string), 
usage_payment_method
(enum: pay-per-minute, channel)
PATCH /phone_numbers/{id}/actions/bundle_status_change
— 必填参数：
bundle_id
java
import com.telnyx.sdk.models.phonenumbers.actions.ActionChangeBundleStatusParams;
import com.telnyx.sdk.models.phonenumbers.actions.ActionChangeBundleStatusResponse;

ActionChangeBundleStatusParams params = ActionChangeBundleStatusParams.builder()
    .id("1293384261075731499")
    .bundleId("5194d8fc-87e6-4188-baa9-1c434bbe861b")
    .build();
ActionChangeBundleStatusResponse response = client.phoneNumbers().actions().changeBundleStatus(params);
返回值：
call_forwarding
（对象）、
call_recording
（对象）、
cnam_listing
（对象）、
connection_id
（字符串）、
customer_reference
（字符串）、
emergency
（对象）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
media_features
（对象）、
phone_number
（字符串）、
record_type
（字符串）、
tech_prefix_enabled
（布尔值）、
translated_number
（字符串）、
usage_payment_method
（枚举值：pay-per-minute、channel）

Enable emergency for a phone number

为电话号码启用紧急服务

POST /phone_numbers/{id}/actions/enable_emergency
— Required: 
emergency_enabled
, 
emergency_address_id
java
import com.telnyx.sdk.models.phonenumbers.actions.ActionEnableEmergencyParams;
import com.telnyx.sdk.models.phonenumbers.actions.ActionEnableEmergencyResponse;

ActionEnableEmergencyParams params = ActionEnableEmergencyParams.builder()
    .id("1293384261075731499")
    .emergencyAddressId("53829456729313")
    .emergencyEnabled(true)
    .build();
ActionEnableEmergencyResponse response = client.phoneNumbers().actions().enableEmergency(params);
Returns: 
call_forwarding
(object), 
call_recording
(object), 
cnam_listing
(object), 
connection_id
(string), 
customer_reference
(string), 
emergency
(object), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
media_features
(object), 
phone_number
(string), 
record_type
(string), 
tech_prefix_enabled
(boolean), 
translated_number
(string), 
usage_payment_method
(enum: pay-per-minute, channel)
POST /phone_numbers/{id}/actions/enable_emergency
— 必填参数：
emergency_enabled
、
emergency_address_id
java
import com.telnyx.sdk.models.phonenumbers.actions.ActionEnableEmergencyParams;
import com.telnyx.sdk.models.phonenumbers.actions.ActionEnableEmergencyResponse;

ActionEnableEmergencyParams params = ActionEnableEmergencyParams.builder()
    .id("1293384261075731499")
    .emergencyAddressId("53829456729313")
    .emergencyEnabled(true)
    .build();
ActionEnableEmergencyResponse response = client.phoneNumbers().actions().enableEmergency(params);
返回值：
call_forwarding
（对象）、
call_recording
（对象）、
cnam_listing
（对象）、
connection_id
（字符串）、
customer_reference
（字符串）、
emergency
（对象）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
media_features
（对象）、
phone_number
（字符串）、
record_type
（字符串）、
tech_prefix_enabled
（布尔值）、
translated_number
（字符串）、
usage_payment_method
（枚举值：pay-per-minute、channel）

Retrieve a phone number with messaging settings

查询单个带消息配置的电话号码

GET /phone_numbers/{id}/messaging
java
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingRetrieveResponse;

MessagingRetrieveResponse messaging = client.phoneNumbers().messaging().retrieve("550e8400-e29b-41d4-a716-446655440000");
Returns: 
country_code
(string), 
created_at
(date-time), 
eligible_messaging_products
(array[string]), 
features
(object), 
health
(object), 
id
(string), 
messaging_product
(string), 
messaging_profile_id
(string | null), 
organization_id
(string), 
phone_number
(string), 
record_type
(enum: messaging_phone_number, messaging_settings), 
tags
(array[string]), 
traffic_type
(string), 
type
(enum: long-code, toll-free, short-code, longcode, tollfree, shortcode), 
updated_at
(date-time)
GET /phone_numbers/{id}/messaging
java
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingRetrieveResponse;

MessagingRetrieveResponse messaging = client.phoneNumbers().messaging().retrieve("550e8400-e29b-41d4-a716-446655440000");
返回值：
country_code
（字符串）、
created_at
（日期时间）、
eligible_messaging_products
（字符串数组）、
features
（对象）、
health
（对象）、
id
（字符串）、
messaging_product
（字符串）、
messaging_profile_id
（字符串 | 空）、
organization_id
（字符串）、
phone_number
（字符串）、
record_type
（枚举值：messaging_phone_number、messaging_settings）、
tags
（字符串数组）、
traffic_type
（字符串）、
type
（枚举值：long-code、toll-free、short-code、longcode、tollfree、shortcode）、
updated_at
（日期时间）

Update the messaging profile and/or messaging product of a phone number

更新电话号码的消息配置文件和/或消息产品

PATCH /phone_numbers/{id}/messaging
Optional: 
messaging_product
(string), 
messaging_profile_id
(string), 
tags
(array[string])
java
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingUpdateParams;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingUpdateResponse;

MessagingUpdateResponse messaging = client.phoneNumbers().messaging().update("550e8400-e29b-41d4-a716-446655440000");
Returns: 
country_code
(string), 
created_at
(date-time), 
eligible_messaging_products
(array[string]), 
features
(object), 
health
(object), 
id
(string), 
messaging_product
(string), 
messaging_profile_id
(string | null), 
organization_id
(string), 
phone_number
(string), 
record_type
(enum: messaging_phone_number, messaging_settings), 
tags
(array[string]), 
traffic_type
(string), 
type
(enum: long-code, toll-free, short-code, longcode, tollfree, shortcode), 
updated_at
(date-time)
PATCH /phone_numbers/{id}/messaging
可选参数：
messaging_product
（字符串）、
messaging_profile_id
（字符串）、
tags
（字符串数组）
java
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingUpdateParams;
import com.telnyx.sdk.models.phonenumbers.messaging.MessagingUpdateResponse;

MessagingUpdateResponse messaging = client.phoneNumbers().messaging().update("550e8400-e29b-41d4-a716-446655440000");
返回值：
country_code
（字符串）、
created_at
（日期时间）、
eligible_messaging_products
（字符串数组）、
features
（对象）、
health
（对象）、
id
（字符串）、
messaging_product
（字符串）、
messaging_profile_id
（字符串 | 空）、
organization_id
（字符串）、
phone_number
（字符串）、
record_type
（枚举值：messaging_phone_number、messaging_settings）、
tags
（字符串数组）、
traffic_type
（字符串）、
type
（枚举值：long-code、toll-free、short-code、longcode、tollfree、shortcode）、
updated_at
（日期时间）

Retrieve a phone number with voice settings

查询单个带语音配置的电话号码

GET /phone_numbers/{id}/voice
java
import com.telnyx.sdk.models.phonenumbers.voice.VoiceRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.voice.VoiceRetrieveResponse;

VoiceRetrieveResponse voice = client.phoneNumbers().voice().retrieve("1293384261075731499");
Returns: 
call_forwarding
(object), 
call_recording
(object), 
cnam_listing
(object), 
connection_id
(string), 
customer_reference
(string), 
emergency
(object), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
media_features
(object), 
phone_number
(string), 
record_type
(string), 
tech_prefix_enabled
(boolean), 
translated_number
(string), 
usage_payment_method
(enum: pay-per-minute, channel)
GET /phone_numbers/{id}/voice
java
import com.telnyx.sdk.models.phonenumbers.voice.VoiceRetrieveParams;
import com.telnyx.sdk.models.phonenumbers.voice.VoiceRetrieveResponse;

VoiceRetrieveResponse voice = client.phoneNumbers().voice().retrieve("1293384261075731499");
返回值：
call_forwarding
（对象）、
call_recording
（对象）、
cnam_listing
（对象）、
connection_id
（字符串）、
customer_reference
（字符串）、
emergency
（对象）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
media_features
（对象）、
phone_number
（字符串）、
record_type
（字符串）、
tech_prefix_enabled
（布尔值）、
translated_number
（字符串）、
usage_payment_method
（枚举值：pay-per-minute、channel）

Update a phone number with voice settings

更新电话号码的语音配置

PATCH /phone_numbers/{id}/voice
Optional: 
call_forwarding
(object), 
call_recording
(object), 
caller_id_name_enabled
(boolean), 
cnam_listing
(object), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
media_features
(object), 
tech_prefix_enabled
(boolean), 
translated_number
(string), 
usage_payment_method
(enum: pay-per-minute, channel)
java
import com.telnyx.sdk.models.phonenumbers.voice.UpdateVoiceSettings;
import com.telnyx.sdk.models.phonenumbers.voice.VoiceUpdateParams;
import com.telnyx.sdk.models.phonenumbers.voice.VoiceUpdateResponse;

VoiceUpdateParams params = VoiceUpdateParams.builder()
    .id("1293384261075731499")
    .updateVoiceSettings(UpdateVoiceSettings.builder().build())
    .build();
VoiceUpdateResponse voice = client.phoneNumbers().voice().update(params);
Returns: 
call_forwarding
(object), 
call_recording
(object), 
cnam_listing
(object), 
connection_id
(string), 
customer_reference
(string), 
emergency
(object), 
id
(string), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
media_features
(object), 
phone_number
(string), 
record_type
(string), 
tech_prefix_enabled
(boolean), 
translated_number
(string), 
usage_payment_method
(enum: pay-per-minute, channel)
PATCH /phone_numbers/{id}/voice
可选参数：
call_forwarding
（对象）、
call_recording
（对象）、
caller_id_name_enabled
（布尔值）、
cnam_listing
（对象）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
media_features
（对象）、
tech_prefix_enabled
（布尔值）、
translated_number
（字符串）、
usage_payment_method
（枚举值：pay-per-minute、channel）
java
import com.telnyx.sdk.models.phonenumbers.voice.UpdateVoiceSettings;
import com.telnyx.sdk.models.phonenumbers.voice.VoiceUpdateParams;
import com.telnyx.sdk.models.phonenumbers.voice.VoiceUpdateResponse;

VoiceUpdateParams params = VoiceUpdateParams.builder()
    .id("1293384261075731499")
    .updateVoiceSettings(UpdateVoiceSettings.builder().build())
    .build();
VoiceUpdateResponse voice = client.phoneNumbers().voice().update(params);
返回值：
call_forwarding
（对象）、
call_recording
（对象）、
cnam_listing
（对象）、
connection_id
（字符串）、
customer_reference
（字符串）、
emergency
（对象）、
id
（字符串）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
media_features
（对象）、
phone_number
（字符串）、
record_type
（字符串）、
tech_prefix_enabled
（布尔值）、
translated_number
（字符串）、
usage_payment_method
（枚举值：pay-per-minute、channel）

List Mobile Phone Numbers

列出移动电话号码

GET /v2/mobile_phone_numbers
java
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberListPage;
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberListParams;

MobilePhoneNumberListPage page = client.mobilePhoneNumbers().list();
Returns: 
call_forwarding
(object), 
call_recording
(object), 
caller_id_name_enabled
(boolean), 
cnam_listing
(object), 
connection_id
(string | null), 
connection_name
(string | null), 
connection_type
(string | null), 
country_iso_alpha2
(string), 
created_at
(date-time), 
customer_reference
(string | null), 
id
(string), 
inbound
(object), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
mobile_voice_enabled
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
outbound
(object), 
phone_number
(string), 
record_type
(string), 
sim_card_id
(uuid), 
status
(string), 
tags
(array[string]), 
updated_at
(date-time)
GET /v2/mobile_phone_numbers
java
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberListPage;
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberListParams;

MobilePhoneNumberListPage page = client.mobilePhoneNumbers().list();
返回值：
call_forwarding
（对象）、
call_recording
（对象）、
caller_id_name_enabled
（布尔值）、
cnam_listing
（对象）、
connection_id
（字符串 | 空）、
connection_name
（字符串 | 空）、
connection_type
（字符串 | 空）、
country_iso_alpha2
（字符串）、
created_at
（日期时间）、
customer_reference
（字符串 | 空）、
id
（字符串）、
inbound
（对象）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
mobile_voice_enabled
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
outbound
（对象）、
phone_number
（字符串）、
record_type
（字符串）、
sim_card_id
（uuid）、
status
（字符串）、
tags
（字符串数组）、
updated_at
（日期时间）

Retrieve a Mobile Phone Number

查询单个移动电话号码

GET /v2/mobile_phone_numbers/{id}
java
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberRetrieveParams;
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberRetrieveResponse;

MobilePhoneNumberRetrieveResponse mobilePhoneNumber = client.mobilePhoneNumbers().retrieve("550e8400-e29b-41d4-a716-446655440000");
Returns: 
call_forwarding
(object), 
call_recording
(object), 
caller_id_name_enabled
(boolean), 
cnam_listing
(object), 
connection_id
(string | null), 
connection_name
(string | null), 
connection_type
(string | null), 
country_iso_alpha2
(string), 
created_at
(date-time), 
customer_reference
(string | null), 
id
(string), 
inbound
(object), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
mobile_voice_enabled
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
outbound
(object), 
phone_number
(string), 
record_type
(string), 
sim_card_id
(uuid), 
status
(string), 
tags
(array[string]), 
updated_at
(date-time)
GET /v2/mobile_phone_numbers/{id}
java
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberRetrieveParams;
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberRetrieveResponse;

MobilePhoneNumberRetrieveResponse mobilePhoneNumber = client.mobilePhoneNumbers().retrieve("550e8400-e29b-41d4-a716-446655440000");
返回值：
call_forwarding
（对象）、
call_recording
（对象）、
caller_id_name_enabled
（布尔值）、
cnam_listing
（对象）、
connection_id
（字符串 | 空）、
connection_name
（字符串 | 空）、
connection_type
（字符串 | 空）、
country_iso_alpha2
（字符串）、
created_at
（日期时间）、
customer_reference
（字符串 | 空）、
id
（字符串）、
inbound
（对象）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
mobile_voice_enabled
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
outbound
（对象）、
phone_number
（字符串）、
record_type
（字符串）、
sim_card_id
（uuid）、
status
（字符串）、
tags
（字符串数组）、
updated_at
（日期时间）

Update a Mobile Phone Number

更新移动电话号码

PATCH /v2/mobile_phone_numbers/{id}
Optional: 
call_forwarding
(object), 
call_recording
(object), 
caller_id_name_enabled
(boolean), 
cnam_listing
(object), 
connection_id
(string | null), 
customer_reference
(string | null), 
inbound
(object), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
noise_suppression
(boolean), 
outbound
(object), 
tags
(array[string])
java
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberUpdateParams;
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberUpdateResponse;

MobilePhoneNumberUpdateResponse mobilePhoneNumber = client.mobilePhoneNumbers().update("550e8400-e29b-41d4-a716-446655440000");
Returns: 
call_forwarding
(object), 
call_recording
(object), 
caller_id_name_enabled
(boolean), 
cnam_listing
(object), 
connection_id
(string | null), 
connection_name
(string | null), 
connection_type
(string | null), 
country_iso_alpha2
(string), 
created_at
(date-time), 
customer_reference
(string | null), 
id
(string), 
inbound
(object), 
inbound_call_screening
(enum: disabled, reject_calls, flag_calls), 
mobile_voice_enabled
(boolean), 
noise_suppression
(enum: inbound, outbound, both, disabled), 
outbound
(object), 
phone_number
(string), 
record_type
(string), 
sim_card_id
(uuid), 
status
(string), 
tags
(array[string]), 
updated_at
(date-time)
PATCH /v2/mobile_phone_numbers/{id}
可选参数：
call_forwarding
（对象）、
call_recording
（对象）、
caller_id_name_enabled
（布尔值）、
cnam_listing
（对象）、
connection_id
（字符串 | 空）、
customer_reference
（字符串 | 空）、
inbound
（对象）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
noise_suppression
（布尔值）、
outbound
（对象）、
tags
（字符串数组）
java
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberUpdateParams;
import com.telnyx.sdk.models.mobilephonenumbers.MobilePhoneNumberUpdateResponse;

MobilePhoneNumberUpdateResponse mobilePhoneNumber = client.mobilePhoneNumbers().update("550e8400-e29b-41d4-a716-446655440000");
返回值：
call_forwarding
（对象）、
call_recording
（对象）、
caller_id_name_enabled
（布尔值）、
cnam_listing
（对象）、
connection_id
（字符串 | 空）、
connection_name
（字符串 | 空）、
connection_type
（字符串 | 空）、
country_iso_alpha2
（字符串）、
created_at
（日期时间）、
customer_reference
（字符串 | 空）、
id
（字符串）、
inbound
（对象）、
inbound_call_screening
（枚举值：disabled、reject_calls、flag_calls）、
mobile_voice_enabled
（布尔值）、
noise_suppression
（枚举值：inbound、outbound、both、disabled）、
outbound
（对象）、
phone_number
（字符串）、
record_type
（字符串）、
sim_card_id
（uuid）、
status
（字符串）、
tags
（字符串数组）、
updated_at
（日期时间）