Download SendBird

Chat SDKs Android v3Chat SDKs AndroidChat SDKsAndroidSendbird Chat SDK v3 for Android is no longer supported as a new version is released. Check out our latest Chat SDK v4 With Sendbird Chat SDK for Android, you can efficiently integrate real-time chat into a client app. On the client-side implementation, you can initialize and configure the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for your chat within the app.This page demonstrates how to install the Chat SDK in your app so that you can send your first message in just a few simple steps.Note: The fastest way to see Sendbird Chat SDK in action is to build your app on top of our sample app. Download the sample app to jumpstart your build. To implement Kotlin in your app, see tutorials for How to build in-app chat using Kotlin Part 1 and Part 2.RequirementsThe minimum requirements for Chat SDK for Android are:Android 4.1 (API level 16) or higherJava 7 or higherAndroid Gradle plugin 3.4.0 or higherNote: Sendbird server supports Transport Layer Security (TLS) from versions 1.0 up to 1.3. For example, in the server regions where TLS 1.3 isn’t available, lower versions from 1.0 to 1.2 will be sequentially supported for secure data transmission.Before you startBefore installing Sendbird Chat SDK, you need to create a Sendbird application on Sendbird Dashboard, which comprises everything required in a chat service including users, messages, and channels. You will need the Application ID of your Sendbird application from the dashboard when initializing the Chat SDK.Each Sendbird application can be integrated with a single client app. Within the same application, users can communicate with each other across all platforms, whether they are on mobile devices or on the web.Sendbird UIKitUIKit is a Sendbird Chat SDK add-on with user interfaces that enables easy and fast integration of standard chat features into new or existing client apps.If you would like a sample app with embedded UI, see UIKit Quickstart for Android.Access control listSendbird provides various access control options when using the Chat SDK. By default, the following attributes are turned on to avoid unexpected errors when creating sample apps and sending your first message: Allow retrieving user listAllow updating user metadataAllow creating open channelsAllow creating group channels However, this may grant access to unwanted data or operations, leading to potential security concerns. To manage your access control settings, you can turn on or

Enter your package name, download the agconnect-services.json file, and place it in your Android app module's root directory.Step 2 Register app ID and app secret to Sendbird DashboardRegister your app ID and app secret to the Sendbird server through Sendbird Dashboard as follows.Sign in to your dashboard and go to Settings > Calls > Push notifications.Click Add credentials and register the App ID and App secret acquired in Step 1.Step 3 Set up an HMS client app on your Android projectAdd the following dependency for the HUAWEI Push Kit Android library to your build.gradle files at both the project and app levels.allprojects { repositories { // ... maven { url ' } }}buildscript { repositories { // ... maven { url ' } } dependencies { // ... classpath 'com.huawei.agconnect:agcp:1.1.1.300' }}Step 4 Register a registration token to the Sendbird serverIn order to send notification messages to a specific client app on an Android device, HMS requires an app instance's registration token which has been issued by the client app. Therefore, the Sendbird server also needs every registration token of client app instances to send notification requests to HMS on behalf of your server.A user can have up to 20 HMS registration tokens. If a user who already has the maximum number of tokens attempts to add another one, the newest token replaces the oldest.Upon the initialization of your app, the HMS SDK generates a unique, app-specific registration token for the client app instance on your user's device. HMS uses this

Off each option in Settings > Application > Security > Access control list on Sendbird Dashboard.Get startedTo send a message in a client app, you should build and configure an in-app chat using Sendbird Chat SDK. Sendbird Chat SDK can be installed through Gradle.Step 1 Install the Chat SDKIf you're using Gradle 6.8 or higher, add the following code to your settings.gradle file. If Gradle 6.7 or lower is used, add the following code to your root build.gradle file. See this release note to learn more about updates to Gradle.Gradle 6.8 or higherGradle 6.7 or lower// Add the following to your settings.gradle file.dependencyResolutionManagement { repositories { maven { url " } }}Next, for all Gradle versions, add the dependency to your module build.gradle file.dependencies { implementation 'com.sendbird.sdk:sendbird-android-sdk:3.1.27'}Alternatively, you can download the .aar file. Copy this file into your libs/ folder, and make sure you include the library in your build.gradle file as well.Step 2 Request to access system permissionsThe Chat SDK requires system permissions. These permissions allow the Chat SDK to communicate with Sendbird server and read from and write on a user device’s storage. To request system permissions, add the following lines to your AndroidManifest.xml file.Step 3 (Optional) Configure ProGuard to shrink code and resourcesWhen you build your APK with minifyEnabled true, add the following line to the module's ProGuard rules file.-dontwarn com.sendbird.android.shadow.**Step 4 Initialize the Chat SDKNow, initialize the Chat SDK in the app to allow the Chat SDK to respond to changes in the connection status of Android client apps. Initialization requires the App ID, which can be found on Sendbird Dashboard.Note: The methods in the following steps are all asynchronous. This means that when using asynchronous methods, your client app must receive success callbacks from Sendbird server through their callback handlers in order to proceed to the next step. A good way to do this is the nesting of methods: Go to Step 7: Enter the channel to learn more about how you can nest the openChannel.enter() in the OpenChannel.getChannel() method.With local caching, two new parameters have been added to the SendBird.init() method, which are useLocalCaching and InitResultHandler(). The following will show how you can initialize the Chat SDK with or without local caching.The useLocalCaching determines whether the client app will use the local storage through Sendbird Chat SDK or not. If you want to build a client app with our local caching functionalities, set the

Chat SDKs Unreal v3Chat SDKs UnrealChat SDKsUnrealSendbird Chat SDK for Unreal is a development kit that enables an easy and fast integration of standard chat features into client apps. On the client-side implementation, you can initialize and configure the chat with minimal effort. On the server-side, Sendbird ensures reliable infra-management services for adding chat within the app.If you are looking to build an app with chat features, we recommend you build a client app on top of our sample app. If you already have an app and you are looking to add chat to it, proceed with this guide to integrate chat into your app. This guide walks you through installing the Chat SDK in your app, creating a channel, and sending your first message to the channel.RequirementsThe minimum requirements for Chat SDK for Unreal are the following.Unreal Engine 4.27 (default) or Unreal Engine 4.26Note: The Sendbird server supports Transport Layer Security (TLS) from versions 1.0 up to 1.3. For example, in the server regions where TLS 1.3 isn’t available, lower versions from 1.0 to 1.2 will be sequentially supported for secure data transmission.Before you startBefore installing Sendbird Chat SDK, you need to create a Sendbird application on Sendbird Dashboard, which comprises everything required in a chat service including users, messages, and channels. You need the Application ID of your Sendbird application from the dashboard when initializing the Chat SDK.Go to Sendbird Dashboard and create an account for a free trial. If you already have a Sendbird account, sign into your account.Create a new application by clicking Create + at the bottom right of your screen.Enter a name for your application. Choose a Product Type and Region. Then, click Confirm.Click the application you just created under Applications. You will see the application's Application ID which you will need when initializing the Chat SDK.Each Sendbird application can be integrated with a single client app. Within the same application, users can communicate with each other across all platforms, whether they are on mobile devices or on the web.Access control listSendbird provides various access control options when using the Chat SDK. By default, the following attributes are turned on to avoid unexpected errors when creating sample apps and sending your first message. Allow retrieving user listAllow updating user metadataAllow creating open channelsAllow creating group channels However, this may grant access to unwanted data or operations, leading to potential security concerns. To manage your access control settings, you can turn on or off each option in Settings > Application > Security > Access control list on Sendbird Dashboard.Get startedTo send a message in a client app, you should build and configure an in-app chat using Sendbird Chat SDK.Step 1 Create a projectSee this page to learn how to create a new Unreal project. Step 2 Install the Chat SDKDownload Sendbird Plugin in the GitHub repository for Unreal.Copy the Sendbird folder into the Plugins folder in your Unreal project.Add Sendbird to the Plugins section of your *.uproject file.{ ..., "Plugins": [ { "Name": "Sendbird", "Enabled":

True } ]}Add OpenSSL and Sendbird modules to your *.Build.cs file.PrivateDependencyModuleNames.AddRange(new string[] { "OpenSSL", "Sendbird" });Add the Sendbird.h file to your .cpp file.Step 3 Initialize the Chat SDKNow, initialize Sendbird Chat SDK in the app to allow the Chat SDK to respond to changes in the client apps' connection status. To initialize the SDK, you need the Application ID of your Sendbird application, which can be found on Sendbird Dashboard. Pass the Application ID you copied earlier on the dashboard to SBDMain::Init() to initialize. Note: The SBDMain::Init() method of a SBDMain class must be called at least once across a client app.Step 4 Connect to the Sendbird serverYou need a user in order to connect to the Sendbird server and send a message to a channel. You can either create a user on Sendbird Dashboard or use a unique ID that hasn't been taken by any of your Sendbird application users. In the latter case, a new user is automatically created in your Sendbird application before being connected.To learn more about using an access token to authenticate a user, see the authentication page.SBDMain::Connect(USER_ID, SBD_NULL_WSTRING, [](SBDUser* user, SBDError* error) { if (error != nullptr) { // Handle error. return; } // The user is connected to the Sendbird server.});Step 5 Create a new open channelCreate an open channel using the following code. Open channels are where all users in your Sendbird application can easily participate without an invitation.SBDOpenChannelParams params = SBDOpenChannelParams();SBDOpenChannel::CreateChannel(params, [](SBDOpenChannel* openChannel, SBDError* error) { if (error != nullptr) { // Handle error. return; }});Note: You can also create a group channel to send a message. To learn more, see create a group channel.Step 6 Enter the channelEnter the open channel to send and receive messages.// The following sample code continues from Step 5.SBDOpenChannelParams params = SBDOpenChannelParams();SBDOpenChannel::CreateChannel(params, [](SBDOpenChannel* openChannel, SBDError* error) { if (error != nullptr) { // Handle error. return; } openChannel->Enter([](SBDError* error) { if (error != nullptr) { // Handle error. return; } // The current user has successfully entered the open channel, // and can chat with other users in the channel using APIs. });});Step 7 Send a message to the channelFinally, send a message to the channel. To learn about the message types you can send, refer to Message overview in Chat Platform API.You can check the message you've sent on Sendbird Dashboard. To learn about receiving a message, refer to the receive messages through a channel event handler page.SBDUserMessageParams params = SBDUserMessageParams().SetMessage(TEXT_MESSAGE);openChannel->SendUserMessage(params, [](SBDUserMessage* userMessage, SBDError* error) { if (error != nullptr) { // Handle error. return; } // A text message with detailed configuration is successfully sent to the channel. // You can access the result object from the Sendbird server // to check your SBDUserMessageParams configuration. // The current user can receive messages from other users // through the MessageReceived() method of a channel event handler.});

Business Messaging Client Side v2Business MessagingSendbird Business Messaging utilizes our core Chat SDKs to implement Business Messaging in a way that is more specific to your application. This guide walks you through the necessary steps required in order to successfully install the SDK for your preferred platform.Install Chat SDK for iOSInstall Chat SDK for AndroidInstall Chat SDK for JavaScriptInstall Chat SDK for FlutterNote: The Sendbird server supports Transport Layer Security (TLS) from version 1.0 up to 1.3. For example, in the server regions where TLS 1.3 isn't available, lower versions, sequentially from 1.2 to 1.0, will be supported for secure data transmission.Before you startBefore install the Chat SDK of Sendbird Business Messaging, it is assumed you already have the following:A Sendbird account on Sendbird DashboardA Sendbird Application in a region that supports Business MessagingNote: Sendbird Business Messaging are currently only supported in the following regions: Singapore, N. Virginia, Oregon, Frankfurt, MumbaiiOSInstalling the Chat SDK is simple if you're familiar with using external libraries or SDKs in your projects. Sendbird Chat SDK can be installed through either one of the package managers:Swift PackagesCocoaPodsCarthageIf you don't want to use a package manager, check out the manual installation guide.Note: The name of the framework and the module is SendbirdChatSDK while the main class in the SDK is called SendbirdChat.RequirementsThe minimum requirements for the Chat SDK for iOS are the following:macOSXcode 15.0 or laterAt least one device running iOS 12.0 or laterSwift 5.0 and later or Objective-CNote: Starting on April 29, 2024, you must build and test your app with Xcode 15.0 or later to submit to the App Store. You can use the existing Sendbird SDK versions built with both Xcode 13.x and Xcode 14.x but Sendbird is repackaging Chat for iOS with Xcode 15.0 and minimum iOS version of 12.0 starting on April 29, 2024.SwiftOpen Xcode, go to your projects General settings tab and select your project under Project in the left column.Go to the Swift packages tab and click the + button.When a pop-up appears, enter the following github repository address in the search bar: Rules and click Next.Check SendbirdChatSDK in