Search for virtual number using the Java SDK

Use this guide to setup your Java application for use with the Numbers API and search for an available Sinch virtual number.

Set up your Java application

1. Create a new folder where you want to store your application. Open a command prompt or terminal to that location and execute the following command:
   Copy

   Copied

   gradle init

   This command starts up the process to create a new blank Java application. You can select the default options for most of the prompts, but ensure you select that you want to create an application.

   Note:

   This guide assumes you're using Gradle but if you want to use another Java build tool, we've provided installation instructions for the most popular ones below.

2. Open App.java in your favorite editor and copy/paste in the App.java sample found on this page. Remember to keep your own package com.

Now that you've set up your application file, you must install the SDK itself and populate the code sample with your corresponding information.

The easiest way to install the SDK is using the Maven central repository.

Installing the SDK

You can create your Java project using your favorite method. Once your project is created, you need to add the SDK as a dependency. Depending on if you are using Gradle or Maven, you can add the necessary dependencies in the following ways:

Gradle

...
repositories {
    ...
    mavenCentral()
    ...
}
...

dependencies {
    ...
    implementation 'com.sinch.sdk:sinch-sdk-java:+'
    ...
}
...

...
repositories {
    ...
    mavenLocal()
    ...
}
...

dependencies {
    ...
    implementation("com.sinch.sdk:sinch-sdk-java:+")
    ...
}
...

Maven

<dependency>
    <groupId>com.sinch.sdk</groupId>
    <artifactId>sinch-sdk-java</artifactId>
    <version>LATEST</version>
</dependency>

Modify your application

The code provided in App.java includes placeholder parameters. You'll need to update the parameters detailed in the following subsections with your values.

Initialize the client

Before initializing a client using this SDK, you'll need three pieces of information:

• Your Project ID
• An access key ID
• An access key Secret

To start using the SDK, you need to initialize the main client class and create a configuration object to connect to your Sinch account. You can find all of the credentials you need on your Sinch dashboard.

import com.sinch.sdk.SinchClient;
import com.sinch.sdk.models.Configuration;
import com.sinch.sdk.models.SMSRegion;

public class App {
    
    public static void main(String[] args) {
        SinchClient client = new SinchClient(Configuration.builder()
                                    .setKeyId("YOUR_access_key")
                                    .setKeySecret("YOUR_access_secret")
                                    .setProjectId("YOUR_project_id")
                                    .setSmsRegion(SMSRegion.US)
                                    .build());
    }
}

import com.sinch.sdk.SinchClient;
import com.sinch.sdk.models.Configuration;
import com.sinch.sdk.models.SMSRegion;

public class App {
    
    public static void main(String[] args) {
        SinchClient client = new SinchClient(Configuration.builder()
                                    .setKeyId("YOUR_access_key")
                                    .setKeySecret("YOUR_access_secret")
                                    .setProjectId("YOUR_project_id")
                                    .setSmsRegion(SMSRegion.EU)
                                    .build());
    }
}

Fill in remaining parameters

Replace the remaining placeholder values for these parameters with your values:

Save the file.

Search for an available virtual number

Now you can run the code with the following command:

gradle run

Response

These steps should return a list of numbers available to rent for the search criteria you specified.

Next steps

Additional resources

• You can also see how to rent the first available number.
• 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.