Authentication

In order to use the features of the Calls SDK in your apps, user authentication with Sendbird server must be initiated through the SendBirdCall.authenticate() method. To receive calls when an app is in the background or closed, a user’s device registration token must be registered to the server. A device registration token can be registered by passing it as an argument to a parameter in the authenticate() method when authenticating a user, or by using the SendBirdCall.registerPushToken() method after a user’s authentication has been completed.

Note: Even if your organization already uses Sendbird Chat, a separate user authentication is needed for Sendbird Calls.

As shown below, the SendBirdCall instance must be initialized when a client app is launched. Initialization is done by using the APP_ID of your Sendbird application in the Dashboard. If the instance is initialized with a different APP_ID, all existing call-related data in a client app will be cleared and the SendBirdCall instance will be initialized again with the new APP_ID.

// Initialize SendBirdCall instance to use APIs in your app.
SendBirdCall.init(getApplicationContext(), APP_ID);

In order to use the interfaces and methods provided in the SendBirdCall instance, a user must be connected to Sendbird server by authentication. Without authentication, calling the methods of the Calls SDK will not work in a user’s client app. This means that if a user performs actions such as accepting an incoming call before authentication, the user will receive errors from Sendbird server.

Through our Chat Platform API, you can create a user using an access token. You can also issue an access token for an existing user.

// The USER_ID below should be unique to your Sendbird application.
AuthenticateParams params = new AuthenticateParams(USER_ID)
    .setAccessToken(ACCESS_TOKEN)
    .setPushToken(PUSH_TOKEN, isUnique);

SendBirdCall.authenticate(params, new AuthenticateHandler() {
    @Override
    public void onResult(User user, SendBirdException e) {
        if (e == null) {
            // The user has been authenticated successfully and is connected to Sendbird server.
            ...
        }
    }
});

// Update the current user's push token
public class MyFirebaseMessagingService extends FirebaseMessagingService {
    ...

    @Override
    public void onNewToken(@NonNull String token) {
        SendBirdCall.registerPushToken(token, false, e -> {
            if (e == null) {
                // Succeeded to register push token.
            } else {
                // Failed to register push token.
            }
        });
    }
    ...

}

You can also use a session token instead of an access token to authenticate a user. Session tokens are a more secure option because they expire after a certain period whereas access tokens don't. See Chat Platform API guides for further explanation about the difference between access token and session token, how to issue a session token, and how to revoke all session tokens.

WebSocket connections with Sendbird server are made only when there is an ongoing direct call or group call, therefore authenticating won't create unnecessary WebSocket connections. Also, unless you have integrated push notifications to your application, new incoming calls won't be delivered through WebSocket. The Calls SDK versions prior to 1.6.0 supported making calls with WebSocket connections under certain circumstances, however it is now deprecated.

Note: Sendbird Calls is charged by minutes which starts as soon as the call is connected. It is recommended that you authenticate users for the Calls SDK at your earliest convenience.

Deauthenticate a user from Sendbird server using the SendBirdCall.deauthenticate() method. It will clear all current direct calls, session keys, and user information from a user’s client app. This can also be considered as logging out from the server.

SendBirdCall.deauthenticate(PUSH_TOKEN, new CompletionHandler() {
    @Override
    public void onResult(SendBirdException e) {
        if (e == null) {
            // The current user has been deauthenticated successfully.
        }
    }
});