Telnyx Voice – Java

Installation

// See https://github.com/team-telnyx/telnyx-java for Maven/Gradle setup

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.

Answer call

Answer an incoming call.

POST /calls/{call_control_id}/actions/answer

Optional: billing_group_id (uuid), client_state (string), command_id (string), custom_headers (array[object]), preferred_codecs (enum), record (enum), record_channels (enum), record_custom_file_name (string), record_format (enum), record_max_length (int32), record_timeout_secs (int32), record_track (enum), record_trim (enum), send_silence_when_idle (boolean), sip_headers (array[object]), sound_modifications (object), stream_bidirectional_codec (enum), stream_bidirectional_mode (enum), stream_bidirectional_target_legs (enum), stream_codec (enum), stream_track (enum), stream_url (string), transcription (boolean), transcription_config (object), webhook_url (string), webhook_url_method (enum)

import com.telnyx.sdk.models.calls.actions.ActionAnswerParams;
import com.telnyx.sdk.models.calls.actions.ActionAnswerResponse;

ActionAnswerResponse response = client.calls().actions().answer("call_control_id");

Bridge calls

Bridge two call control calls.

POST /calls/{call_control_id}/actions/bridge — Required: call_control_id

Optional: client_state (string), command_id (string), mute_dtmf (enum), park_after_unbridge (string), play_ringtone (boolean), queue (string), record (enum), record_channels (enum), record_custom_file_name (string), record_format (enum), record_max_length (int32), record_timeout_secs (int32), record_track (enum), record_trim (enum), ringtone (enum), video_room_context (string), video_room_id (uuid)

import com.telnyx.sdk.models.calls.actions.ActionBridgeParams;
import com.telnyx.sdk.models.calls.actions.ActionBridgeResponse;

ActionBridgeParams params = ActionBridgeParams.builder()
    .callControlIdToBridge("call_control_id")
    .callControlId("v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg")
    .build();
ActionBridgeResponse response = client.calls().actions().bridge(params);

Dial

Dial a number or SIP URI from a given connection.

POST /calls — Required: connection_id, to, from

Optional: answering_machine_detection (enum), answering_machine_detection_config (object), audio_url (string), billing_group_id (uuid), bridge_intent (boolean), bridge_on_answer (boolean), client_state (string), command_id (string), conference_config (object), custom_headers (array[object]), dialogflow_config (object), enable_dialogflow (boolean), from_display_name (string), link_to (string), media_encryption (enum), media_name (string), park_after_unbridge (string), preferred_codecs (string), record (enum), record_channels (enum), record_custom_file_name (string), record_format (enum), record_max_length (int32), record_timeout_secs (int32), record_track (enum), record_trim (enum), send_silence_when_idle (boolean), sip_auth_password (string), sip_auth_username (string), sip_headers (array[object]), sip_region (enum), sip_transport_protocol (enum), sound_modifications (object), stream_auth_token (string), stream_bidirectional_codec (enum), stream_bidirectional_mode (enum), stream_bidirectional_sampling_rate (enum), stream_bidirectional_target_legs (enum), stream_codec (enum), stream_establish_before_call_originate (boolean), stream_track (enum), stream_url (string), supervise_call_control_id (string), supervisor_role (enum), time_limit_secs (int32), timeout_secs (int32), transcription (boolean), transcription_config (object), webhook_url (string), webhook_url_method (enum)

import com.telnyx.sdk.models.calls.CallDialParams;
import com.telnyx.sdk.models.calls.CallDialResponse;

CallDialParams params = CallDialParams.builder()
    .connectionId("7267xxxxxxxxxxxxxx")
    .from("+18005550101")
    .to("+18005550100")
    .build();
CallDialResponse response = client.calls().dial(params);

Hangup call

Hang up the call.

POST /calls/{call_control_id}/actions/hangup

Optional: client_state (string), command_id (string)

import com.telnyx.sdk.models.calls.actions.ActionHangupParams;
import com.telnyx.sdk.models.calls.actions.ActionHangupResponse;

ActionHangupResponse response = client.calls().actions().hangup("call_control_id");

Transfer call

Transfer a call to a new destination.

POST /calls/{call_control_id}/actions/transfer — Required: to

Optional: answering_machine_detection (enum), answering_machine_detection_config (object), audio_url (string), client_state (string), command_id (string), custom_headers (array[object]), early_media (boolean), from (string), from_display_name (string), media_encryption (enum), media_name (string), mute_dtmf (enum), park_after_unbridge (string), preferred_codecs (string), record (enum), record_channels (enum), record_custom_file_name (string), record_format (enum), record_max_length (int32), record_timeout_secs (int32), record_track (enum), record_trim (enum), sip_auth_password (string), sip_auth_username (string), sip_headers (array[object]), sip_region (enum), sip_transport_protocol (enum), sound_modifications (object), target_leg_client_state (string), time_limit_secs (int32), timeout_secs (int32), webhook_retries_policies (object), webhook_url (string), webhook_url_method (enum), webhook_urls (object), webhook_urls_method (enum)

import com.telnyx.sdk.models.calls.actions.ActionTransferParams;
import com.telnyx.sdk.models.calls.actions.ActionTransferResponse;

ActionTransferParams params = ActionTransferParams.builder()
    .callControlId("call_control_id")
    .to("+18005550100")
    .build();
ActionTransferResponse response = client.calls().actions().transfer(params);

List all active calls for given connection

Lists all active calls for given connection.

GET /connections/{connection_id}/active_calls

import com.telnyx.sdk.models.connections.ConnectionListActiveCallsPage;
import com.telnyx.sdk.models.connections.ConnectionListActiveCallsParams;

ConnectionListActiveCallsPage page = client.connections().listActiveCalls("1293384261075731461");

List call control applications

Return a list of call control applications.

GET /call_control_applications

import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationListPage;
import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationListParams;

CallControlApplicationListPage page = client.callControlApplications().list();

Create a call control application

Create a call control application.

POST /call_control_applications — Required: application_name, webhook_event_url

Optional: active (boolean), anchorsite_override (enum), call_cost_in_webhooks (boolean), dtmf_type (enum), first_command_timeout (boolean), first_command_timeout_secs (integer), inbound (object), outbound (object), redact_dtmf_debug_logging (boolean), webhook_api_version (enum), webhook_event_failover_url (url), webhook_timeout_secs ([‘integer’, ‘null’])

import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationCreateParams;
import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationCreateResponse;

CallControlApplicationCreateParams params = CallControlApplicationCreateParams.builder()
    .applicationName("call-router")
    .webhookEventUrl("https://example.com")
    .build();
CallControlApplicationCreateResponse callControlApplication = client.callControlApplications().create(params);

Retrieve a call control application

Retrieves the details of an existing call control application.

GET /call_control_applications/{id}

import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationRetrieveParams;
import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationRetrieveResponse;

CallControlApplicationRetrieveResponse callControlApplication = client.callControlApplications().retrieve("1293384261075731499");

Update a call control application

Updates settings of an existing call control application.

PATCH /call_control_applications/{id} — Required: application_name, webhook_event_url

Optional: active (boolean), anchorsite_override (enum), call_cost_in_webhooks (boolean), dtmf_type (enum), first_command_timeout (boolean), first_command_timeout_secs (integer), inbound (object), outbound (object), redact_dtmf_debug_logging (boolean), tags (array[string]), webhook_api_version (enum), webhook_event_failover_url (url), webhook_timeout_secs ([‘integer’, ‘null’])

import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationUpdateParams;
import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationUpdateResponse;

CallControlApplicationUpdateParams params = CallControlApplicationUpdateParams.builder()
    .id("1293384261075731499")
    .applicationName("call-router")
    .webhookEventUrl("https://example.com")
    .build();
CallControlApplicationUpdateResponse callControlApplication = client.callControlApplications().update(params);

Delete a call control application

Deletes a call control application.

DELETE /call_control_applications/{id}

import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationDeleteParams;
import com.telnyx.sdk.models.callcontrolapplications.CallControlApplicationDeleteResponse;

CallControlApplicationDeleteResponse callControlApplication = client.callControlApplications().delete("1293384261075731499");

List call events

Filters call events by given filter parameters.

GET /call_events

import com.telnyx.sdk.models.callevents.CallEventListPage;
import com.telnyx.sdk.models.callevents.CallEventListParams;

CallEventListPage page = client.callEvents().list();

Webhooks

The following webhook events are sent to your configured webhook URL. All webhooks include telnyx-timestamp and telnyx-signature-ed25519 headers for verification (Standard Webhooks compatible).

Webhook payload fields

callAnswered

callStreamingStarted

callStreamingStopped

callStreamingFailed

callBridged

callInitiated

callHangup

callRecordingSaved

callMachineDetectionEnded

callMachineGreetingEnded

callMachinePremiumDetectionEnded

callMachinePremiumGreetingEnded