Back to Details

telnyx-webrtc-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 Webrtc - Java

Telnyx Webrtc - 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

重要说明

  • Pagination: List methods return a page. Use 
    .autoPager()
    for automatic iteration: 
    for (var item : page.autoPager()) { ... }
    . For manual control, use 
    .hasNextPage()
    and 
    .nextPage()
    .
  • 分页： 列表方法返回单页数据。如需自动遍历可使用
    .autoPager()
    ：
    for (var item : page.autoPager()) { ... }
    。如需手动控制，可使用
    .hasNextPage()
    和
    .nextPage()
    方法。

List mobile push credentials

列出移动推送凭证

GET /mobile_push_credentials
java
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialListPage;
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialListParams;

MobilePushCredentialListPage page = client.mobilePushCredentials().list();
Returns: 
alias
(string), 
certificate
(string), 
created_at
(date-time), 
id
(string), 
private_key
(string), 
project_account_json_file
(object), 
record_type
(string), 
type
(string), 
updated_at
(date-time)
GET /mobile_push_credentials
java
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialListPage;
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialListParams;

MobilePushCredentialListPage page = client.mobilePushCredentials().list();
返回参数：
alias
（字符串）、
certificate
（字符串）、
created_at
（日期时间）、
id
（字符串）、
private_key
（字符串）、
project_account_json_file
（对象）、
record_type
（字符串）、
type
（字符串）、
updated_at
（日期时间）

Creates a new mobile push credential

创建新的移动推送凭证

POST /mobile_push_credentials
— Required: 
type
, 
certificate
, 
private_key
, 
alias
java
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialCreateParams;
import com.telnyx.sdk.models.mobilepushcredentials.PushCredentialResponse;

MobilePushCredentialCreateParams.CreateMobilePushCredentialRequest.Ios params = MobilePushCredentialCreateParams.CreateMobilePushCredentialRequest.Ios.builder()
    .alias("LucyIosCredential")
    .certificate("-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----")
    .privateKey("-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----")
    .build();
PushCredentialResponse pushCredentialResponse = client.mobilePushCredentials().create(params);
Returns: 
alias
(string), 
certificate
(string), 
created_at
(date-time), 
id
(string), 
private_key
(string), 
project_account_json_file
(object), 
record_type
(string), 
type
(string), 
updated_at
(date-time)
POST /mobile_push_credentials
— 必填参数：
type
、
certificate
、
private_key
、
alias
java
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialCreateParams;
import com.telnyx.sdk.models.mobilepushcredentials.PushCredentialResponse;

MobilePushCredentialCreateParams.CreateMobilePushCredentialRequest.Ios params = MobilePushCredentialCreateParams.CreateMobilePushCredentialRequest.Ios.builder()
    .alias("LucyIosCredential")
    .certificate("-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----")
    .privateKey("-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----")
    .build();
PushCredentialResponse pushCredentialResponse = client.mobilePushCredentials().create(params);
返回参数：
alias
（字符串）、
certificate
（字符串）、
created_at
（日期时间）、
id
（字符串）、
private_key
（字符串）、
project_account_json_file
（对象）、
record_type
（字符串）、
type
（字符串）、
updated_at
（日期时间）

Retrieves a mobile push credential

查询单个移动推送凭证

Retrieves mobile push credential based on the given 
push_credential_id
GET /mobile_push_credentials/{push_credential_id}
java
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialRetrieveParams;
import com.telnyx.sdk.models.mobilepushcredentials.PushCredentialResponse;

PushCredentialResponse pushCredentialResponse = client.mobilePushCredentials().retrieve("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0");
Returns: 
alias
(string), 
certificate
(string), 
created_at
(date-time), 
id
(string), 
private_key
(string), 
project_account_json_file
(object), 
record_type
(string), 
type
(string), 
updated_at
(date-time)
根据传入的
push_credential_id
查询对应的移动推送凭证
GET /mobile_push_credentials/{push_credential_id}
java
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialRetrieveParams;
import com.telnyx.sdk.models.mobilepushcredentials.PushCredentialResponse;

PushCredentialResponse pushCredentialResponse = client.mobilePushCredentials().retrieve("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0");
返回参数：
alias
（字符串）、
certificate
（字符串）、
created_at
（日期时间）、
id
（字符串）、
private_key
（字符串）、
project_account_json_file
（对象）、
record_type
（字符串）、
type
（字符串）、
updated_at
（日期时间）

Deletes a mobile push credential

删除移动推送凭证

Deletes a mobile push credential based on the given 
push_credential_id
DELETE /mobile_push_credentials/{push_credential_id}
java
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialDeleteParams;

client.mobilePushCredentials().delete("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0");
根据传入的
push_credential_id
删除对应的移动推送凭证
DELETE /mobile_push_credentials/{push_credential_id}
java
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialDeleteParams;

client.mobilePushCredentials().delete("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0");

List all credentials

列出所有凭证

List all On-demand Credentials.
GET /telephony_credentials
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialListPage;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialListParams;

TelephonyCredentialListPage page = client.telephonyCredentials().list();
Returns: 
created_at
(string), 
expired
(boolean), 
expires_at
(string), 
id
(string), 
name
(string), 
record_type
(string), 
resource_id
(string), 
sip_password
(string), 
sip_username
(string), 
updated_at
(string), 
user_id
(string)
列出所有按需凭证。
GET /telephony_credentials
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialListPage;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialListParams;

TelephonyCredentialListPage page = client.telephonyCredentials().list();
返回参数：
created_at
（字符串）、
expired
（布尔值）、
expires_at
（字符串）、
id
（字符串）、
name
（字符串）、
record_type
（字符串）、
resource_id
（字符串）、
sip_password
（字符串）、
sip_username
（字符串）、
updated_at
（字符串）、
user_id
（字符串）

Create a credential

创建凭证

Create a credential.
POST /telephony_credentials
— Required: 
connection_id
Optional: 
expires_at
(string), 
name
(string), 
tag
(string)
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialCreateParams;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialCreateResponse;

TelephonyCredentialCreateParams params = TelephonyCredentialCreateParams.builder()
    .connectionId("1234567890")
    .build();
TelephonyCredentialCreateResponse telephonyCredential = client.telephonyCredentials().create(params);
Returns: 
created_at
(string), 
expired
(boolean), 
expires_at
(string), 
id
(string), 
name
(string), 
record_type
(string), 
resource_id
(string), 
sip_password
(string), 
sip_username
(string), 
updated_at
(string), 
user_id
(string)
创建一个凭证。
POST /telephony_credentials
— 必填参数：
connection_id
可选参数：
expires_at
（字符串）、
name
（字符串）、
tag
（字符串）
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialCreateParams;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialCreateResponse;

TelephonyCredentialCreateParams params = TelephonyCredentialCreateParams.builder()
    .connectionId("1234567890")
    .build();
TelephonyCredentialCreateResponse telephonyCredential = client.telephonyCredentials().create(params);
返回参数：
created_at
（字符串）、
expired
（布尔值）、
expires_at
（字符串）、
id
（字符串）、
name
（字符串）、
record_type
（字符串）、
resource_id
（字符串）、
sip_password
（字符串）、
sip_username
（字符串）、
updated_at
（字符串）、
user_id
（字符串）

Get a credential

查询单个凭证

Get the details of an existing On-demand Credential.
GET /telephony_credentials/{id}
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialRetrieveParams;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialRetrieveResponse;

TelephonyCredentialRetrieveResponse telephonyCredential = client.telephonyCredentials().retrieve("550e8400-e29b-41d4-a716-446655440000");
Returns: 
created_at
(string), 
expired
(boolean), 
expires_at
(string), 
id
(string), 
name
(string), 
record_type
(string), 
resource_id
(string), 
sip_password
(string), 
sip_username
(string), 
updated_at
(string), 
user_id
(string)
查询已存在的按需凭证的详情。
GET /telephony_credentials/{id}
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialRetrieveParams;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialRetrieveResponse;

TelephonyCredentialRetrieveResponse telephonyCredential = client.telephonyCredentials().retrieve("550e8400-e29b-41d4-a716-446655440000");
返回参数：
created_at
（字符串）、
expired
（布尔值）、
expires_at
（字符串）、
id
（字符串）、
name
（字符串）、
record_type
（字符串）、
resource_id
（字符串）、
sip_password
（字符串）、
sip_username
（字符串）、
updated_at
（字符串）、
user_id
（字符串）

Update a credential

更新凭证

Update an existing credential.
PATCH /telephony_credentials/{id}
Optional: 
connection_id
(string), 
expires_at
(string), 
name
(string), 
tag
(string)
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialUpdateParams;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialUpdateResponse;

TelephonyCredentialUpdateResponse telephonyCredential = client.telephonyCredentials().update("550e8400-e29b-41d4-a716-446655440000");
Returns: 
created_at
(string), 
expired
(boolean), 
expires_at
(string), 
id
(string), 
name
(string), 
record_type
(string), 
resource_id
(string), 
sip_password
(string), 
sip_username
(string), 
updated_at
(string), 
user_id
(string)
更新已存在的凭证。
PATCH /telephony_credentials/{id}
可选参数：
connection_id
（字符串）、
expires_at
（字符串）、
name
（字符串）、
tag
（字符串）
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialUpdateParams;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialUpdateResponse;

TelephonyCredentialUpdateResponse telephonyCredential = client.telephonyCredentials().update("550e8400-e29b-41d4-a716-446655440000");
返回参数：
created_at
（字符串）、
expired
（布尔值）、
expires_at
（字符串）、
id
（字符串）、
name
（字符串）、
record_type
（字符串）、
resource_id
（字符串）、
sip_password
（字符串）、
sip_username
（字符串）、
updated_at
（字符串）、
user_id
（字符串）

Delete a credential

删除凭证

Delete an existing credential.
DELETE /telephony_credentials/{id}
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialDeleteParams;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialDeleteResponse;

TelephonyCredentialDeleteResponse telephonyCredential = client.telephonyCredentials().delete("550e8400-e29b-41d4-a716-446655440000");
Returns: 
created_at
(string), 
expired
(boolean), 
expires_at
(string), 
id
(string), 
name
(string), 
record_type
(string), 
resource_id
(string), 
sip_password
(string), 
sip_username
(string), 
updated_at
(string), 
user_id
(string)
删除已存在的凭证。
DELETE /telephony_credentials/{id}
java
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialDeleteParams;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialDeleteResponse;

TelephonyCredentialDeleteResponse telephonyCredential = client.telephonyCredentials().delete("550e8400-e29b-41d4-a716-446655440000");
返回参数：
created_at
（字符串）、
expired
（布尔值）、
expires_at
（字符串）、
id
（字符串）、
name
（字符串）、
record_type
（字符串）、
resource_id
（字符串）、
sip_password
（字符串）、
sip_username
（字符串）、
updated_at
（字符串）、
user_id
（字符串）