https://github.com/vonage/vonage-java-sdk
Vonage Server SDK for Java. API support for SMS, Messages, Voice, Text-to-Speech, Numbers, Verify (2FA), Video and more.
https://github.com/vonage/vonage-java-sdk
authentication dtmf java messaging messaging-api phone phone-numbers server-sdk sms sms-api telecom two-factor two-factor-authentication verification verify video-api voice vonage whatsapp
Last synced: 22 days ago
JSON representation
Vonage Server SDK for Java. API support for SMS, Messages, Voice, Text-to-Speech, Numbers, Verify (2FA), Video and more.
- Host: GitHub
- URL: https://github.com/vonage/vonage-java-sdk
- Owner: Vonage
- License: apache-2.0
- Created: 2012-01-18T20:12:22.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T17:03:50.000Z (11 months ago)
- Last Synced: 2024-05-29T04:43:22.291Z (11 months ago)
- Topics: authentication, dtmf, java, messaging, messaging-api, phone, phone-numbers, server-sdk, sms, sms-api, telecom, two-factor, two-factor-authentication, verification, verify, video-api, voice, vonage, whatsapp
- Language: Java
- Homepage: https://developer.vonage.com/en/home
- Size: 5.63 MB
- Stars: 93
- Watchers: 24
- Forks: 119
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Vonage Server SDK for Java
[](https://central.sonatype.com/artifact/com.vonage/server-sdk)
[](https://github.com/Vonage/vonage-java-sdk/actions/workflows/build.yml)
[](https://codecov.io/gh/vonage/vonage-java-sdk)
[](https://scorecard.dev/viewer/?uri=github.com/Vonage/vonage-java-sdk)
[](https://snyk.io/test/github/vonage/vonage-java-sdk)
[](CODE_OF_CONDUCT.md)
[](LICENSE.txt)
[](https://github.com/vonage/vonage-java-sdk/pulse)
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).
### Build It Yourself
Alternatively you can clone the repo and build the JAR file yourself:
```bash
git clone [email protected]: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).
## 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();
```
### 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: 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
[](mailto:[email protected])
[](https://developer.vonage.com/community/slack)
[](https://twitter.com/VonageDev)