The Sinch Java SDK allows you to quickly interact with the Voice API from inside your Java applications. When using the Java SDK, the code representing requests and queries sent to and responses received from the Voice API are structured similarly to those that are sent and received using the Voice API.
The fastest way to get started with the SDK is to check out our getting started guides. There you'll find all the instructions necessary to download, install, set up, and start using the SDK.
You can also view the generated JavaDocs for the Java SDK here.
This guide describes the syntactical structure of the Java SDK for the Voice API, including any differences that may exist between the API itself and the SDK. For a full reference on Voice API calls and responses, see the Voice API Reference.
The code sample below is an example of how to use the Java SDK to make a text to speech phone call to phone number using the Java SDK and the Voice API. We've also provided an example that accomplishes the same task using the REST API.
package voice;
import com.sinch.sdk.domains.voice.api.v1.CalloutsService;
import com.sinch.sdk.domains.voice.api.v1.VoiceService;
import com.sinch.sdk.domains.voice.models.v1.callouts.request.CalloutRequestTTS;
import com.sinch.sdk.domains.voice.models.v1.destination.DestinationPstn;
import java.util.logging.Logger;
public class Snippet {
private static final Logger LOGGER = Logger.getLogger(Snippet.class.getName());
public static String execute(VoiceService voiceService) {
CalloutsService calloutsService = voiceService.callouts();
String phoneNumber = "YOUR_phone_number";
String message = "Hello, this is a call from Sinch. Congratulations! You made your first call.";
LOGGER.info("Calling '" + phoneNumber + '"');
CalloutRequestTTS parameters =
CalloutRequestTTS.builder()
.setDestination(DestinationPstn.from(phoneNumber))
.setText(message)
.build();
String callId = calloutsService.textToSpeech(parameters);
LOGGER.info("Call started with id: '" + callId + '"');
return callId;
}
}This example highlights the following required to successfully make a Voice API call using the Sinch Java SDK:
When using the Sinch Java SDK, you initialize communication with the Sinch backend by initializing the Java SDK's main client class. This client allows you to access the functionality of the Sinch Java SDK.
To start using the SDK, you need to initialize the main client class and create a configuration object to connect to your Sinch account and Voice app. You can find all of the credentials you need on your Sinch dashboard.
import com.sinch.sdk.SinchClient;
import com.sinch.sdk.models.Configuration;
public class App {
public static void main(String[] args) {
SinchClient client = new SinchClient(Configuration.builder()
.setApplicationKey("YOUR_application_key")
.setApplicationSecret("YOUR_application_secret")
.build());
}
}For testing purposes on your local environment it's fine to use hardcoded values, but before deploying to production we strongly recommend using environment variables to store the credentials.
The Sinch Java SDK organizes different functionalities in the Sinch product suite into domains. These domains are accessible through the client. For example, client.voice().[endpoint_category()].[method()].
In the Sinch Java SDK, Voice API endpoints are accessible through the client. The naming convention of the endpoint's representation in the SDK matches the API:
voice().callouts()voice().calls()voice().conferences()voice().applications()
For example:
var response = client.voice()
.callouts()
.textToSpeech(CalloutRequestParametersTTS
.builder()
.setDestination(DestinationNumber.valueOf("YOUR_phone_number"))
.setText("Thank you for calling Sinch. This call will now end.")
.build());The voice().callouts() category of the Java SDK corresponds corresponds to the callouts endpoint. The mapping between the API operations and corresponding Java methods are described below:
| API operation | SDK method | JavaDocs entry |
|---|---|---|
| Makes a Text-to-speech callout | textToSpeech() | textToSpeech |
| Makes a Conference callout | conference() | conference |
| Makes a Custom callout | Custom() | custom |
The voice().calls() category of the Java SDK corresponds corresponds to the calls endpoint. The mapping between the API operations and corresponding Java methods are described below:
| API operation | SDK method | JavaDocs entry |
|---|---|---|
| Get information about a call | get() | get |
Manage call with callLeg | manageWithCallLeg() | manageWithCallLeg |
| Updates a call in progress | update() | update |
The voice().conferences() category of the Java SDK corresponds corresponds to the conferences endpoint. The mapping between the API operations and corresponding Java methods are described below:
| API operation | SDK method | JavaDocs entry |
|---|---|---|
| Makes a conference callout | call() | call |
| Get information about a conference | get() | get |
| Manage a conference participant | manageParticipant() | manageParticipant |
| Remove a participant from a conference | kickParticipant() | kickParticipant |
| Remove all participants from a conference | kickAll() | kickAll |
The voice().applications() category of the Java SDK corresponds corresponds to the configuration endpoint. The mapping between the API operations and corresponding Java methods are described below:
| API operation | SDK method | JavaDocs entry |
|---|---|---|
| Return all the numbers assigned to an application | listNumbers() | listNumbers |
| Assign a number or list of numbers to an application | assignNumbers() | assignNumbers |
| Unassign a number from an application | unassignNumber() | unassignNumber |
| Return the callback URLs for an application | getCallbackUrls() | getCallbackUrls |
| Update the callback URL for an application | updateCallbackUrls() | updateCallbackUrls |
| Returns information about a number | queryNumber() | queryNumber |
The voice().webhooks() category of the Java SDK are helper methods designed to assist in serializing/deserializing requests from and responses to the Sinch servers, as well as validate that the requests coming from the Sinch servers are authentic.
| SDK method | Description | JavaDocs entry |
|---|---|---|
validateAuthenticatedRequest() | Validates if the request is authentic. It is a best practice to evaluate if a request is authentic before performing any business logic on it. | validateAuthenticatedRequest |
serializeVerificationResponse() | Serializes a SVAMLControl response into a JSON string. You must serialize the response before returning it because the Sinch servers expect a JSON response. | serializeWebhooksResponse |
unserializeVerificationEvent() | Deserializes a JSON response into a Voice event class. You can use this method to handle different event types and write logic for different events. | unserializeWebhooksEvent |
Requests and queries made using the Java SDK are similar to those made using the Voice API. Many of the fields are named and structured similarly.
Many fields in the Java SDK are rendered as enums in data models.
When making calls directly to the API, we use JSON objects, including (in some cases) nested JSON objects. When using the Java SDK, we use Java data models instead of nested JSON objects. For example, consider the Voice configuration objects below. One is represented in JSON, the other as a Java object:
CalloutRequestParametersTTS.builder()
.setDestination(DestinationNumber.valueOf("YOUR_phone_number"))
.setText("Thank you for calling Sinch. This call will now end.")
.build()Note that in the Java SDK you would use a specific helper class for the type of Voice call you want to make and a builder() method to construct the appropriate data model in the correct structure.
Response fields match the API responses. They are delivered as Java objects.