@sendbird/sendbird-platform-sdk-typescript

Sendbird Typescript Platform SDK

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.

🔥 Quick start

import * as sendbird from '@sendbird/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)
})

⚠️ Warnings

• This library is intended for server to server requests. Do not use in a browser environment. This SDK uses the Master API Token, which should never be exposed to the outside world like in a webpage or app.

⚒️ Prerequisite

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.

💻 Requirements

You will need Node.js installed. This has been developed and tested with NodeJS 17+.

⚙️ Installation

npm install @sendbird/sendbird-platform-sdk-typescript

🤓 Local Development

• Clone the repository
• cd to the sendbird-platform-sdk-typescript directory
• Run npm install
• Run npm run build to create a publish-ready dist/ directory.
• Run npm pack ./dist to verify the package contents locally.

🗃️ Documentation

All the documentation for this project lives in the top-level markdown files in this repo and is copied into dist/ for packaging.

Helpful links

	Documentation
Announcement	AnnouncementApi.md
Bot	BotApi.md
GroupChannel	GroupChannelApi.md
Message	MessageApi.md
OpenChannel	OpenChannelApi.md
User	UserApi.md
Moderation	ModerationApi.md