GitHub - sendbird/sendbird-calls-ios: A guide of Sendbird Calls SDK for iOS for an engaging voice and video call experience. · GitHub
Skip to content You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert Branches Tags Open more actions menu Latest commit History 203 Commits 203 Commits Folders and files Name Name Last commit message Last commit date SendBirdCalls.xcframework SendBirdCalls.xcframework Sources Sources Tests/ sendbird-calls-iosTests Tests/ sendbird-calls-iosTests .gitignore .gitignore CHANGELOG.md CHANGELOG.md LICENSE.md LICENSE.md Package.resolved Package.resolved Package.swift Package.swift README.md README.md SendBirdCalls.podspec SendBirdCalls.podspec catalog-info.yaml catalog-info.yaml Repository files navigation Sendbird Calls SDK for iOS Table of contents Introduction Before getting started Build with Claude Code or Codex Getting started Configuring the application for the SDK Making your first call Implementation guide Appendix Troubleshooting Introduction Sendbird Calls is the latest addition to our product portfolio.
It enables real-time calls between users within a Sendbird application. SDKs are provided for iOS, Android, and JavaScript. Using any one of these, developers can quickly integrate voice and video call functions into their own client apps, allowing users to make and receive web-based real-time voice and video calls on the Sendbird platform. If you need any help in resolving any issues or have questions, please visit our community How it works Sendbird Calls SDK for iOS provides a framework to make and receive voice and video calls.
Direct calls in the SDK refers to one-to-one calls. To make a direct voice or video call, the caller specifies the user ID of the intended callee, and dials. Upon dialing, all of the callee’s authenticated devices will receive notifications for an incoming call. The callee then can choose to accept the call from any one of the devices. When the call is accepted, a connection is established between the devices of the caller and the callee.
This marks the start of a direct call. Call participants can mute themselves, or call with either or both of the audio and video by using output devices such as speaker and microphone for audio, and front, rear camera for video. A call may be ended by either party. The Sendbird Dashboard displays call logs in the Calls menu for dashboard owners and admins to review. More about Sendbird Calls SDK for iOS Find out more about Sendbird Calls for iOS on Calls SDK for iOS doc .
Before getting started This section shows the prerequisites you need to check to use Sendbird Calls SDK for iOS. Requirements iOS 14.0 or later Swift 5 or later, Objective-C Xcode 15.0 or later, macOS Sierra or later. SDK dependencies WebRTC framework , which can be integrated by Swift Package Manager , or manual set-up. Build with Claude Code or Codex Two Sendbird plugins for Claude Code and Codex help you add this SDK to your iOS app: The Sendbird Client Plugin writes setup and feature code from verified Sendbird documentation and the Sendbird SDK you have installed.
The Sendbird CLI plugin signs you in to Sendbird and manages your apps, users, and channels with the Sendbird CLI. The client plugin can take the App ID from the app you choose there. In Claude Code: claude plugin marketplace add sendbird/sendbird-plugins claude plugin install sendbird-client@sendbird claude plugin install sendbird-cli@sendbird Start a new session, run /sendbird-cli:sendbird-setup to sign in and choose your app, and then run /sendbird-client:setup --product calls in your project.
In Codex: codex plugin marketplace add sendbird/sendbird-plugins codex plugin add sendbird-client@sendbird codex plugin add sendbird-cli@sendbird Start a new session, call $sendbird-cli:sendbird-setup to sign in and choose your app, and then call $sendbird-client:setup --product calls in your project. See the Client plugin guide and the CLI plugin guide for setup details and example requests. The client plugin runs local shell scripts as hooks.
Review What runs on your machine before installing. Getting started This section gives you information you need to get started with Sendbird Calls SDK for iOS. Install Calls SDK Installation via CocoaPods and Carthage is no longer supported. Swift Package Manager Go to your Swift Package Manager's File tab and select Swift Packages . Then choose Add package dependency . Add the SendBirdCalls framework into your Package Repository with the following URL: https://github.com/sendbird/sendbird-calls-ios .
To add the package, select appropriate dependency rule and click Add Package . Manual set-up If you do not prefer to use Swift Packages to install the Calls SDK, here is an alternative: you can manually integrate the SendBirdCalls directly into your project. The SendBirdCalls framework is provided as a .xcframework file. Download the framework file by one of the following. Direct download from git releases Git Submodules Other package managers Copy the downloaded framework file into your project directory.
Go to General tab of your Xcode Project Navigator, and scroll down to Frameworks, Libraries, and Embedded Content menu. Click the + button, choose Add other... drop down menu, and select Add files... option. From the file navigator, select the framework that you've previously downloaded. Select Embed & Sign option in the Embed menu of the selected framework. Because SendBirdCalls requires SendBirdWebRTC as a dependency, you need to install SendBirdWebRTC as well.
Navigate to SendBirdWebRTC Repository and perform the above steps 1-6 similarly. Configuring the application for the SDK Background Mode To support background operation, VoIP-enabled apps must have Background Mode enabled in the Xcode Project > Signing & Capabilities pane. Select the checkbox for Voice over IP . To receive push notifications, the app also must have Push Notifications enabled in the Xcode Project > Signing & Capabilities pane.
For more information about VoIP push notification and PushKit, see Apple's CallKit and PushKit Configure the app’s Info.plist File iOS requires that apps display authorization message to grant the app access to the camera and microphone. Microphone-enabled apps must include the NSMicrophoneUsageDescription key in the app’s Info.plist file. Camera-enabled apps must include the NSCameraUsageDescription key in the app’s Info.plist file.
Making your first call Follow the step-by-step instructions below to authenticate and make your first call. Step 1: Initialize the SendBirdCall instance in a client app As shown below, the SendBirdCall instance must be initiated when a client app is launched. Initialize the SendBirdCall instance with the APP_ID of the Sendbird application you would like to use to make a call. SendBirdCall . configure ( appId : APP_ID ) Note: If another initialization with another APP_ID takes place, all existing data in the app will be deleted and the SendBirdCall instance will be initialized with the new APP_ID .
Step 2: Authenticate a user and register a push token In order to make and receive calls, authenticate the user with SendBird server with the SendBirdCall.authenticate(with:) method and register a VoIP push token to Sendbird. Register a VoIP push token by using the SendBirdCall.registerVoIPPush(token:) method after authentication has completed. VoIP Push Notification will also enable receiving calls even when the app is in the background or terminated state.
A valid APNS certificate also needs to be registered on the Sendbird Dashboard : Application > Settings > Notifications > Add certificate . For more details on registering push tokens, refer to Calls SDK for iOS doc . // Authenticate let params = AuthenticateParams ( userId : userId , accessToken : accessToken ) SendBirdCall . authenticate ( with : params ) { user , error in guard let user = user , error == nil else { return } // The user has been authe
The rest of this page is on the live site.