The Sinch Java SDK allows you to quickly interact with the Conversation API from inside your Java applications. When using the Java SDK, the code representing requests and queries sent to and responses received from the Conversation API are structured similarly to those that are sent and received using the Conversation 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 Conversation API, including any differences that may exist between the API itself and the SDK. For a full reference on Conversation API calls and responses, see the Conversation REST API Reference.
The code sample below is an example of how to use the Java SDK to send a text message on the SMS channel of a Conversation API app. We've also provided an example that accomplishes the same task using the REST API.
package conversation;
import com.sinch.sdk.domains.conversation.api.v1.ConversationService;
import com.sinch.sdk.domains.conversation.api.v1.MessagesService;
import com.sinch.sdk.domains.conversation.models.v1.*;
import com.sinch.sdk.domains.conversation.models.v1.messages.*;
import com.sinch.sdk.domains.conversation.models.v1.messages.request.*;
import com.sinch.sdk.domains.conversation.models.v1.messages.response.SendMessageResponse;
import com.sinch.sdk.domains.conversation.models.v1.messages.types.text.*;
import java.util.*;
import java.util.Collections;
import java.util.logging.Logger;
public class Snippet {
private static final Logger LOGGER = Logger.getLogger(Snippet.class.getName());
static void execute(ConversationService conversationService) {
MessagesService messagesService = conversationService.messages();
String appId = "YOUR_app_id";
String from = "YOUR_sms_sender";
String to = "RECIPIENT_number";
String body = "This is a test Conversation message using the Sinch Java SDK.";
String smsSender = "SMS_SENDER";
ChannelRecipientIdentities recipients =
ChannelRecipientIdentities.of(
ChannelRecipientIdentity.builder()
.setChannel(ConversationChannel.SMS)
.setIdentity(to)
.build());
AppMessage<TextMessage> message =
AppMessage.<TextMessage>builder()
.setBody(TextMessage.builder().setText(body).build())
.build();
SendMessageRequest<TextMessage> request =
SendMessageRequest.<TextMessage>builder()
.setAppId(appId)
.setRecipient(recipients)
.setMessage(message)
.setChannelProperties(Collections.singletonMap(smsSender, from))
.build();
LOGGER.info("Sending SMS Text using Conversation API");
SendMessageResponse value = messagesService.sendMessage(request);
LOGGER.info("Response: " + value);
}
}This example highlights the following required to successfully make a Conversation 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 successfully initialize the Sinch client class, you must provide a valid access key ID and access key secret combination. You must also provide your Project ID. For example:
package conversation.sdk;
import com.sinch.sdk.SinchClient;
public class App {
public static String access_key = "YOUR_access_key";
public static String access_secret = "YOUR_access_secret";
public static String project_id = "YOUR_project_id"
public static void main(String[] args) {
SinchClient client = new SinchClient(Configuration.builder()
.setKeyId(access_key)
.setKeySecret(access_secret)
.setProjectId(project_id)
.build());
}
The above sample defaults to the US region. If you want to specify the European region, you can use .setConversationRegion(ConversationRegion.EU). If you want to specify the Brazil region, you can use .setConversationRegion(ConversationRegion.BR). If you want to re-specify the US region, you can use setConversationRegion(ConversationRegion.US).
The Sinch Java SDK organizes different functionalities in the Sinch product suite into domains. These domains are accessible through the client. For example, client.conversation().v1().[endpoint_category()].[method()] or client.conversation().templates().[templates_version()].[method()].
In the Sinch Java SDK, Conversation API endpoints are accessible through the client (either a general client or a Conversation-specific client). The naming convention of the endpoint's representation in the SDK matches the API:
v1().messages()v1().app()v1().contact()v1().events()v1().transcoding()v1().capability()templates.v1().templates()templates.v2().templates()v1().webhooks()v1().conversation()
For example:
SendMessageResponse response =
client.conversation().v1().messages().sendMessage(SendMessageRequest.<TextMessage>builder()
.setAppId("YOUR_app_id")
.setRecipient(ChannelRecipientIdentities.of(ChannelRecipientIdentity.builder().setChannel(ConversationChannel.SMS).setIdentity("RECIPIENT_number").build()))
.setMessage(AppMessage.<TextMessage>builder().setBody(TextMessage.builder().setText("This is a test Conversation message using the Sinch Java SDK.").build()).build())
.setChannelProperties(Collections.singletonMap("SMS_SENDER", "YOUR_sms_sender"))
.build());The messages category of the Java SDK corresponds to the messages endpoint. The mapping between the API operations and corresponding methods are described below:
| API operation | SDK method |
|---|---|
| Send a message | sendMessage, or you could use any of the following message-specific methods: |
| sendCardMessage | |
| sendCarouselMessage | |
| sendChoiceMessage | |
| sendContactInfoMessage | |
| sendListMessage | |
| sendLocationMessage | |
| sendMediaMessage | |
| sendTemplateMessage | |
| sendTextMessage | |
| Get a message | get |
| Delete a message | delete |
| List messages | list |
| Update a message's metadata | update |
The app category of the Java SDK corresponds to the apps endpoint. The mapping between the API operations and corresponding methods are described below:
| API operation | SDK method |
|---|---|
| List all apps for a given project | list |
| Create an app | create |
| Get an app | get |
| Delete an app | delete |
| Update an app | update |
This class will help you define channel credentials when creating or updating an app. Each channel is represented by a corresponding method, and invoking that method will allows you to more easily determine the information that is required to create the credentials.
The contact category of the Java SDK corresponds to the contacts endpoint. The mapping between the API operations and corresponding methods are described below:
The conversations category of the Java SDK corresponds to the conversations endpoint. The mapping between the API operations and corresponding methods are described below:
The events category of the Java SDK corresponds to the events endpoint. The mapping between the API operations and corresponding methods are described below:
| API operation | SDK method |
|---|---|
| Send an event | send |
| Get an event | get |
| Delete an event | delete |
| List events | list |
The transcoding category of the Java SDK corresponds to the messages:transcode endpoint. The mapping between the API operations and corresponding methods are described below:
| API operation | SDK method |
|---|---|
| Transcode a message | transcodeMessage |
The capability category of the Java SDK corresponds to the capability endpoint. The mapping between the API operations and corresponding methods are described below:
| API operation | SDK method |
|---|---|
| Capability lookup | lookup |
The webhooks category of the Java SDK corresponds to the webhooks endpoint. The mapping between the API operations and corresponding methods are described below:
| API operation | SDK method |
|---|---|
| List webhooks | list |
| Create a new webhook | create |
| Get a webhook | get |
| Update an existing webhook | update |
| Delete an existing webhook | delete |
No corresponding operation. You can use this function to authenticate information received from payloads. This function takes the secret parameter, which is the Secret token to be used to validate the received request. | validateAuthenticationHeader |
No corresponding operation. You can use this function to deserialize payloads received from callbacks. This function takes the jsonPayload parameter, which is the received payload. | parseEvent |
The templates (version 1) category of the Java SDK corresponds to the Templates endpoint. The mapping between the API operations and corresponding methods are described below:
| API operation | SDK method |
|---|---|
| List all templates belonging to a project ID | list |
| Creates a template | create |
| Updates a template | update |
| Get a template | get |
| Delete a template | delete |
The templates (version 2) category of the Java SDK corresponds to the Templates-V2 endpoint. The mapping between the API operations and corresponding methods are described below:
Requests and queries made using the Java SDK are similar to those made using the Conversation API. Many of the fields are named and structured similarly. For example, consider the representation of a Conversation API channel. One field is represented in our Java SDK, and the other is using the REST API:
ConversationChannel.SMSNote that the fields have similar names, and many fields in the Java SDK are rendered as enums in data models.
Additionally, path parameters, request body parameters, and query parameters that are used in the API are all passed as arguments to the corresponding method. For example, consider this example in which the get method of messages is invoked:
var response = client.conversation().v1().messages().get("YOUR_message_id", "CONVERSATION_SOURCE");
When using the Conversation API, message_id would be included as a path parameter, and messages_source would be included as a query parameter in the JSON payload. With the Java SDK, both parameters are included as arguments in the get method.
Response fields match the API responses. They are delivered as Java objects.