Skip to content
Numbers/Getting started/
/
Search available
Last updated

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.

Note:

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

Steps:
  1. Set up your Java application
  2. Search for an 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:

  1. If you haven't already, clone the sinch-sdk-java-quickstart repository.
  2. Navigate to the sinch-sdk-java-quickstart/getting-started/numbers/search-available/client/src/main/resources folder.
  3. Open the config.properties file. Using the access key credentials from your Sinch Build Dashboard, populate the following fields with your values:
FieldDescription
SINCH_PROJECT_IDThe unique ID of your Project.
SINCH_KEY_IDThe unique ID of your access key.
SINCH_KEY_SECRETThe secret that goes with your access key.
Note: For security reasons, this secret is only visible right after access key creation.
  1. Save the file.

Modify your application

  1. Navigate to the getting-started/numbers/search-available/client/src/main/java/numbers folder and open the Snippet.java file.
Snippet.java
// This code returns a list of all the available numbers for a given set of search criteria. 
package numbers;

import com.sinch.sdk.domains.numbers.api.v1.NumbersService;
import com.sinch.sdk.domains.numbers.models.v1.NumberType;
import com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberListRequest;
import com.sinch.sdk.domains.numbers.models.v1.response.AvailableNumberListResponse;
import java.util.logging.Logger;

public class Snippet {

  private static final Logger LOGGER = Logger.getLogger(Snippet.class.getName());

  static void execute(NumbersService numbersService) {

    String regionCode = "US";
    NumberType type = NumberType.LOCAL;

    AvailableNumberListRequest parameters =
        AvailableNumberListRequest.builder().setRegionCode(regionCode).setType(type).build();

    LOGGER.info(
        String.format("Listing available number type '%s' for region '%s'", type, regionCode));

    AvailableNumberListResponse response = numbersService.searchForAvailableNumbers(parameters);

    response
        .iterator()
        .forEachRemaining(
            number -> LOGGER.info(String.format("Available number details: %s", number)));
  }
}
  1. The code provided in Snippet.java includes default parameters. If you want, you can replace the following values for these parameters with your own values:
ParameterYour value
regionCodeThe 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.
NumberType.LOCALThe 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.
  1. 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/getting-started/numbers/search-available/client folder and run the following command:

mvn package

This command creates the target folder and application.

Search for an available virtual number

Now you can run the code with the following command:

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

Response

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

Next steps

Copy the phoneNumber you would like to use and rent your virtual number using the Numbers API.

Additional resources

Previous page
Next page