Test VoIP push notifications for Telnyx WebRTC iOS (APNs) and Android (FCM) apps. Use when debugging push notification delivery, validating certificate/credential setup, or testing that a device receives VoIP pushes correctly.
中文简介正在准备中。当前显示原文说明。
Build voice applications using TeXML markup language (TwiML-compatible). Manage applications, calls, conferences, recordings, queues, and streams. This skill provides Java SDK examples.
中文简介正在准备中。当前显示原文说明。
查看安装方法安装前可以查看交给 AI 代理的指令内容。
<!-- Maven -->
<dependency>
<groupId>com.telnyx.sdk</groupId>
<artifactId>telnyx</artifactId>
<version>6.95.0</version>
</dependency>
// Gradle
implementation("com.telnyx.sdk:telnyx:6.95.0")
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
// fromEnv() reads TELNYX_API_KEY and TELNYX_PUBLIC_KEY (the public key is required for
// client.webhooks().unwrap() — webhook verification)
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
All examples below assume client is already initialized as shown above.
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, then retry the request (bounded exponential backoff)
Thread.sleep(1000);
// ...retry the call here (give up after a few attempts)
}
throw e; // Re-throw: a failed request must never look like success to the caller
}
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).
.autoPager() for automatic iteration: for (var item : page.autoPager()) { ... }. For manual control, use .hasNextPage() and .nextPage().Returns multiple call resources for an account. This endpoint is eventually consistent.
GET /texml/Accounts/{account_sid}/Calls
import com.telnyx.sdk.models.texml.accounts.calls.CallRetrieveCallsParams;
import com.telnyx.sdk.models.texml.accounts.calls.CallRetrieveCallsResponse;
CallRetrieveCallsResponse response = client.texml().accounts().calls().retrieveCalls("550e8400-e29b-41d4-a716-446655440000");
Returns: calls (array[object]), end (integer), first_page_uri (string), next_page_uri (string), page (integer), page_size (integer), start (integer), uri (string)
Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal.
POST /texml/Accounts/{account_sid}/Calls — Required: Url
Optional: Texml (object)
import com.telnyx.sdk.models.texml.accounts.calls.CallCallsParams;
import com.telnyx.sdk.models.texml.accounts.calls.CallCallsResponse;
CallCallsParams params = CallCallsParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.params(CallCallsParams.Params.WithUrl.builder()
.url("https://www.example.com/texml.xml")
.build())
.build();
CallCallsResponse response = client.texml().accounts().calls().calls(params);
Returns: from (string), status (string), to (string)
Returns an individual call identified by its CallSid. This endpoint is eventually consistent.
GET /texml/Accounts/{account_sid}/Calls/{call_sid}
import com.telnyx.sdk.models.texml.accounts.calls.CallRetrieveParams;
import com.telnyx.sdk.models.texml.accounts.calls.CallRetrieveResponse;
CallRetrieveParams params = CallRetrieveParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.build();
CallRetrieveResponse call = client.texml().accounts().calls().retrieve(params);
Returns: account_sid (string), answered_by (enum: human, machine, not_sure), caller_name (string), date_created (string), date_updated (string), direction (enum: inbound, outbound), duration (string), end_time (string), from (string), from_formatted (string), price (string), price_unit (string), sid (string), start_time (string), status (enum: ringing, in-progress, canceled, completed, failed, busy, no-answer), to (string), to_formatted (string), uri (string)
Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}
import com.telnyx.sdk.models.texml.accounts.calls.CallUpdateParams;
import com.telnyx.sdk.models.texml.accounts.calls.CallUpdateResponse;
import com.telnyx.sdk.models.texml.accounts.calls.UpdateCall;
CallUpdateParams params = CallUpdateParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.updateCall(UpdateCall.builder().build())
.build();
CallUpdateResponse call = client.texml().accounts().calls().update(params);
Returns: account_sid (string), answered_by (enum: human, machine, not_sure), caller_name (string), date_created (string), date_updated (string), direction (enum: inbound, outbound), duration (string), end_time (string), from (string), from_formatted (string), price (string), price_unit (string), sid (string), start_time (string), status (enum: ringing, in-progress, canceled, completed, failed, busy, no-answer), to (string), to_formatted (string), uri (string)
Returns recordings for a call identified by call_sid.
GET /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json
import com.telnyx.sdk.models.texml.accounts.calls.recordingsjson.RecordingsJsonRetrieveRecordingsJsonParams;
import com.telnyx.sdk.models.texml.accounts.calls.recordingsjson.RecordingsJsonRetrieveRecordingsJsonResponse;
RecordingsJsonRetrieveRecordingsJsonParams params = RecordingsJsonRetrieveRecordingsJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.build();
RecordingsJsonRetrieveRecordingsJsonResponse response = client.texml().accounts().calls().recordingsJson().retrieveRecordingsJson(params);
Returns: end (integer), first_page_uri (uri), next_page_uri (string), page (integer), page_size (integer), previous_page_uri (uri), recordings (array[object]), start (integer), uri (string)
Starts recording with specified parameters for call identified by call_sid.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json
import com.telnyx.sdk.models.texml.accounts.calls.recordingsjson.RecordingsJsonRecordingsJsonParams;
import com.telnyx.sdk.models.texml.accounts.calls.recordingsjson.RecordingsJsonRecordingsJsonResponse;
RecordingsJsonRecordingsJsonParams params = RecordingsJsonRecordingsJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.build();
RecordingsJsonRecordingsJsonResponse response = client.texml().accounts().calls().recordingsJson().recordingsJson(params);
Returns: account_sid (string), call_sid (string), channels (enum: 1, 2), conference_sid (uuid), date_created (date-time), date_updated (date-time), duration (string | null), error_code (string | null), price (string | null), price_unit (string | null), sid (string), source (enum: StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking), start_time (date-time), track (enum: inbound, outbound, both), uri (string)
Updates recording resource for particular call.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json
import com.telnyx.sdk.models.texml.accounts.calls.recordings.RecordingRecordingSidJsonParams;
import com.telnyx.sdk.models.texml.accounts.calls.recordings.RecordingRecordingSidJsonResponse;
RecordingRecordingSidJsonParams params = RecordingRecordingSidJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.recordingSid("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
.build();
RecordingRecordingSidJsonResponse response = client.texml().accounts().calls().recordings().recordingSidJson(params);
Returns: account_sid (string), call_sid (string), channels (enum: 1, 2), conference_sid (uuid), date_created (date-time), date_updated (date-time), duration (string | null), error_code (string | null), price (string | null), price_unit (string | null), sid (string), source (enum: StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking), start_time (date-time), track (enum: inbound, outbound, both), uri (string)
Starts siprec session with specified parameters for call identified by call_sid.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json
import com.telnyx.sdk.models.texml.accounts.calls.CallSiprecJsonParams;
import com.telnyx.sdk.models.texml.accounts.calls.CallSiprecJsonResponse;
CallSiprecJsonParams params = CallSiprecJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.build();
CallSiprecJsonResponse response = client.texml().accounts().calls().siprecJson(params);
Returns: account_sid (string), call_sid (string), date_created (string), date_updated (string), error_code (string), sid (string), start_time (string), status (enum: in-progress, stopped), track (enum: both_tracks, inbound_track, outbound_track), uri (string)
Updates siprec session identified by siprec_sid.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec/{siprec_sid}.json
import com.telnyx.sdk.models.texml.accounts.calls.siprec.SiprecSiprecSidJsonParams;
import com.telnyx.sdk.models.texml.accounts.calls.siprec.SiprecSiprecSidJsonResponse;
SiprecSiprecSidJsonParams params = SiprecSiprecSidJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.siprecSid("550e8400-e29b-41d4-a716-446655440000")
.build();
SiprecSiprecSidJsonResponse response = client.texml().accounts().calls().siprec().siprecSidJson(params);
Returns: account_sid (string), call_sid (string), date_updated (string), error_code (string), sid (string), status (enum: in-progress, stopped), uri (string)
Starts streaming media from a call to a specific WebSocket address.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams.json
import com.telnyx.sdk.models.texml.accounts.calls.CallStreamsJsonParams;
import com.telnyx.sdk.models.texml.accounts.calls.CallStreamsJsonResponse;
CallStreamsJsonParams params = CallStreamsJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.build();
CallStreamsJsonResponse response = client.texml().accounts().calls().streamsJson(params);
Returns: account_sid (string), call_sid (string), date_updated (date-time), name (string), sid (string), status (enum: in-progress), uri (string)
Updates streaming resource for particular call.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams/{streaming_sid}.json
import com.telnyx.sdk.models.texml.accounts.calls.streams.StreamStreamingSidJsonParams;
import com.telnyx.sdk.models.texml.accounts.calls.streams.StreamStreamingSidJsonResponse;
StreamStreamingSidJsonParams params = StreamStreamingSidJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.callSid("550e8400-e29b-41d4-a716-446655440000")
.streamingSid("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
.build();
StreamStreamingSidJsonResponse response = client.texml().accounts().calls().streams().streamingSidJson(params);
Returns: account_sid (string), call_sid (string), date_updated (date-time), sid (string), status (enum: stopped), uri (string)
Returns a paginated list of conference resources for the account, with support for filtering by friendly name, status, and creation or update dates.
GET /texml/Accounts/{account_sid}/Conferences
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceRetrieveConferencesParams;
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceRetrieveConferencesResponse;
ConferenceRetrieveConferencesResponse response = client.texml().accounts().conferences().retrieveConferences("550e8400-e29b-41d4-a716-446655440000");
Returns: conferences (array[object]), end (integer), first_page_uri (string), next_page_uri (string), page (integer), page_size (integer), start (integer), uri (string)
Returns a single conference resource for the account by its ConferenceSid.
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceRetrieveParams;
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceRetrieveResponse;
ConferenceRetrieveParams params = ConferenceRetrieveParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.build();
ConferenceRetrieveResponse conference = client.texml().accounts().conferences().retrieve(params);
Returns: account_sid (string), api_version (string), call_sid_ending_conference (string), date_created (string), date_updated (string), friendly_name (string), reason_conference_ended (enum: participant-with-end-conference-on-exit-left, last-participant-left, conference-ended-via-api, time-exceeded), region (string), sid (string), status (enum: init, in-progress, completed), subresource_uris (object), uri (string)
Updates the specified conference resource, for example to modify its status, and returns the updated conference.
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceUpdateParams;
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceUpdateResponse;
ConferenceUpdateParams params = ConferenceUpdateParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.build();
ConferenceUpdateResponse conference = client.texml().accounts().conferences().update(params);
Returns: account_sid (string), api_version (string), call_sid_ending_conference (string), date_created (string), date_updated (string), friendly_name (string), reason_conference_ended (enum: participant-with-end-conference-on-exit-left, last-participant-left, conference-ended-via-api, time-exceeded), region (string), sid (string), status (enum: init, in-progress, completed), subresource_uris (object), uri (string)
Returns the list of participants currently in the specified conference.
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantRetrieveParticipantsParams;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantRetrieveParticipantsResponse;
ParticipantRetrieveParticipantsParams params = ParticipantRetrieveParticipantsParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.build();
ParticipantRetrieveParticipantsResponse response = client.texml().accounts().conferences().participants().retrieveParticipants(params);
Returns: end (integer), first_page_uri (string), next_page_uri (string), page (integer), page_size (integer), participants (array[object]), start (integer), uri (string)
Dials a new participant into the specified conference and returns the created participant resource.
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsParams;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantParticipantsResponse;
ParticipantParticipantsParams params = ParticipantParticipantsParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.build();
ParticipantParticipantsResponse response = client.texml().accounts().conferences().participants().participants(params);
Returns: account_sid (string), call_sid (string), coaching (boolean), coaching_call_sid (string), conference_sid (uuid), end_conference_on_exit (boolean), hold (boolean), muted (boolean), status (enum: connecting, connected, completed), uri (string)
Returns a single conference participant resource by call SID or participant label.
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantRetrieveParams;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantRetrieveResponse;
ParticipantRetrieveParams params = ParticipantRetrieveParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.callSidOrParticipantLabel("participant-1")
.build();
ParticipantRetrieveResponse participant = client.texml().accounts().conferences().participants().retrieve(params);
Returns: account_sid (string), api_version (string), call_sid (string), call_sid_legacy (string), coaching (boolean), coaching_call_sid (string), coaching_call_sid_legacy (string), conference_sid (uuid), date_created (string), date_updated (string), end_conference_on_exit (boolean), hold (boolean), muted (boolean), status (enum: connecting, connected, completed), uri (string)
Updates the specified conference participant, for example muting or holding them, and returns the updated participant.
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantUpdateParams;
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantUpdateResponse;
ParticipantUpdateParams params = ParticipantUpdateParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.callSidOrParticipantLabel("participant-1")
.build();
ParticipantUpdateResponse participant = client.texml().accounts().conferences().participants().update(params);
Returns: account_sid (string), api_version (string), call_sid (string), call_sid_legacy (string), coaching (boolean), coaching_call_sid (string), coaching_call_sid_legacy (string), conference_sid (uuid), date_created (string), date_updated (string), end_conference_on_exit (boolean), hold (boolean), muted (boolean), status (enum: connecting, connected, completed), uri (string)
Removes the specified participant from the conference, ending their leg of the call.
DELETE /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}
import com.telnyx.sdk.models.texml.accounts.conferences.participants.ParticipantDeleteParams;
ParticipantDeleteParams params = ParticipantDeleteParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.callSidOrParticipantLabel("participant-1")
.build();
client.texml().accounts().conferences().participants().delete(params);
Returns the list of recordings made for the specified conference.
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceRetrieveRecordingsParams;
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceRetrieveRecordingsResponse;
ConferenceRetrieveRecordingsParams params = ConferenceRetrieveRecordingsParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.build();
ConferenceRetrieveRecordingsResponse response = client.texml().accounts().conferences().retrieveRecordings(params);
Returns: end (integer), first_page_uri (string), next_page_uri (string), page (integer), page_size (integer), participants (array[object]), recordings (array[object]), start (integer), uri (string)
Returns recordings for a conference identified by conference_sid.
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceRetrieveRecordingsJsonParams;
import com.telnyx.sdk.models.texml.accounts.conferences.ConferenceRetrieveRecordingsJsonResponse;
ConferenceRetrieveRecordingsJsonParams params = ConferenceRetrieveRecordingsJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.conferenceSid("550e8400-e29b-41d4-a716-446655440000")
.build();
ConferenceRetrieveRecordingsJsonResponse response = client.texml().accounts().conferences().retrieveRecordingsJson(params);
Returns: end (integer), first_page_uri (uri), next_page_uri (string), page (integer), page_size (integer), previous_page_uri (uri), recordings (array[object]), start (integer), uri (string)
Returns a paginated list of queue resources for the account, with support for filtering by creation or update dates.
GET /texml/Accounts/{account_sid}/Queues
import com.telnyx.sdk.models.texml.accounts.queues.QueueListPage;
import com.telnyx.sdk.models.texml.accounts.queues.QueueListParams;
QueueListPage page = client.texml().accounts().queues().list("550e8400-e29b-41d4-a716-446655440000");
Returns: end (integer), first_page_uri (string), next_page_uri (string), page (integer), page_size (integer), queues (array[object]), start (integer), uri (string)
Creates a new queue resource for the account with the provided settings and returns it.
POST /texml/Accounts/{account_sid}/Queues
import com.telnyx.sdk.models.texml.accounts.queues.QueueCreateParams;
import com.telnyx.sdk.models.texml.accounts.queues.QueueCreateResponse;
QueueCreateResponse queue = client.texml().accounts().queues().create("550e8400-e29b-41d4-a716-446655440000");
Returns: account_sid (string), average_wait_time (integer), current_size (integer), date_created (string), date_updated (string), max_size (integer), sid (string), subresource_uris (object), uri (string)
Returns a single queue resource for the account by its QueueSid.
GET /texml/Accounts/{account_sid}/Queues/{queue_sid}
import com.telnyx.sdk.models.texml.accounts.queues.QueueRetrieveParams;
import com.telnyx.sdk.models.texml.accounts.queues.QueueRetrieveResponse;
QueueRetrieveParams params = QueueRetrieveParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.queueSid("550e8400-e29b-41d4-a716-446655440000")
.build();
QueueRetrieveResponse queue = client.texml().accounts().queues().retrieve(params);
Returns: account_sid (string), average_wait_time (integer), current_size (integer), date_created (string), date_updated (string), max_size (integer), sid (string), subresource_uris (object), uri (string)
Updates the specified queue resource's settings and returns the updated queue.
POST /texml/Accounts/{account_sid}/Queues/{queue_sid}
import com.telnyx.sdk.models.texml.accounts.queues.QueueUpdateParams;
import com.telnyx.sdk.models.texml.accounts.queues.QueueUpdateResponse;
QueueUpdateParams params = QueueUpdateParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.queueSid("550e8400-e29b-41d4-a716-446655440000")
.build();
QueueUpdateResponse queue = client.texml().accounts().queues().update(params);
Returns: account_sid (string), average_wait_time (integer), current_size (integer), date_created (string), date_updated (string), max_size (integer), sid (string), subresource_uris (object), uri (string)
Permanently deletes the specified queue resource from the account.
DELETE /texml/Accounts/{account_sid}/Queues/{queue_sid}
import com.telnyx.sdk.models.texml.accounts.queues.QueueDeleteParams;
QueueDeleteParams params = QueueDeleteParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.queueSid("550e8400-e29b-41d4-a716-446655440000")
.build();
client.texml().accounts().queues().delete(params);
Returns multiple recording resources for an account.
GET /texml/Accounts/{account_sid}/Recordings.json
import com.telnyx.sdk.models.texml.accounts.AccountRetrieveRecordingsJsonParams;
import com.telnyx.sdk.models.texml.accounts.AccountRetrieveRecordingsJsonResponse;
AccountRetrieveRecordingsJsonResponse response = client.texml().accounts().retrieveRecordingsJson("550e8400-e29b-41d4-a716-446655440000");
Returns: end (integer), first_page_uri (uri), next_page_uri (string), page (integer), page_size (integer), previous_page_uri (uri), recordings (array[object]), start (integer), uri (string)
Returns recording resource identified by recording id.
GET /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json
import com.telnyx.sdk.models.texml.accounts.TexmlGetCallRecordingResponseBody;
import com.telnyx.sdk.models.texml.accounts.recordings.json.JsonRetrieveRecordingSidJsonParams;
JsonRetrieveRecordingSidJsonParams params = JsonRetrieveRecordingSidJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.recordingSid("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
.build();
TexmlGetCallRecordingResponseBody texmlGetCallRecordingResponseBody = client.texml().accounts().recordings().json().retrieveRecordingSidJson(params);
Returns: account_sid (string), call_sid (string), channels (enum: 1, 2), conference_sid (uuid), date_created (date-time), date_updated (date-time), duration (string | null), error_code (string | null), media_url (uri), sid (string), source (enum: StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking), start_time (date-time), status (enum: in-progress, completed, paused, stopped), subresources_uris (object), uri (string)
Deletes recording resource identified by recording id.
DELETE /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json
import com.telnyx.sdk.models.texml.accounts.recordings.json.JsonDeleteRecordingSidJsonParams;
JsonDeleteRecordingSidJsonParams params = JsonDeleteRecordingSidJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.recordingSid("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
.build();
client.texml().accounts().recordings().json().deleteRecordingSidJson(params);
Returns multiple recording transcription resources for an account.
GET /texml/Accounts/{account_sid}/Transcriptions.json
import com.telnyx.sdk.models.texml.accounts.AccountRetrieveTranscriptionsJsonParams;
import com.telnyx.sdk.models.texml.accounts.AccountRetrieveTranscriptionsJsonResponse;
AccountRetrieveTranscriptionsJsonResponse response = client.texml().accounts().retrieveTranscriptionsJson("550e8400-e29b-41d4-a716-446655440000");
Returns: end (integer), first_page_uri (uri), next_page_uri (string), page (integer), page_size (integer), previous_page_uri (uri), start (integer), transcriptions (array[object]), uri (string)
Returns the recording transcription resource identified by its ID.
GET /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json
import com.telnyx.sdk.models.texml.accounts.transcriptions.json.JsonRetrieveRecordingTranscriptionSidJsonParams;
import com.telnyx.sdk.models.texml.accounts.transcriptions.json.JsonRetrieveRecordingTranscriptionSidJsonResponse;
JsonRetrieveRecordingTranscriptionSidJsonParams params = JsonRetrieveRecordingTranscriptionSidJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.recordingTranscriptionSid("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
.build();
JsonRetrieveRecordingTranscriptionSidJsonResponse response = client.texml().accounts().transcriptions().json().retrieveRecordingTranscriptionSidJson(params);
Returns: account_sid (string), api_version (string), call_sid (string), date_created (date-time), date_updated (date-time), duration (string | null), recording_sid (string), sid (string), status (enum: in-progress, completed), transcription_text (string), uri (string)
Permanently deletes a recording transcription.
DELETE /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json
import com.telnyx.sdk.models.texml.accounts.transcriptions.json.JsonDeleteRecordingTranscriptionSidJsonParams;
JsonDeleteRecordingTranscriptionSidJsonParams params = JsonDeleteRecordingTranscriptionSidJsonParams.builder()
.accountSid("550e8400-e29b-41d4-a716-446655440000")
.recordingTranscriptionSid("6a09cdc3-8948-47f0-aa62-74ac943d6c58")
.build();
client.texml().accounts().transcriptions().json().deleteRecordingTranscriptionSidJson(params);
Initiate an outbound AI call with warm-up support: Telnyx attempts to warm up the assistant identified by AIAssistantId before placing the call and starts it automatically when the called party answers.
POST /texml/ai_calls/{connection_id} — Required: From, To, AIAssistantId
Optional: AIAssistantDynamicVariables (object), AIAssistantVersion (string), AsyncAmd (boolean), AsyncAmdStatusCallback (string), AsyncAmdStatusCallbackMethod (enum: GET, POST), CallerId (string), ConversationCallback (string), ConversationCallbackMethod (enum: GET, POST), ConversationCallbacks (array[string]), CustomHeaders (array[object]), DetectionMode (enum: Premium, Regular, PremiumCallScreening), MachineDetection (enum: Enable, Disable, DetectMessageEnd), MachineDetectionBeepMaxFrequency (int32), MachineDetectionBeepMinFrequency (int32), MachineDetectionBeepMinToneDuration (int32), MachineDetectionBeepProfile (enum: both, freq_only), MachineDetectionBeepSpectralConfirmation (boolean), MachineDetectionBeepSpectralMinPurity (number), MachineDetectionBeepSpectralRejectFaxCng (boolean), MachineDetectionBeepSpectralWindow (int32), MachineDetectionPromptEndTimeout (integer), MachineDetectionSilenceTimeout (integer), MachineDetectionSpeechEndThreshold (integer), MachineDetectionSpeechThreshold (integer), MachineDetectionTimeout (integer), Passports (string), PreferredCodecs (string), Record (boolean), RecordingChannels (enum: mono, dual), RecordingStatusCallback (string), RecordingStatusCallbackEvent (string), RecordingStatusCallbackMethod (enum: GET, POST), RecordingTimeout (integer), RecordingTrack (enum: inbound, outbound, both), SendRecordingUrl (boolean), SipAuthPassword (string), SipAuthUsername (string), SipRegion (enum: US, Europe, Canada, Australia, Middle East), StatusCallback (string), StatusCallbackEvent (string), StatusCallbackMethod (enum: GET, POST), StatusCallbacks (array[string]), TimeLimit (integer), Timeout (integer), Trim (enum: trim-silence, do-not-trim)
import com.telnyx.sdk.models.texml.TexmlInitiateAiCallParams;
import com.telnyx.sdk.models.texml.TexmlInitiateAiCallResponse;
TexmlInitiateAiCallParams params = TexmlInitiateAiCallParams.builder()
.connectionId("550e8400-e29b-41d4-a716-446655440000")
.aiAssistantId("ai-assistant-id-123")
.from("+13120001234")
.to("+13121230000")
.build();
TexmlInitiateAiCallResponse response = client.texml().initiateAiCall(params);
Returns: call_sid (string), from (string), status (string), to (string)
Initiate an outbound TeXML call using a TeXML application connection ID, not an account SID. Request parameter names are case-sensitive. From and To are required; Texml supplies inline instructions and Url overrides the application XML request URL. When neither is supplied, the application configuration supplies the instructions. The response is a flat call object without a data wrapper.
POST /texml/calls/{connection_id} — Required: From, To
Optional: Method (enum: GET, POST), Texml (string), Url (string)
import com.telnyx.sdk.models.texml.calls.CallCreateParams;
CallCreateParams params = CallCreateParams.builder()
.From("+13120001234")
.To("+13121230000")
.build();
var response = client.texml().calls().create("connection_id", params);
Returns: call_sid (string), from (string), status (enum: queued), to (string)
Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to use your secret name, and this name will be replaced by the actual secret value when processing the TeXML on Telnyx side. The secrets are not visible in any logs.
POST /texml/secrets — Required: name, value
import com.telnyx.sdk.models.texml.TexmlSecretsParams;
import com.telnyx.sdk.models.texml.TexmlSecretsResponse;
TexmlSecretsParams params = TexmlSecretsParams.builder()
.name("My Secret Name")
.value("My Secret Value")
.build();
TexmlSecretsResponse response = client.texml().secrets(params);
Returns: name (string), value (enum: REDACTED)
Returns a list of your TeXML Applications.
GET /texml_applications
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationListPage;
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationListParams;
TexmlApplicationListPage page = client.texmlApplications().list();
Returns: active (boolean), anchorsite_override (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), call_cost_in_webhooks (boolean), created_at (string), dtmf_type (enum: RFC 2833, Inband, SIP INFO), first_command_timeout (boolean), first_command_timeout_secs (integer), friendly_name (string), id (string), inbound (object), outbound (object), record_type (string), status_callback (uri), status_callback_method (enum: get, post), tags (array[string]), updated_at (string), voice_fallback_url (uri), voice_method (enum: get, post), voice_url (uri)
Creates a TeXML application, which defines the voice URLs and settings used to serve TeXML instructions for calls, and returns the created application.
POST /texml_applications — Required: friendly_name, voice_url
Optional: active (boolean), anchorsite_override (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), call_cost_in_webhooks (boolean), dtmf_type (enum: RFC 2833, Inband, SIP INFO), first_command_timeout (boolean), first_command_timeout_secs (integer), inbound (object), outbound (object), status_callback (uri), status_callback_method (enum: get, post), tags (array[string]), voice_fallback_url (uri), voice_method (enum: get, post)
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationCreateParams;
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationCreateResponse;
TexmlApplicationCreateParams params = TexmlApplicationCreateParams.builder()
.friendlyName("call-router")
.voiceUrl("https://example.com")
.build();
TexmlApplicationCreateResponse texmlApplication = client.texmlApplications().create(params);
Returns: active (boolean), anchorsite_override (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), call_cost_in_webhooks (boolean), created_at (string), dtmf_type (enum: RFC 2833, Inband, SIP INFO), first_command_timeout (boolean), first_command_timeout_secs (integer), friendly_name (string), id (string), inbound (object), outbound (object), record_type (string), status_callback (uri), status_callback_method (enum: get, post), tags (array[string]), updated_at (string), voice_fallback_url (uri), voice_method (enum: get, post), voice_url (uri)
Retrieves the details of an existing TeXML Application.
GET /texml_applications/{id}
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationRetrieveParams;
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationRetrieveResponse;
TexmlApplicationRetrieveResponse texmlApplication = client.texmlApplications().retrieve("1293384261075731499");
Returns: active (boolean), anchorsite_override (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), call_cost_in_webhooks (boolean), created_at (string), dtmf_type (enum: RFC 2833, Inband, SIP INFO), first_command_timeout (boolean), first_command_timeout_secs (integer), friendly_name (string), id (string), inbound (object), outbound (object), record_type (string), status_callback (uri), status_callback_method (enum: get, post), tags (array[string]), updated_at (string), voice_fallback_url (uri), voice_method (enum: get, post), voice_url (uri)
Updates settings of an existing TeXML Application.
PATCH /texml_applications/{id} — Required: friendly_name, voice_url
Optional: active (boolean), anchorsite_override (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), call_cost_in_webhooks (boolean), dtmf_type (enum: RFC 2833, Inband, SIP INFO), first_command_timeout (boolean), first_command_timeout_secs (integer), inbound (object), outbound (object), status_callback (uri), status_callback_method (enum: get, post), tags (array[string]), voice_fallback_url (uri), voice_method (enum: get, post)
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationUpdateParams;
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationUpdateResponse;
TexmlApplicationUpdateParams params = TexmlApplicationUpdateParams.builder()
.id("1293384261075731499")
.friendlyName("call-router")
.voiceUrl("https://example.com")
.build();
TexmlApplicationUpdateResponse texmlApplication = client.texmlApplications().update(params);
Returns: active (boolean), anchorsite_override (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), call_cost_in_webhooks (boolean), created_at (string), dtmf_type (enum: RFC 2833, Inband, SIP INFO), first_command_timeout (boolean), first_command_timeout_secs (integer), friendly_name (string), id (string), inbound (object), outbound (object), record_type (string), status_callback (uri), status_callback_method (enum: get, post), tags (array[string]), updated_at (string), voice_fallback_url (uri), voice_method (enum: get, post), voice_url (uri)
Permanently deletes the specified TeXML application from your account.
DELETE /texml_applications/{id}
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationDeleteParams;
import com.telnyx.sdk.models.texmlapplications.TexmlApplicationDeleteResponse;
TexmlApplicationDeleteResponse texmlApplication = client.texmlApplications().delete("1293384261075731499");
Returns: active (boolean), anchorsite_override (enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany), call_cost_in_webhooks (boolean), created_at (string), dtmf_type (enum: RFC 2833, Inband, SIP INFO), first_command_timeout (boolean), first_command_timeout_secs (integer), friendly_name (string), id (string), inbound (object), outbound (object), record_type (string), status_callback (uri), status_callback_method (enum: get, post), tags (array[string]), updated_at (string), voice_fallback_url (uri), voice_method (enum: get, post), voice_url (uri)
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Test VoIP push notifications for Telnyx WebRTC iOS (APNs) and Android (FCM) apps. Use when debugging push notification delivery, validating certificate/credential setup, or testing that a device receives VoIP pushes correctly.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。