# Sinch Java SDK for Numbers

The Sinch Java SDK allows you to quickly interact with the  from inside your Java applications. When using the Java SDK, the code representing requests and queries sent to and responses received from the  are structured similarly to those that are sent and received using the .

The fastest way to get started with the SDK is to check out our [getting started](/docs/numbers/getting-started/java-sdk/searchavailable) guides. There you'll find all the instructions necessary to download, install, set up, and start using the SDK.

## Syntax

Note:
You can also view the generated JavaDocs for the Java SDK [here](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/package-summary.html).

Note:
This guide describes the syntactical structure of the Java SDK for the Numbers API, including any differences that may exist between the API itself and the SDK. For a full reference on Numbers API calls and responses, see the [Numbers API Reference](/docs/numbers/api-reference/numbers).

This code sample is an example of how to use the Java SDK to list the available numbers of a given type and region. We've also provided an example that accomplishes the same task using the REST API.

SDK
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)));
  }
}

REST API

```java

import java.net.*;
import java.net.http.*;
import java.util.*;

public class App {
  public static void main(String[] args) throws Exception {
    var httpClient = HttpClient.newBuilder().build();

    var host = "https://numbers.api.sinch.com";
    var projectId = "YOUR_projectId";
    var pathname = "/v1/projects/" + projectId + "/availableNumbers";
    var request = HttpRequest.newBuilder()
      .GET()
      .uri(URI.create(host + pathname ))
      .header("Authorization", "Basic " + Base64.getEncoder().encodeToString(("YOUR_username:YOUR_password").getBytes()))
      .build();

    var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());

    System.out.println(response.body());
  }
}
```

## Client

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.

### Initialization

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:


```java

package numbers.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());
}
```

## Numbers domain

The Sinch Java SDK organizes different functionalities in the Sinch product suite into domains. These domains are accessible through the client. For example, `client.numbers().v1().[endpoint_category()].[method()]`.

In the Sinch Java SDK, Numbers API endpoints are accessible through the client:

- `numbers().v1()`
- `numbers().v1().regions()`
- `numbers().v1().callbackConfiguration()`
- `numbers().v1().webhooks()`


For example:


```java
var numbers = client.numbers().v1().list(AvailableNumberListRequest.builder()
                                                                .setType(NumberType.LOCAL)
                                                                .setRegionCode("US")
                                                                .build());
```

The field mappings are described in the sections below.

The `numbers().v1()` category of the Java SDK has methods that correspond to the [available](/docs/numbers/api-reference/numbers/available-number/) and [active](/docs/numbers/api-reference/numbers/active-number/) endpoints. The mapping between the API operations and corresponding Java methods are described below, as well as links to the JavaDocs page:

| API operation | SDK method | JavaDocs |
|  --- | --- | --- |
| [Activate a new phone number](/docs/numbers/api-reference/numbers/available-number/numberservice_rentnumber) | `rent()` | [rent](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#rent(java.lang.String,com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberRentRequest)) |
| [Search for available phone numbers](/docs/numbers/api-reference/numbers/available-number/numberservice_listavailablenumbers) | `searchForAvailableNumbers()` | [searchForAvailableNumbers](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#searchForAvailableNumbers(com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberListRequest)) |
| [Check availability of a specific number](/docs/numbers/api-reference/numbers/available-number/numberservice_getavailablenumber) | `checkAvailability()` | [checkAvailability](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#checkAvailability(java.lang.String)) |
| [Rent any available number](/docs/numbers/api-reference/numbers/available-number/numberservice_rentanynumber) | `rentAny()` | [rentAny](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#rentAny(com.sinch.sdk.domains.numbers.models.v1.request.AvailableNumberRentAnyRequest)) |
| [List active numbers for a project](/docs/numbers/api-reference/numbers/active-number/numberservice_listactivenumbers) | `list()` | [list](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#list(com.sinch.sdk.domains.numbers.models.v1.request.ActiveNumberListRequest)) |
| [Update active number](/docs/numbers/api-reference/numbers/active-number/numberservice_updateactivenumber) | `update()` | [update](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#update(java.lang.String,com.sinch.sdk.domains.numbers.models.v1.request.ActiveNumberUpdateRequest)) |
| [Retrieve active number](/docs/numbers/api-reference/numbers/active-number/numberservice_getactivenumber) | `get()` | [get](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#get(java.lang.String)) |
| [Release active number](/docs/numbers/api-reference/numbers/active-number/numberservice_releasenumber) | `release()` | [release](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/NumbersService.html#release(java.lang.String)) |


The `numbers().v1().regions()` category of the Java SDK corresponds to the [availableRegions](/docs/numbers/api-reference/numbers/available-regions/) endpoint. The mapping between the API operation and corresponding Java method are described below, as well as links to the JavaDocs page:

| API operation | SDK method | JavaDocs |
|  --- | --- | --- |
| [List available regions](/docs/numbers/api-reference/numbers/available-regions/) | `list()` | [list](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/AvailableRegionService.html#list(com.sinch.sdk.domains.numbers.models.v1.regions.available.request.AvailableRegionListRequest)) |


The `numbers().v1().callbackConfiguration()` category of the Java SDK corresponds to the [callbackConfiguration](/docs/numbers/api-reference/numbers/numbers-callbacks/) endpoint. The mapping between the API operations and corresponding Java methods are described below, as well as links to the JavaDocs page:

| API operation | SDK method | JavaDocs |
|  --- | --- | --- |
| [Get callbacks configuration](/docs/numbers/api-reference/numbers/numbers-callbacks/getcallbackconfiguration) | `get()` | [get](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/CallbackConfigurationService.html#get()) |
| [Update callback configuration](/docs/numbers/api-reference/numbers/numbers-callbacks/updatecallbackconfiguration) | `update()` | [update](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/CallbackConfigurationService.html#update(com.sinch.sdk.domains.numbers.models.v1.callbacks.request.CallbackConfigurationUpdateRequest)) |


The `numbers().v1().webhooks()` category of the Java SDK corresponds to the [Event notification](/docs/numbers/api-reference/numbers/numbers-callbacks/importednumberservice_eventscallback) operation. The mapping between the API operation and corresponding Java method are described below, as well as links to the JavaDocs page:

| API operation | SDK method | JavaDocs |
|  --- | --- | --- |
| [Event notification](/docs/numbers/api-reference/numbers/numbers-callbacks/importednumberservice_eventscallback) | `parseEvent()` | [parseEvent](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/latest/com/sinch/sdk/domains/numbers/api/v1/WebHooksService.html#parseEvent(java.lang.String)) |


Requests and queries made using the Java SDK are similar to those made using the SMS API. Many of the fields are named and structured similarly. For example, consider the representations of an SMS API message type. One field is represented in JSON, and the other is using our Java SDK:

SDK

```java
NumberType.MOBILE
```

REST API

```JSON
"type": "MOBILE"
```

Many fields in the Java SDK are rendered as enums in data models.

When making calls directly to the API, we use JSON objects, including (in some cases) nested JSON objects. When using the Java SDK, we use Java data models instead of nested JSON objects. For example, consider the SMS configuration objects below. One is represented in JSON, the other as a Java object:


```Java
AvailableNumberListRequest.builder()
                        .setType(NumberType.LOCAL)
                        .setRegionCode("US")
                        .build()
```


```JSON
{
  "type": "LOCAL",
  "regionCode": "US"
}
```

Note that in the Java SDK you would use a `builder()` method to construct the appropriate data model in the correct structure.

Response fields match the API responses. They are delivered as Java objects.