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

Telnyx Webrtc - Java

Installation

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

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

Setup

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.

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:

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

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

List mobile push credentials

GET /mobilepushcredentials

import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialListPage;
import com.telnyx.sdk.models.mobilepushcredentials.MobilePushCredentialListParams;

MobilePushCredentialListPage page = client.mobilePushCredentials().list();

Returns: alias (string), certificate (string), createdat (date-time), id (string), privatekey (string), projectaccountjsonfile (object), recordtype (string), type (string), updated_at (date-time)

Creates a new mobile push credential

POST /mobilepushcredentials — Required: type, certificate, private_key, alias

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), createdat (date-time), id (string), privatekey (string), projectaccountjsonfile (object), recordtype (string), type (string), updated_at (date-time)

Retrieves a mobile push credential

Retrieves mobile push credential based on the given pushcredentialid

GET /mobilepushcredentials/{pushcredentialid}

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), createdat (date-time), id (string), privatekey (string), projectaccountjsonfile (object), recordtype (string), type (string), updated_at (date-time)

Deletes a mobile push credential

Deletes a mobile push credential based on the given pushcredentialid

DELETE /mobilepushcredentials/{pushcredentialid}

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

import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialListPage;
import com.telnyx.sdk.models.telephonycredentials.TelephonyCredentialListParams;

TelephonyCredentialListPage page = client.telephonyCredentials().list();

Returns: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)

Create a credential

Create a credential.

POST /telephonycredentials — Required: connectionid

Optional: expires_at (string), name (string), tag (string)

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: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)

Get a credential

Get the details of an existing On-demand Credential.

GET /telephony_credentials/{id}

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: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)

Update a credential

Update an existing credential.

PATCH /telephony_credentials/{id}

Optional: connectionid (string), expiresat (string), name (string), tag (string)

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: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)

Delete a credential

Delete an existing credential.

DELETE /telephony_credentials/{id}

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: createdat (string), expired (boolean), expiresat (string), id (string), name (string), recordtype (string), resourceid (string), sippassword (string), sipusername (string), updatedat (string), userid (string)