This is a Node.js package written in Typescript that makes talking to the Sendbird Platform API easier. With this library you can extend your Sendbird integration to include advanced features like message-, and channel automation, user management, create user authentication tokens, and create bots.
import * as sendbird from 'sendbird-platform-sdk-typescript';
const APP_ID = "YOUR_APP_ID_FROM_DASHBOARD";
const API_TOKEN = "YOUR_MASTER_API_TOKEN_FROM_DASHBOARD";
const serverConfig = new sendbird.ServerConfiguration("https://api-{app_id}.sendbird.com", { "app_id": APP_ID })
const configuration = sendbird.createConfiguration({ baseServer : serverConfig });
const userAPI = new sendbird.UserApi(configuration);
// List users, use the next token in the response to get the next page of users in subsequent requests
userAPI.listUsers(API_TOKEN, '', 10).then((users) => {
console.log("Listing first 10 users:\n")
console.log(users)
}).catch((error) => {
console.log("Error listing users")
console.log(error)
})
// How to create a user
const userData: sendbird.CreateUserData = {
userId: "bob_smith",
nickname: "Bob",
profileUrl: "https://cataas.com/c"
}
userAPI.createUser(API_TOKEN, userData).then((user) => {
console.log("User created:\n")
console.log(user)
}).catch((error) => {
console.log("Error creating user:")
console.log(error)
})
In order to make requests with this SDK you will need you master API token. This can be found through the Sendbird dashboard. Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General.
You will need Node.js installed. This has been developed and tested with NodeJS 17+.
π¨ Package not yet in npm π¨
npm install sendbird-platform-sdk-typescript
sendbird-platform-sdk-typescript
directorynpm install
npm install /path/to/sendbird-platform-sdk-typescript --save
All the documentation for this project lives in the /docs directory of this repo.
Documentation | |
---|---|
Announcement | docs/AnnouncementApi.md |
Application | docs/ApplicationApi.md |
Bot | docs/BotApi.md |
GroupChannel | docs/GroupChannelApi.md |
Message | docs/MessageApi.md |
OpenChannel | docs/OpenChannelApi.md |
User | docs/UserApi.md |
Webhooks | docs/WebhooksApi.md |