microsoft/ContactCenterMessagingSDK-ios

microsoft/ContactCenterMessagingSDK-ios

Description: Connect your iOS application with Dynamics 365 Contact Center using your custom interface or our out of the box native messaging experience.

Language: Objective-C

License: NOASSERTION

Stars: 9

Forks: 3

Open issues: 2

Created: 2024-12-13T20:44:11Z

Pushed: 2026-06-10T09:10:25Z

Default branch: main

Fork: no

Archived: no

README:

Dynamics 365 Contact Center - Messaging SDK - iOS

Table of Contents

• [About](#about)
• [Sample Application](#sample-application)
• [Installation](#installation)

+ [Pre-Requisites](#pre-requisites) + [Method One: Manual Integration](#method-one-manual-integration) + [Method Two: Cocoapods](#method-two-cocoapods)

• [Initializing](#initializing)

+ [Initialize ContactCenterMessagingSDK](initialize-contactcentermessagingsdk) + [Authentication](#authentication)

• [Messaging Widget](#messaging-widget)
• [Core Messaging Framework](#core-messaging-framework)

+ [Get Success and Error Responses](#get-success-and-error-responses) + [initOmnichannelChatSDK](#initomnichannelchatsdk) + [getAgentAvailability](#getagentavailability) + [onNewMessage](#onnewmessage) + [startChat](#startchat) + [getAgentTypingStatus](#getagenttypingstatus) + [sendCustomerTyping](#sendcustomertyping) + [onAgentEndSession](#onagentendsession) + [getLCWLiveChatConfig](#getlcwlivechatconfig) + [getPreChatSurvey](#getprechatsurvey) + [sendMessage](#sendmessage) + [getAllMessages](#getallmessages) + [getLiveChatTranscript](#getlivechattranscript) + [getConversationDetails](#getconversationdetails) + [getDataMaskingRules](#getdatamaskingrules) + [uploadFileAttachment](#uploadfileattachment) + [downloadFileAttachment](#downloadfileattachment) + [getChatToken](#getchattoken) + [emailTranscriptCall](#emailtranscriptcall) + [endOCSDKChat](#endocsdkchat)

• [Push Notifications](#push-notifications)

+ [Requirements](#requirements) + [Contact Center Configuration](#contact-center-configuration)

• [Accessibility](#accessibility)
• [Contributing](#contributing)
• [Trademarks](#trademarks)

About

The Dynamics 365 Contact Center Messaging SDK enables developers to add Dynamics 365 Contact Center's messaging to their branded mobile applications.

This SDK contains two components:

• Messaging Widget: A pre-built, fully featured native messaging interface that the

customer can use wholesale and easily customize to match their branding. The widget is already integrated with Omnichannel and customers that opt to use it do not need to interact with the Core Messaging Functions for almost all of the messaging lifecycle.

• Core Messaging Framework: Enables a developer to build their own messaging

interface. This is a full set of functions that interact with the Omnichannel Messaging APIs which the customer can connect with an existing or new interface in their branded app.

For most messaging programs, we recommend the use of our out of the box Messaging Widget:

• Provides messaging with the least amount of development effort
• Configurable look, feel, and customization options so the widget can be branded easily

to match your app. The available options are based on what is available with our Web Live Chat Widget (LCW), so developers that are familiar with our web application can quickly match their existing program

If there are any customizations you need that aren't available in our product, please don't hesitate to reach out to us at CC-Mobile-Preview@microsoft.com and we'll add them to our roadmap.

Sample Application

To get you started quickly, we offer a pre-configured sample application here: ContactCenterMessagingApp.

Important steps to follow while adding SDKs

1. Always create weak object of LiveChatMessagingViewController. Example *weak* var liveChatMessagingVC: LiveChatMessagingViewController? // Keeping optional so automatically invalidate instance so next launch creates fresh one 2. Always call LiveChatMessaging.shared.initialize call before presentation of liveChatMessagingVC. In sample application, 3. Always do null check on liveChatMessagingVC. Example if liveChatMessagingVC == nil { liveChatMessagingVC = launchMessagingViewController(delegate: self) } if let liveChatMessagingVC = liveChatMessagingVC { liveChatMessagingVC.modalPresentationStyle = .fullScreen ... self.present(liveChatMessagingVC, animated: true, completion: nil) }

Installation

Pre-Requisites

• Dynamics 365 Contact Center License
• Provisioned test organization, retrieving these variables:
• orgID
• orgURL
• Provisioned Chat Channel & Live Chat Widget configuration, retrieving these variables:
• widgetID/applicationID
• For reference, see:
• Configure a chat widget | Microsoft Learn
• Embed chat widget in your website or portal | Microsoft Learn
• Application deployment target minimum of iOS 14 or above
• XCode 15 and above
• Cocoapods

Method One: Manual Integration

1. Go to the root folder of your app. 2. Create podfile using command: pod install 3. Open the Podfile and add 'AdaptiveCards' dependency. You can refer podfile from sample app.

5. Open the terminal and navigate to the root directory of your app to install the pods. Execute the following command in the terminal.
command : pod install
6. Manually download the xcframeworks from [releases](https://github.com/microsoft/ContactCenterMessagingSDK-ios/releases) section for desired version and add to the root folder of your app.
7. Open .xcworkspace in xcode.
8. Add the downloaded xcframeworks into your project. For adding XCframeworks
Click on your project -> Select 'Targets' -> Select 'General' -> Open 'Frameworks, Library and Embedded Content' -> Click on '+' icon -> Click on 'Add Other' -> Select 'Add Files' -> Select following xcframeworks
a. ContactCenterMessagingSDK.xcframework
b. ContactCenterMessagingWidget.xcframework
c. OmnichannelChatSDK.xcframework
9. Clean build and run the application.

### Method Two: Cocoapods
1. Go to the root folder of your app.
2. Create…