Embedded Service Chat SDK for iOS Developer Guide

Embedded Service Chat SDK for iOS Developer Guide
Release Notes
Service Cloud Setup
SDK Setup
Requirements
Accessibility
Data Collection
Installation
Add the Service SDK Frameworks with CocoaPods
Add the Service SDK Frameworks Manually
Authentication
Notifications
Prepare Your App for Submission
iOS Tutorials & Examples
Chat
SDK Customizations
Troubleshooting
Data Protection and Security
Reference Documentation
Additional Resources
PDF

Install the Service Chat SDK for iOS

Before you can use the iOS SDK, install the SDK and configure your project.

The legacy chat product is scheduled for retirement on February 14, 2026, and is in maintenance mode until then. During this phase, you can continue to use chat, but we no longer recommend that you implement new chat channels. To avoid service interruptions to your customers, migrate to Messaging for In-App and Web before that date. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time. Learn about chat retirement in Help.

Important

  1. Add the SDK frameworks to your project.

    You can add the frameworks using Swift Package Manager, using CocoaPods, or by downloading and adding the frameworks manually.

    To add the frameworks using Swift Package Manager, add a package dependency to your app using the following public URL: https://github.com/Salesforce-Async-Messaging/Swift-Package-ServiceChat.

    To learn more about package dependencies, see Adding Package Dependencies to Your App in Apple's Developer Documentation.

    The Swift Package Manager installation method is only supported for the Service Chat feature. To install the SDK for Knowledge or Case Management, use one of the other installation methods.

    Important

    Alternatively, you can add the frameworks files manually or install the frameworks using CocoaPods.

  2. Add descriptions for why the app needs access to the device's camera and photo library.

    Add string values for "Privacy - Camera Usage Description" and "Privacy - Photo Library Usage Description" in your Info.plist file. To learn more about these properties, see Cocoa Keys in Apple's reference documentation.

    Sample values for these keys:

    1<key>NSCameraUsageDescription</key>
2<string>Used when sending an image to an agent.</string>
3<key>NSPhotoLibraryUsageDescription</key>
4<string>Used when sending an image to an agent.</string>

You're now ready to get started using the SDK!