In order to use the features of the Calls SDK in your apps, user authentication with Sendbird server must be initiated through the
authenticate() method. To receive direct calls, a user’s device token must be registered to the server. A device token can be registered by using the
registerRemotePush() 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.
Initialize the Calls SDK with APP_ID
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
Authenticate to Sendbird server
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 or entering a room before authentication, the user will receive errors from Sendbird server. Also, any other events won’t be received through the Calls SDK if the user isn’t authenticated, except for the incoming calls through push notifications.
For example, the
SendBirdCall.authenticate(with:) method should be called before calling the
call.accept() in the
didFinishLaunchingWithOptions method of your app’s
AppDelegate as shown below:
It is recommended to save the current user’s ID to the
UserDefaults when a client app launches so that immediate authentication can take place by using the saved user ID.
CallKit, if the
call.decline() is called before user authentication is completed with Sendbird server, a user will receive errors from the server and the
CallKit view might hang without response. There are two ways to solve this problem:
1. Call the fulfill() method after user authentication
fulfill() method should be called within the callback of the
SendBirdCall.authenticate() method after the
call.decline() is called.
2. Use background modes
Enable background modes by using the
beginBackgroundTask() method and call the
fulfill() method at the end. Then the Calls SDK will have enough time in the background to complete user authentication and decline an incoming call. This will prevent a client app from being immediately terminated.
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.
Using a session 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.
Deauthenticate from Sendbird server
SendBirdCall.deauthenticate(completionHandler:) method, deauthenticate a user from Sendbird server. 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.
Note: To stop receiving push notifications after deauthentication, unregister device tokens by using the