Install and configure the Calls SDK

This page explains how to create a Sendbird application in your dashboard and install the Calls SDK. If you’re ready to integrate Calls to your app, follow the step-by-step instructions below.

Step 1: Create a Sendbird application from your dashboard

A Sendbird application comprises everything required in a Calls service including users, message, and channels. To create an application:

  1. Go to the Sendbird Dashboard and enter your email and password, and create a new account. You can also sign up with a Google account.
  2. When prompted by the setup wizard, enter your organization information to manage Sendbird applications.
  3. Lastly, when your dashboard home appears after completing setup, click Create + at the top-right corner.

Only one Sendbird application can be integrated per app for your service regardless of the platform. All users within your Sendbird application can communicate with each other across all platforms. This means that your iOS, Android, and web client app users can all make and receive calls with one another without any further setup. It should be noted that all data is limited to the scope of a single application, and users in different Sendbird applications can't make and receive calls to each other.

Note: For application administrators, the Sendbird Dashboard provides call logs to keep track of all calls made on the application.

Step 2: Install the Calls SDK

Installing the Chat SDK is simple if you're familiar with using external libraries or SDKs. First, add the following code to your root build.gradle file:

Light Color Skin
allprojects {
    repositories {
        maven { url "https://repo.sendbird.com/public/maven" }

Note: Make sure the above code block isn't added to your module bundle.gradle file.

Then, add the dependency to your module build.gradle file.

Light Color Skin
dependencies {
    implementation 'com.sendbird.sdk:sendbird-calls:1.6.1'

Note: Call SDK versions 1.5.3 or lower can be downloaded from JCenter until February 1, 2022. SDK versions higher than 1.5.3 will be available on Sendbird's remote repository.

Step 3: Grant system permissions to the Calls SDK

The Calls SDK requires system permissions. These permissions allow the Calls SDK to communicate with Sendbird server. It can also record audio and discover bluetooth devices. To grant system permissions, add the following lines to your AndroidManifest.xml file.

Light Color Skin
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

The CAMERA and RECORD_AUDIO permissions are considered as dangerous permissions and require user agreement when your client app is first launched on a user’s device with Android 6.0 or higher.

Note: For more information about requesting app permissions, see the Android’s Request app permissions guide.

(Optional) Step 4: Configure ProGuard to shrink code and resources

When you build your APK with minifyEnabled true, add the following line to the module's ProGuard rules file.

Light Color Skin
# Sendbird Calls SDK
-keep class com.sendbird.calls.** { *; }
-keep class org.webrtc.** { *; }
-dontwarn org.webrtc.**
-keepattributes InnerClasses