Send an SMS Message with the Sinch Java SDK
Note:
Before you can get started, you need the following already set up:
- Set all SMS API configuration settings.
- JDK 21 or later and a familiarity with how to create a new Java application. (The SDK itself only requires JDK 8 or later, but this quickstart guide uses JDK 21 as it is the latest version with long term support.)
- Apache Maven and a familiarity with how to use the Maven CLI.
Learn how to quickly send SMS messages in a Java application with the Sinch API.
Set up your Java application
To quickly get started setting up a simple client application using the Java SDK:
- If you haven't already, clone the sinch-sdk-java-quickstart repository.
- Navigate to the
templates/client/src/main/resources
folder. - Open the
config.properties
file. Using the access key credentials from your Sinch Customer Dashboard, populate the following fields with your values:
Field | Description |
---|---|
SINCH_PROJECT_ID | The unique ID of your Project. |
SINCH_KEY_ID | The unique ID of your access key. |
SINCH_KEY_SECRET | The secret that goes with your access key. Note: For security reasons, this secret is only visible right after access key creation. |
- Save the file.
Modify your application
- Navigate to the
/templates/client/src/main/sms/
folder and open theSnippet.java
file. Replace the existing content within that file with theSnippet.java
code provided on this page. That code is also found here if you want to just replace the file.
- The code provided in Snippet.java includes placeholder parameters. Replace the following placeholder values for these parameters with your values:
Parameter | Your value |
---|---|
YOUR_Sinch_phone_number | Any number you've assigned to your Sinch account. Find the number on your Sinch dashboard by clicking the service plan ID link and scrolling to the bottom of the page. |
YOUR_recipient_phone_number | The phone number to which you want to send the test SMS message. |
- Save your file.
Package the application
Now that you've modified the application, you need to use the Maven CLI to create a package that you can then execute. Open a command prompt or terminal to thesinch-sdk-java-quickstart/templates/client
folder and run the following command:mvn package
target
folder and application.Send your first SMS message
Now that your package is ready, you can send a text message to your mobile phone. To send the message, run the following code:
java -jar target/sinch-java-sdk-client-application-1.0-SNAPSHOT-jar-with-dependencies.jar
The console will display the response details received from the Sinch servers and you should receive an SMS message to the number you specified.
Next steps
The code used in your Java application sends a POST request to the Sinch API/batches
endpoint to send the SMS message. Click here to read more about the batches endpoint.Additional resources
- Explore the API specification to test more endpoints.