https://github.com/sendbird/sendbird-platform-sdk-java
Sendbird Platform SDK for Java
https://github.com/sendbird/sendbird-platform-sdk-java
Last synced: 11 months ago
JSON representation
Sendbird Platform SDK for Java
- Host: GitHub
- URL: https://github.com/sendbird/sendbird-platform-sdk-java
- Owner: sendbird
- License: mit
- Created: 2022-02-07T15:20:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-27T02:29:27.000Z (11 months ago)
- Last Synced: 2025-07-27T05:19:46.011Z (11 months ago)
- Language: Java
- Size: 5.74 MB
- Stars: 9
- Watchers: 19
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Sendbird Java Platform SDK](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)
[](/docs)
This is a Java library that makes talking to the [Sendbird Platform API](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) easier. With this library you can extend your Sendbird integration to include advanced features like channel automation and user management.
# 🔥 Quick start
```java
import org.sendbird.client.ApiClient;
import org.sendbird.client.ApiException;
import org.sendbird.client.Configuration;
import org.sendbird.client.api.UserApi;
import org.openapitools.client.model.ListUsersResponse;
class AppTest {
static class User {
UserApi apiInstance;
public User(ApiClient defaultClient){
apiInstance = new UserApi(defaultClient);
}
public void listUsers(){
try {
Integer limit = 56;
String activeMode = "activated";
Boolean showBot = true;
ListUsersResponse result = apiInstance.listUsers().limit(limit).activeMode(activeMode).execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling listUsers");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
public static void main(String[] args) {
String apiToken = "YOUR_API_TOKEN";
String applicationId = "YOUR_APP_ID_FROM_DASHBOARD";
ApiClient defaultClient = Configuration.getDefaultApiClient().addDefaultHeader("Api-Token", apiToken);
defaultClient.setBasePath("https://api-" + applicationId + ".sendbird.com");
User user = new User(defaultClient);
user.listUsers();
}
}
```
# ⚒️ Prerequisite
In order to make requests with this SDK you will need you master API token. This can be found through the [Sendbird dashboard](https://dashboard.sendbird.com/). Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General.
## 💻 Requirements
Building the API client library requires:
1. Java 1.7+
2. Maven (3.8.3+)/Gradle (7.2+)
## ⚙️ Installation
To install the API client library to your local Maven repository, simply execute:
```shell
mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
mvn clean deploy
```
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
Add these dependency to your project's POM:
```xml
sendbird
https://repo.sendbird.com/public/maven
org.sendbird
sendbird-platform-sdk
2.0.0
```
### Gradle users
Add this dependency to your project's build file:
```groovy
dependencies {
implementation "org.sendbird:sendbird-platform-sdk:2.0.0"
}
allprojects {
repositories {
maven { url "https://repo.sendbird.com/public/maven" }
}
}
```
# 🗃️ Documentation
All the documentation for this project lives in the /docs directory of this repo.
##### Helpful links
| | Documentation |
| ----------- | ----------- |
| Announcement | [docs/AnnouncementApi.md](docs/AnnouncementApi.md)|
| Bot | [docs/BotApi.md](docs/BotApi.md) |
| GroupChannel | [docs/GroupChannelApi.md](docs/GroupChannelApi.md) |
| Message | [docs/MessageApi.md](docs/MessageApi.md) |
| OpenChannel | [docs/OpenChannelApi.md ](docs/OpenChannelApi.md) |
| User | [docs/UserApi.md](docs/UserApi.md) |