Calls integration to Chat
You can integrate Sendbird Calls to Sendbird Chat to provide users with a seamless experience in using Calls and Chat services by allowing them to make a call within a chat channel. With the implementation of Calls integration to Chat, the call screen will appear when the call starts and when the call ends users will return to the chat view.
Note: To turn on Calls integration to Chat on the Sendbird Dashboard, go to Settings > Chat > Messages.
Calls integration to Chat provides the following benefits:
Natively integrated service
Sendbird Calls and Sendbird Chat are provided from the same app to offer an advanced in-app chat experience for users.
Call within channel
Users can directly make a call to anyone in a channel without leaving the app.
Immersive user experience
Smooth transition between Calls and Chat within a chat channel will make the user experience more engaging.
How it works
Since Calls integration to Chat is a way to add call capabilities to Sendbird Chat, it requires an app that uses Chat. If you already have one, you are ready to move to the next step. If you don’t have an app, learn how to set up Sendbird Chat from our Send first message page.
To use Calls integration to Chat, an environment setup is first needed for both Sendbird Calls and Sendbird Chat using the SDKs. To learn more about each, refer to Sendbird Calls for Android Quickstart and Sendbird Chat samples.
The minimum requirements for Calls integration to Chat are:
Android 5.0 (API level 21) or higher
Java 8 or higher
Android Gradle plugin 3.4.2 or higher
Sendbird Chat sample
Sendbird Chat SDK
Sendbird Calls SDK
Install the SDKs
To install the Calls SDK and the Chat SDK, do the following steps:
Step 1 Configuration
Sendbird Chat SDK and Sendbird Calls SDK both use singleton interfaces. Since these two SDKs work independently, create appropriate functions that can handle them together.
Step 2 Initialize the Calls SDK and the Chat SDK
Find your application ID from the Sendbird Dashboard to use in the Calls SDK and the Chat SDK.
Step 3 Log in to the Calls SDK and the Chat SDK
To log in to the Calls and Chat SDKs, create a function that allows you to authenticate the Calls SDK and the Chat SDK together.
As written above, the Chat SDK is authenticated by using the
SendbirdChat.connect() method and the Calls SDK is authenticated by using the
Step 4 Log out from the Calls SDK and the Chat SDK
To log out from the Calls SDK and the Chat SDK, create a function that handles the two SDKs together like it was to log in.
Register push tokens
Push notifications services allow users to receive notifications when the app is in the background. Before utilizing this feature, you need to register appropriate push tokens to Sendbird server. To turn on this feature, go to Settings > Chat > Push notifications in your dashboard.
FirebaseMessagingService.kt instance, save the push token from
Unregister push tokens
Before logging out, unregister the push tokens as shown below:
Make a call
For integration between the Calls and Chat services, the Calls SDK provides a specific option when dialing. You can provide the group channel URL to a
DialParams object of Sendbird Calls as shown below:
When a group channel URL is provided to the
DialParams object, messages containing call information such as calling status and duration will be automatically sent to the channel when the call starts and ends.
The messages will contain call information in the
plugins field of the
BaseMessage instance which can be used to properly show information about the calls.
Create custom UI components
The sample app for Calls integration to Chat is built based on Sendbird Chat. In the Chat sample app, every chat message is associated with a specific type of instance from the
RecyclerView.ViewHolder class. With different types of messages such as user message, file message, and admin message, different view types of
ViewHolder class are shown to the user, offering a more intuitive user experience.
For UI components for Calls integration to Chat, use the
list_item_group_chat_call_me.xml layout resource file which will show the UI component like the following when users make or receive a call:
An example of a call message you can create is demonstrated in the following adapter class file in the sample app:
To create similar UI components for Calls integration to Chat, follow the steps below:
- In Android Studio, go to res > layout and open the context menu.
- Select New > Layout Resource File.
- In the new resource file for custom layout, add image view and text view within linear layout to display icon and message. In the sample app, card view is used to display a call message.
Bind UI components
You can integrate the custom layouts to integrate Sendbird Calls to the group channel fragment of Chat.
ViewHolder class to initialize and bind UI components by extending the
Show UI components
To show the registered UI components, you have to identify which messages are associated with the Calls SDK.
BaseMessageclass from Sendbird Chat SDK has a field called
pluginswhere you can store additional information to default values. The key-value plugins are delivered as
- When a call is made from the Calls SDK, the
pluginfield of a message associated with the call will contain the following information:
- Then, for the messages that have these fields, show the UI component created.
- The following can be used to identify a call message and specify the type of UI by adding it in the
GroupChatAdapter.javafile from the Chat sample:
Extract call data from plugins
A bind method of the customizable
ViewHolder class shown below demonstrates a way to extract specific information from the
plugin about Sendbird Calls.
The detail of a call
plugin could be parsed into the
CallInfo class as below.
holder.bind() method in
onBindViewHolder() method of
GroupChatAdapter.java and the details of calls will be displayed in the
Create call activity
The call activity provides events for users such as ending a call, muting or unmuting the microphone, or offers local and remote video views on a user’s screen.
Use message bubble to call
Calls integration to Chat can provide a seamless user experience by allowing users to initiate a new call directly from a channel by tapping the messages that contain call information.
First, declare the
OnItemClickListener interface in the
In the bind method of the
ViewHolder class, register a click listener for the group chat view fragment and implement the
onClick() method like the following:
Implement below in the group chat view fragment to make a call with a tap.