vonage-java-sdk - GitLite

KO | EN

gitlite — search

#react #typescript #llm #golang #go #android #rust #deep-learning #linux #nodejs #awesome #vue #ios #openai

vonage-java-sdk

(★ 102)

Vonage Server SDK for Java. API support for SMS, Messages, Voice, Text-to-Speech, Numbers, Verify (2FA), Video and more.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
- - build.yml
  - codeql.yml
  - publish.yml
  - scorecard.yml
- CODEOWNERS
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- renovate.json
.gitallowed
.gitattributes
.gitignore
.whitesource
bumpversion.sh
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
CONTRIBUTORS.md
LICENSE.txt
pom.xml
README.md
SECURITY.md

# Installation Guide

1. Get the code

git clone https://github.com/Vonage/vonage-java-sdk

Downloads the entire project code from GitHub to your computer.

cd vonage-java-sdk

Moves into the project folder you just downloaded.

2. Maven (Java)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java projects.
Maven The build tool used for the mvn command.

mvn install -P uberjar

Installs dependencies and builds the project using Maven.

✅ A BUILD SUCCESS message means it worked. The output is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Vonage Server SDK for Java

![Java](https://img.shields.io/badge/java-8%2B-red)
[![Version](https://img.shields.io/maven-central/v/com.vonage/server-sdk)](https://central.sonatype.com/artifact/com.vonage/server-sdk)
[![Build Status](https://github.com/Vonage/vonage-java-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/Vonage/vonage-java-sdk/actions/workflows/build.yml)
![CodeQL](https://github.com/Vonage/vonage-java-sdk/actions/workflows/codeql.yml/badge.svg)
[![codecov](https://codecov.io/gh/vonage/vonage-java-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/vonage/vonage-java-sdk)
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Vonage/vonage-java-sdk/badge)](https://scorecard.dev/viewer/?uri=github.com/Vonage/vonage-java-sdk)
![SLOC](https://sloc.xyz/github/vonage/vonage-java-sdk)
[![Snyk](https://snyk.io/test/github/vonage/vonage-java-sdk/badge.svg)](https://snyk.io/test/github/vonage/vonage-java-sdk)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://raw.githubusercontent.com/Vonage/vonage-java-sdk/main/CODE_OF_CONDUCT.md)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://raw.githubusercontent.com/Vonage/vonage-java-sdk/main/LICENSE.txt)
[![Pulse](https://img.shields.io/github/commit-activity/m/vonage/vonage-java-sdk)](https://github.com/vonage/vonage-java-sdk/pulse)

<img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" />

This Java SDK allows you to use [Vonage APIs](https://developer.vonage.com/api) in any JVM-based application.
You'll need to have [created a Vonage account](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=java-client-library).

* [Supported APIs](#supported-apis)
* [Other SDKs](#other-sdks)
* [Installation](#installation)
* [Usage](#usage)
* [Configuration](#configuration)
* [FAQ](#frequently-asked-questions)
* [Contribute!](#contribute)

## Supported APIs

- [Account](https://developer.vonage.com/en/account/overview)
- [Application](https://developer.vonage.com/en/application/overview)
- [Conversation](https://developer.vonage.com/conversation/overview)
- [Conversion](https://developer.vonage.com/messaging/conversion-api/overview)
- [Messages](https://developer.vonage.com/en/messages/overview)
- [Number Insight](https://developer.vonage.com/en/number-insight/overview)
- [Number Management](https://developer.vonage.com/en/numbers/overview)
- [Number Verification](https://developer.vonage.com/en/number-verification/overview)
- [Redact](https://developer.vonage.com/en/redact/overview)
- [SIM Swap](https://developer.vonage.com/en/sim-swap/overview)
- [SMS](https://developer.vonage.com/en/messaging/sms/overview)
- [Subaccounts](https://developer.vonage.com/en/account/subaccounts/overview)
- [Verify](https://developer.vonage.com/en/verify/overview)
- [Video](https://developer.vonage.com/en/video/overview)
- [Voice](https://developer.vonage.com/en/voice/overview)

## Other SDKs

We also provide server SDKs in other languages:

- [Kotlin](https://github.com/Vonage/vonage-kotlin-sdk)
- [.NET](https://github.com/Vonage/vonage-dotnet-sdk)
- [PHP](https://github.com/Vonage/vonage-php-sdk)
- [Python](https://github.com/Vonage/vonage-python-sdk)
- [Ruby](https://github.com/Vonage/vonage-ruby-sdk)
- [NodeJS](https://github.com/Vonage/vonage-node-sdk)

We also offer [client-side SDKs](https://developer.vonage.com/en/vonage-client-sdk/overview) for iOS, Android and JavaScript.
See all of our SDKs and integrations on the [Vonage Developer portal](https://developer.vonage.com/en/tools).

## Installation

Releases are published to [Maven Central](https://central.sonatype.com/artifact/com.vonage/server-sdk).
Instructions for your build system can be found in the snippets section.
We *strongly recommend* that you use a tool that supports dependency management,
such as [Maven](https://maven.apache.org/), [Gradle](https://gradle.org/) or [Ivy](http://ant.apache.org/ivy/).

Release notes for each version can be found in the [changelog](CHANGELOG.md).

> [!WARNING]
> **Java 8 Deprecation Notice**
> 
> Version 9.x is the last major version to support Java 8. Support ends on **June 30, 2026**.
> Future versions (10.0+) will require **Java 11 or later**.
> 
> If you are running Java 8, you will see a warning message in your logs when initializing the SDK.
> Please plan to upgrade your Java runtime, or pin your SDK version to 9.x.

Here are the instructions for including the SDK in your project:

### Gradle
Add the following to your `build.gradle` or `build.gradle.kts` file:

```groovy
dependencies {
    implementation("com.vonage:server-sdk:9.13.0")
}
```

### Maven
Add the following to the `<dependencies>` section of your `pom.xml` file:

```xml
<dependency>
    <groupId>com.vonage</groupId>
    <artifactId>server-sdk</artifactId>
    <version>9.13.0</version>
</dependency>
```

### Build It Yourself

Alternatively you can clone the repo and build the JAR file yourself:

```bash
git clone git@github.com:vonage/vonage-java-sdk.git
mvn install -P uberjar
```

The `uberjar` profile will create a JAR file with all dependencies required to run the SDK included,
which can be found in the `target` directory. The `install` goal will make the SDK and its dependencies
available in your local Maven repository (usually located under your `~/.m2` directory), which can then
be used from other projects locally on your machine. To use this in a Gradle project, you need to include
the dependency co-ordinates and add `mavenLocal()` to the `repositories` block in your `build.gradle` file.

## Usage

* For help understanding our APIs, check out our awesome [developer portal](https://developer.vonage.com/).
* Check the [Javadoc](https://www.javadoc.io/doc/com.vonage/server-sdk/latest/index.html) for full reference documentation.
* There are also **many useful code samples** in our [Vonage/vonage-java-code-snippets](https://github.com/Vonage/vonage-java-code-snippets) repository.
* For a searchable list of code snippets examples, see [**SNIPPETS.md**](https://github.com/Vonage/vonage-java-code-snippets/blob/main/SNIPPETS.md).
* For Video API usage instructions, see [the guide on our developer portal](https://developer.vonage.com/en/video/server-sdks/java).

### Error Handling

When an API error occurs, the SDK will throw a `VonageApiResponseException` (or a subclass thereof). This exception
contains structured information about the error, including the HTTP status code, error title, and detail message.

Starting with version 9.10.0, you can also access the raw HTTP request and response bodies for debugging purposes:

```java
try {
    client.getMessagesClient().sendMessage(messageRequest);
} catch (MessageResponseException ex) {
    System.err.println("Status: " + ex.getStatusCode());
    System.err.println("Title: " + ex.getTitle());
    System.err.println("Detail: " + ex.getDetail());
    
    // Access raw request/response for debugging
    System.err.println("Raw Request: " + ex.getRawRequest());
    System.err.println("Raw Response: " + ex.getRawResponse());
}
```

This is particularly useful when troubleshooting API issues or working with Vonage support, as it allows you to see
the exact JSON that was sent and received.

### Custom Requests
Beginning with v9.1.0, you can now make customisable requests to any Vonage API endpoint using the `CustomClient` class,
obtained from the `VonageClient#getCustomClient()` method. This will take care of auth and serialisation for you.
You can use existing data models from the SDK or create your own by extending `com.vonage.client.JsonableBaseObject`
or implementing the `com.vonage.client.Jsonable` interface. For example, you can check your account balance using
the following code, which will send a `get` request to the specified URL and return a `BalanceResponse` object:

```java
BalanceResponse response = client.getCustomClient().get("https://rest.nexmo.com/account/get-balance");
```

You can also parse the response into a `Map<String, ?>` which represents the JSON response body as a tree like so:

```java
Map<String, ?> response = client.getCustomClient().get("https://api-eu.vonage.com/v3/media?order=ascending&page_size=50");
```

The same applies for `POST`, `PUT` and `PATCH` requests when sending data.
You can mix and match between `java.util.Map` and `com.vonage.client.Jsonable` interfaces for request and response bodies.
For example, to create an application, you can use any of the following (all are equivalent):

#### Map request, Map response
```java
Map<String, ?> response = client.getCustomClient().post(
        "https://api.nexmo.com/v2/applications",
        Map.of("name", "Demo Application")
);
```

#### Map request, Jsonable response
```java
Application response = client.getCustomClient().post(
        "https://api.nexmo.com/v2/applications",
        Map.of("name", "Demo Application")
);
```

#### Jsonable request, Map response
```java
Map<String, ?> response = client.getCustomClient().post(
        "https://api.nexmo.com/v2/applications",
        Application.builder().name("Demo Application").build()
);
```

#### Jsonable request, Jsonable response
```java
Application response = client.getCustomClient().post(
        "https://api.nexmo.com/v2/applications",
        Application.builder().name("Demo Application").build()
);
```

#### Supported response types
The `<R>` parameter in the response type methods does not have to be a `Map<String, ?>` or `Jsonable`; it can also
be a `String`, `byte[]` (for binary types) or `Collection` (for JSON arrays). The following will work, for example:

```java
String response = client.getCustomClient().get("https://example.com");
```

#### Advanced Usage
The `CustomClient` provides preset methods for the supported HTTP request types and JSON-based request bodies.
However, if you would like to make a request with non-JSON body (e.g. binary data), you can use the `makeRequest` method.
This is a more convenient way of using `com.vonage.client.DynamicEndpoint` which takes care of most of the setup for you.

#### Caveats
Whilst the `CustomClient` class is a powerful tool, it is not intended to be a replacement for dedicated support
which the SDK provides for Vonage APIs. Furthermore, you may notice your IDE giving warnings like
"Unchecked generics array creation for varargs parameter". This is because all methods in `CustomClient` use a 
varargs parameter for the response type as a way to infer the response type without you having to explicitly provide
the `Class<R>` parameter. This is a known limitation of Java generics and is not a problem with the SDK itself, it is
implemented this way for your convenience. As per the documentation, it is important to not pass any value for this
varargs parameter — just omit it. If you do pass a value, the SDK will not be able to infer the response type.
You should also always use explicit assignment for the `CustomClient` methods, as the SDK will not be able to infer the return type if you use `var` or `Object`.
If you do not assign the response to a typed variable explicitly, `Void` will be inferred and the method will return `null`.

## Configuration

## Typical Instantiation
For default configuration, you just need to specify your Vonage account credentials using API key and secret, private
key and application ID or both. For maximum compatibility with all APIs, it is recommended that you specify both
authentication methods, like so:

```java
VonageClient client = VonageClient.builder()
        .applicationId(APPLICATION_ID)
        .privateKeyPath(PRIVATE_KEY_PATH)
        .apiKey(API_KEY)
        .apiSecret(API_SECRET)
        .build();
```

### Customize the Base URI
By default, the client will use https://api.nexmo.com, https://rest.nexmo.com,  https://api-eu.vonage.com and https://video.api.vonage.com as base URIs for the various endpoints. To customize these you can instantiate `VonageClient` with an `HttpConfig` object.

`HttpConfig.Builder` has been created to assist in building this object. Usage is as follows:

```java
HttpConfig httpConfig = HttpConfig.builder()
        .apiBaseUri("https://api.example.com")
        .restBaseUri("https://rest.example.com")
        .apiEuBaseUri("https://api-eu.example.com")
        .videoBaseUri("https://video.example.com")
        .build();

VonageClient client = VonageClient.builder()
        .apiKey(API_KEY).apiSecret(API_SECRET)
        .httpConfig(httpConfig)
        .build();
```

If you do not specify a property, it will take on whatever the default value is. You can also set all three with a single method:

```java
HttpConfig httpConfig = HttpConfig.builder().baseUri("http://example.com").build();

VonageClient client = VonageClient.builder()
        .apiKey(API_KEY).apiSecret(API_SECRET)
        .httpConfig(httpConfig)
        .build();
```

### Custom Timeout

By default, the SDK has a 1-minute timeout for requests.
You can change this to be longer or shorter using `HttpConfig`. The following example sets this to 12 seconds:

```java
VonageClient client = VonageClient.builder()
        .applicationId(APPLICATION_ID)
        .privateKeyPath(PRIVATE_KEY_PATH)
        .httpConfig(HttpConfig.builder().timeoutMillis(12_000).build())
        .build();
```

### Proxy

You can set a proxy server for requests using the `proxy` method on `HttpConfig.Builder`.

```java
VonageClient client = VonageClient.builder()
        .applicationId(APPLICATION_ID)
        .privateKeyPath(PRIVATE_KEY_PATH)
        .httpConfig(HttpConfig.builder().proxy("https://myserver.example.com").build())
        .build();
```

### Request Headers

With the `HttpConfig` class, you can also set custom request headers for all requests made by the SDK.

```java
VonageClient client = VonageClient.builder()
        .applicationId(APPLICATION_ID)
        .privateKeyPath(PRIVATE_KEY_PATH)
        .httpConfig(HttpConfig.builder()
                .addRequestHeader("X-My-Header", "MyValue")
                .addRequestHeader("Correlation-Id", "123-456-789")
                .build()
        )
        .build();
```

### Logging

The SDK uses [Java's built-in logging library (`java.util.logging`)](https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html) to log requests and responses.
This is primarily centralised in two places: [AbstractMethod](src/main/java/com/vonage/client/AbstractMethod.java)
and [DynamicEndpoint](src/main/java/com/vonage/client/DynamicEndpoint.java).
For most cases, the former should provide sufficient level of detail.
It can be activated by setting the logger level to `FINE`, like so:

```java
LogManager.getLogManager().getLogger("com.vonage.client.AbstractMethod").setLevel(Level.FINE);
```

Since the logger on `DynamicEndpoint` is not static and based on the class name, it will only be activated if the
global log level is set to `FINE`. You can set the global log level like so:

```java
LogManager.getLogManager().getLogger("").setLevel(Level.FINE);
```

This will also activate the logger on `AbstractMethod` if you haven't already specified the desired log level on
that class, so you don't need to set it separately.

## Frequently Asked Questions

**Q: I'm seeing a warning about Java 8. What should I do?**

**A:** Version 9.x is the last major version to support Java 8. Support ends on June 30, 2026. Future versions (10.0+) will require Java 11 or later. If you are running Java 8, you have two options:
1. **Recommended**: Upgrade your Java runtime to Java 11 or later
2. Pin your SDK version to 9.x in your dependency configuration (though you will miss out on future updates and bug fixes)

The warning appears once per application lifecycle and does not affect functionality.

**Q: What happened to [`com.vonage:client`](https://search.maven.org/artifact/com.vonage/client)?**

**A:** To avoid confusion with our various client-side SDKs, this server-side SDK has been moved from
the `com.vonage:client` coordinates to `com.vonage:server-sdk`. The old artifactId (`com.vonage:client`) will
not receive further updates. All users should migrate to the new artifactId. Please note that the SDK is functionally
the same, it is just a namespace change on Maven Central.

**Q: What is your policy on thread safety?**

**A:** The current architecture of the SDK means that only one thread should use the client at a time.
If you would like to use the SDK in a multithreaded environment, create a separate instance of
`VonageClient` for each thread.

**Q: Does this SDK support asynchronous request / response processing?**

**A:** Currently no, but it is [on the roadmap](https://github.com/Vonage/vonage-java-sdk/issues/269).

**Q: I'm having issues with my project when including the SDK as a dependency. How can I troubleshoot this?**

**A:** Please see [this blog post](https://developer.vonage.com/en/blog/one-simple-trick-for-resolving-java-runtime-dependency-issues).
In short, you may have conflicting dependency versions in your project which clash with this SDK's transitive dependencies.

**Q: I'm encountering HTTP request issues, such as timeouts. How can I remedy or report this?**

**A:** This SDK uses [Apache HTTP Client 4](https://hc.apache.org/httpcomponents-client-4.5.x/index.html) under the
hood, so you may be able to use system properties to configure the client, or use this SDK's `httpConfig` method on
the `Vonage` class  for more fine-grained control. If you believe there is an issue with the underlying client, please
[raise an issue](https://github.com/Vonage/vonage-java-sdk/issues/new/choose) with a minimal reproducible example,
including details of your environment (JVM runtime version, SDK version, operating system etc.)

**Q: I'm not sure if my issue is with the SDK. How can I get help?**

**A:** Please see our [support page](https://api.support.vonage.com/), including contact information.

**Q: How do I migrate from TokBox to Vonage?**

**A:** See [the OpenTok migration guide](https://developer.vonage.com/en/video/transition-guides/server-sdks/java).

## Contribute!

_We :heart: contributions to this library!_

It is a good idea to talk to us first if you plan to add any new functionality.
Otherwise, [bug reports](https://github.com/Vonage/vonage-java-sdk/issues),
[bug fixes](https://github.com/Vonage/vonage-java-sdk/pulls) and feedback on the
library are always appreciated.

### Contact

[![Email](https://img.shields.io/badge/Email-green?style=flat-square&logo=gmail&logoColor=FFFFFF&labelColor=3A3B3C&color=62F1CD)](mailto:community@vonage.com)
[![Slack](https://img.shields.io/badge/Slack-4A154B?style=flat&logo=slack&logoColor=white)](https://developer.vonage.com/community/slack)
[![Twitter](https://img.shields.io/badge/Twitter-000000?style=flat&logo=x&logoColor=white)](https://twitter.com/VonageDev)