Rent the first available number using the Java SDK

Use this guide to setup your Java application for use with the Numbers API and rent the first available Sinch virtual number and assign it to your SMS service plan.

Note:

Before you can get started, you need the following already set up:

All Numbers API prerequisite steps.
JDK 8 or later and a familiarity with how to create a new Java application.
Apache Maven and a familiarity with how to use the Maven CLI.

Steps:

Set up your Java application
Rent the first available virtual number for SMS, Voice or both.

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/java/numbers/ folder and open the Snippet.java file. Replace the existing content within that file with the Snippet.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 default and placeholder parameters. Replace the following following values for these parameters with your own values:

Parameter	Your value
`YOUR_region_code`	The two letter abbreviation of the country for which you'd like a number. For example, the United States is `US`. Should be in ISO 3166-1 alpha-2 format.
`YOUR_service_plan_id`	Your SMS service plan ID. This is required for SMS configuration.

If you want, you can change the values of these enums to their other options:

Parameter	Your value
`Capability.SMS`	The capability of the number you would like to rent. Available options are `SMS` and `VOICE`.
`NumberType.LOCAL`	The type of number you would like to rent. Available options are: `MOBILE`, `LOCAL`, or `TOLL_FREE`. Note that 10DLC numbers should be set to `LOCAL`. For more information, see the JavaDocs.

Save the 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 the sinch-sdk-java-quickstart/templates/client folder and run the following command:

Copy

Copied

mvn package

This command creates the target folder and application.

Rent the first available virtual number

Now you can run the code with the following command:

Copy

Copied

java -jar target/sinch-java-sdk-client-application-1.0-SNAPSHOT-jar-with-dependencies.jar

This code will rent the first available number that fits the search criteria you specified and assign (or provision) it to your SMS service plan ID. You'll see the response in the console.

Next steps

Send a message to yourself using the SMS API to verify that the configuration was successful.

Send an SMS message.

Additional resources

Explore the API specification to test more endpoints.
Prefer a UI to search for a number? Follow the entire number searching and renting process in the Customer Dashboard.