Amazon Connect Chat SDK for iOS

About

The Amazon Connect Chat SDK for iOS is a Swift library that gives you the power to easily integrate Amazon Connect Chat directly into your native iOS applications. The Amazon Connect Chat SDK helps handle client side chat logic and back-end communications similar to the Amazon Connect ChatJS Library. The SDK wraps the Amazon Connect Participant Service APIs and abstracts away the management of the chat session and WebSocket. This allows you to focus on the user interface and experience while relying on the Amazon Connect Chat SDK to interact with all the back-end services. This approach still requires using your own chat back end to call the Amazon Connect StartChatContact API to initiate contact. You can read instructions on how to quickly set up a StartChatContact Lambda from our startChatContactAPI example.

Installation Steps

There are three options to install the Amazon Connect Chat SDK for iOS to your xCode project:

Install via Cocoapods

In your Podfile:

    * Reference the AmazonConnectChatIOS pod in your Podfile
    * target 'YourProject' do
            pod 'AmazonConnectChatIOS'
            ...
        end

Then run pod install in your project's root directory

Install via Swift Package Manager

Open your project in Xcode
Go to File > Add Package Dependencies...
In the field Enter package repository URL, enter “https://github.com/amazon-connect/amazon-connect-chat-ios".
Select the desired target project and click Add Package

Download Binaries Directly from GitHub Releases

Go to the Amazon Connect Chat SDK for iOS GitHub Releases page.
Download the latest release of the AmazonConnectChatIOS.xcframework.
Unzip the downloaded file, if necessary.
Drag and drop the AmazonConnectChatIOS.xcframework into your Xcode project.

⚠️ Important: Please remember to add 'AWSCore' and 'AWSConnectParticipant' from AWS IOS SDK while using binaries.

How to Import the XCFramework

Once you have added the AmazonConnectChatIOS.xcframework to your project, you need to import it into your code. Here are the steps:

Import the Framework in Your Swift Code:
```
import AmazonConnectChatIOS
```

By following these steps, you can integrate the Amazon Connect Chat SDK for iOS into your project using CocoaPods, Swift Package Manager, or by directly adding the XCFramework. Make sure to follow the specific installation instructions for each method to ensure a smooth setup process.

Getting Started

The first step to leveraging the Amazon Connect Chat SDK after installation is to import the library into your file. Next, let's call the StartChatContact API and pass the response details into the SDK’s ChatSession object. Here is an example of how we would set this up in Swift. For reference, you can visit the iOSChatExample demo within the Amazon Connect Chat UI Examples GitHub repository.

The majority of the SDKs functionality will be accessed through the ChatSession object. In order to use this object in the file, we have to first import the AmazonConnectChatIOS library via:

import AmazonConnectChatIOS

Next, we can create a ChatManager class that helps bridge UI and SDK communication. This class should be responsible for managing interactions with the ChatSession object. We can either add it as a class property or reference it directly using ChatSession.shared.

class ChatManager: ObservableObject {
    private var chatSession = ChatSession.shared

    ...

Before using the chatSession object, we need to set the config for it via the GlobalConfig object. Most importantly, the GlobalConfig object will be used to set the AWS region that your Connect instance lives in. Here is an example of how to configure the ChatSession object:

init() {
    let globalConfig = GlobalConfig(region: .USEast1)
    self.chatSession = ChatSession.shared
    chatSession.configure(config: globalConfig)
    ...
}

From here, you are now ready to interact with the chat via the ChatSession object.

How to receive messages

The Amazon Connect Chat SDK for iOS provides two methods to receive messages.

Use ChatSession.onTranscriptUpdated

This event will pass back the entire transcript every time the transcript is updated. This will return the transcript via an array of TranscriptItem

Use ChatSession.onMessageReceived

This event will pass back each message that is received by the WebSocket. The event handler will be passed a single TranscriptItem.

How to handle events

The SDK provides event callbacks for chat experiences:

// Typing indicators
chatSession.onTyping = { event in
    print("Participant \(event.participant!) is typing...")
    // Show typing indicator in UI
}

// Message receipts
chatSession.onReadReceipt = { event in
    print("Message \(event.id) was read by participant \(event.participant!)")
    // Update message status to "Read"
}

chatSession.onDeliveredReceipt = { event in
    print("Message \(event.id) was delivered to participant \(event.participant!)")
    // Update message status to "Delivered"
}

// Participant state changes
chatSession.onParticipantIdle = { event in
    print("Participant \(event.displayName!) went idle")
    // Show idle indicator
}

chatSession.onParticipantReturned = { event in
    print("Participant \(event.displayName!) returned")
    // Hide idle indicator
}

// Chat lifecycle events
chatSession.onChatRehydrated = { event in
    print("Chat session restored from previous session")
    // Handle chat restoration
}

Event Property Reference

All events provide an Event object with these properties. Here's what's available in each event type:

Typing Events

chatSession.onTyping = { event in
    // Available properties:
    // - event.id: Event ID (String)
    // - event.timeStamp: When typing started (String, ISO 8601)
    // - event.participant: Participant role, e.g. "AGENT", "CUSTOMER" (String?)
    // - event.displayName: Participant's display name (String?)
    // - event.contentType: "application/vnd.amazonaws.connect.event.typing"
    // - event.eventDirection: .Common
}

Message Receipt Events

chatSession.onReadReceipt = { event in
    // Available properties:
    // - event.id: Receipt event ID (String)
    // - event.timeStamp: When message was read (String, ISO 8601)
    // - event.participant: Participant ID (UUID) who read the message (String?)
    // - event.displayName: nil (receipts don't have display names)
    // - event.contentType: "application/vnd.amazonaws.connect.event.message.read"
    // - event.eventDirection: .Incoming
    // - event.serializedContent["receipt"]: Original receipt data
    // - event.serializedContent["originalMessage"]: Original message metadata
}

chatSession.onDeliveredReceipt = { event in
    // Available properties:
    // - event.id: Receipt event ID (String)
    // - event.timeStamp: When message was delivered (String, ISO 8601)
    // - event.participant: Participant ID (UUID) who received the message (String?)
    // - event.displayName: nil (receipts don't have display names)
    // - event.contentType: "application/vnd.amazonaws.connect.event.message.delivered"
    // - event.eventDirection: .Incoming
    // - event.serializedContent["receipt"]: Original receipt data
    // - event.serializedContent["originalMessage"]: Original message metadata
}

Participant State Events

chatSession.onParticipantIdle = { event in
    // Available properties:
    // - event.id: Event ID (String)
    // - event.timeStamp: When participant went idle (String, ISO 8601)
    // - event.participant: Participant role, e.g. "AGENT", "CUSTOMER" (String?)
    // - event.displayName: Participant's display name (String?)
    // - event.contentType: "application/vnd.amazonaws.connect.event.participant.idle"
    // - event.eventDirection: .Common
}

chatSession.onParticipantReturned = { event in
    // Available properties:
    // - event.id: Event ID (String)
    // - event.timeStamp: When participant returned (String, ISO 8601)
    // - event.participant: Participant role, e.g. "AGENT", "CUSTOMER" (String?)
    // - event.displayName: Participant's display name (String?)
    // - event.contentType: "application/vnd.amazonaws.connect.event.participant.returned"
    // - event.eventDirection: .Common
}

chatSession.onAutoDisconnection = { event in
    // Available properties:
    // - event.id: Event ID (String)
    // - event.timeStamp: When auto-disconnection occurred (String, ISO 8601)
    // - event.participant: Participant role, e.g. "AGENT", "CUSTOMER" (String?)
    // - event.displayName: Participant's display name (String?)
    // - event.contentType: "application/vnd.amazonaws.connect.event.participant.autodisconnection"
    // - event.eventDirection: .Common
}

chatSession.onParticipantInvited = { event in
    // Available properties:
    // - event.id: Event ID (String)
    // - event.timeStamp: When participant was invited (String, ISO 8601)
    // - event.participant: Participant role, e.g. "AGENT", "CUSTOMER" (String?)
    // - event.displayName: Participant's display name (String?)
    // - event.contentType: "application/vnd.amazonaws.connect.event.participant.invited"
    // - event.eventDirection: .Common
}

Chat Lifecycle Events

chatSession.onChatRehydrated = { event in
    // Available properties:
    // - event.id: Event ID (String)
    // - event.timeStamp: When chat was rehydrated (String, ISO 8601)
    // - event.participant: Participant role, e.g. "AGENT", "CUSTOMER" (String?)
    // - event.displayName: Participant's display name (String?)
    // - event.contentType: "application/vnd.amazonaws.connect.event.chat.rehydrated"
    // - event.eventDirection: .Common
    // - event.serializedContent: Additional rehydration data
}

Important Note: Receipt events (onReadReceipt, onDeliveredReceipt) use event.participant for the participant ID (UUID format like "2171b970-42b8-471b-b999-3dee14efcd24"), while other events use it for the participant role ("AGENT", "CUSTOMER", etc.).

Advanced Configuration

Custom Client Implementation

The Amazon Connect Chat SDK for iOS supports custom client implementations to enable advanced networking scenarios such as:

Custom endpoint routing through proxy servers or API gateways
Custom header injection for authentication tokens, WAF bypass, or security headers
Certificate pinning for enhanced security in enterprise environments
Request/response transformation for compliance or monitoring requirements

Overview

By default, the SDK uses the standard AWS SDK HTTP client to communicate directly with Amazon Connect Participant Service APIs. For organizations requiring custom networking behavior, the SDK provides an inheritance-based system that allows you to subclass AWSClient and selectively override only the methods you need.

Flexible Override Options: You can choose to override all ACPS API methods for complete control, or override only specific methods while automatically inheriting default behavior for the rest.

Implementation Steps

1. Subclass AWSClient

Create a custom client class that inherits from AWSClient and override the methods you need:

Option A: Partial Override

import AmazonConnectChatIOS
import AWSConnectParticipant

class MyCustomClient: AWSClient {
    
    // Only override the methods you need to customize
    override func createParticipantConnection(participantToken: String, completion: @escaping (Result<ConnectionDetails, Error>) -> Void) {
        // Add custom logging/monitoring
        print("Custom client: Routing createParticipantConnection through proxy")
        
        // Call parent implementation to use default AWS behavior
        super.createParticipantConnection(participantToken: participantToken, completion: completion)
    }
    
    override func sendMessage(connectionToken: String, contentType: ContentType, message: String, completion: @escaping (Result<AWSConnectParticipantSendMessageResponse, Error>) -> Void) {
        // Add custom message filtering or transformation
        let filteredMessage = applyCustomFilters(message)
        
        // Call parent implementation with modified message
        super.sendMessage(connectionToken: connectionToken, contentType: contentType, message: filteredMessage, completion: completion)
    }
    
    // Other methods automatically use parent AWSClient implementation
    // No need to implement them unless you need custom behavior
}

Option B: Complete Override (For full control)

class MyFullCustomClient: AWSClient {
    
    // Override ALL ACPS methods with completely custom implementations
    override func createParticipantConnection(participantToken: String, completion: @escaping (Result<ConnectionDetails, Error>) -> Void) {
        // Completely custom implementation - route through your proxy
        let customRequest = buildCustomRequest(
            endpoint: "https://your-proxy.example.com/participant-connection",
            token: participantToken
        )
        executeRequest(customRequest) { result in
            completion(result)
        }
    }
    
    override func sendMessage(connectionToken: String, contentType: ContentType, message: String, completion: @escaping (Result<AWSConnectParticipantSendMessageResponse, Error>) -> Void) {
        // Completely custom message routing
    }
    
    override func sendEvent(connectionToken: String, contentType: ContentType, content: String, completion: @escaping (Result<AWSConnectParticipantSendEventResponse, Error>) -> Void) {
        // Completely custom event routing
    }
    
    override func getTranscript(getTranscriptArgs: AWSConnectParticipantGetTranscriptRequest, completion: @escaping (Result<AWSConnectParticipantGetTranscriptResponse, Error>) -> Void) {
        // Completely custom transcript retrieval
    }
    
    override func disconnectParticipantConnection(connectionToken: String, completion: @escaping (Result<AWSConnectParticipantDisconnectParticipantResponse, Error>) -> Void) {
        // Completely custom disconnect
    }
    
    override func startAttachmentUpload(connectionToken: String, contentType: String, attachmentName: String, attachmentSizeInBytes: Int, completion: @escaping (Result<AWSConnectParticipantStartAttachmentUploadResponse, Error>) -> Void) {
        // Completely custom attachment upload start
    }
    
    override func completeAttachmentUpload(connectionToken: String, attachmentIds: [String], completion: @escaping (Result<AWSConnectParticipantCompleteAttachmentUploadResponse, Error>) -> Void) {
        // Completely custom attachment upload completion
    }
    
    override func getAttachment(connectionToken: String, attachmentId: String, completion: @escaping (Result<AWSConnectParticipantGetAttachmentResponse, Error>) -> Void) {
        // Completely custom attachment download
    }
    
    override func describeView(connectionToken: String, viewToken: String, completion: @escaping (Result<AWSConnectParticipantDescribeViewResponse, Error>) -> Void) {
        // Completely custom view resource retrieval
    }
}

2. Configure ChatSession with Custom Client

Inject your custom client into the ChatSession via GlobalConfig:

import AmazonConnectChatIOS

class ChatManager: ObservableObject {
    private var chatSession = ChatSession.shared
    private let customClient = MyCustomClient()
    
    init() {
        // Configure with custom client
        let globalConfig = GlobalConfig(
            region: .USEast1,
            customAWSClient: customClient
        )
        chatSession.configure(config: globalConfig)
    }
}

3. Available Override Methods

Your custom client can override any or all of these ACPS methods from the AWSClient base class:

Method	Purpose	Required Parameters
`createParticipantConnection`	Establish chat session	`participantToken`
`sendMessage`	Send chat messages	`connectionToken`, `contentType`, `message`
`sendEvent`	Send typing indicators and events	`connectionToken`, `contentType`, `content`
`getTranscript`	Retrieve chat history	`getTranscriptArgs`
`disconnectParticipantConnection`	End chat session	`connectionToken`
`startAttachmentUpload`	Initiate file uploads	`connectionToken`, `contentType`, `attachmentName`, `attachmentSizeInBytes`
`completeAttachmentUpload`	Complete file uploads	`connectionToken`, `attachmentIds`
`getAttachment`	Download attachments	`connectionToken`, `attachmentId`
`describeView`	Retrieve view resource metadata	`connectionToken`, `viewToken`

Use Cases

Enterprise Proxy Routing

// Route all API calls through corporate proxy
func createParticipantConnection(participantToken: String, completion: @escaping (Result<ConnectionDetails, Error>) -> Void) {
    let proxyURL = "https://corporate-proxy.company.com/connect-participant"
    let request = URLRequest(url: URL(string: proxyURL)!)
    // Add corporate authentication headers
    request.setValue("Bearer \(corporateToken)", forHTTPHeaderField: "Authorization")
    // Execute request through proxy
}

WAF Token Injection

// Add WAF bypass tokens to all requests
func sendMessage(connectionToken: String, contentType: ContentType, message: String, completion: @escaping (Result<AWSConnectParticipantSendMessageResponse, Error>) -> Void) {
    var request = buildStandardRequest(connectionToken, contentType, message)
    // Inject WAF token
    request.setValue(wafToken, forHTTPHeaderField: "X-WAF-Token")
    executeRequest(request, completion: completion)
}

Certificate Pinning

class SecureCustomClient: AWSClient, URLSessionDelegate {
    
    func urlSession(_ session: URLSession, didReceive challenge: URLAuthenticationChallenge, completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) {
        // Implement certificate pinning validation
        if validateCertificatePinning(challenge.protectionSpace.serverTrust) {
            completionHandler(.useCredential, URLCredential(trust: challenge.protectionSpace.serverTrust!))
        } else {
            completionHandler(.cancelAuthenticationChallenge, nil)
        }
    }
}

Important Considerations

Flexible Override: You can override all ACPS methods for complete control, or selectively override only the methods you need. Non-overridden methods automatically use the parent AWSClient implementation.
Backward Compatibility: Custom client implementation is completely optional. Existing applications continue to work unchanged when not using a custom client.
Calling Parent Methods: You can call super.methodName() from your overridden methods to use the default AWS implementation while adding custom behavior (logging, monitoring, etc.).
Full Responsibility for Overridden Methods: When you override a method without calling super, your implementation becomes fully responsible for that API interaction including error handling, retries, authentication, and response parsing.
Token Security: The SDK treats participant tokens as opaque strings. Your custom client receives these tokens and is responsible for secure handling.
Error Handling: Implement proper error handling and retry logic in your custom client to ensure reliable chat functionality.
Performance: Custom clients should maintain low latency (<100ms additional overhead recommended) to preserve real-time chat experience.
Testing: Thoroughly test your custom client implementation across all ACPS API methods and error scenarios.

API List

GlobalConfig

The GlobalConfig object is used to configure both the AWS ConnectParticipant client as well as some of the chat behavior.

`GlobalConfig.init`

The initializer for the GlobalConfig object takes in the AWSRegionType, the enabled Features and disableCSM flag to disable metrics.

public struct GlobalConfig {
    public var region: AWSRegionType
    public var features: Features
    public var disableCsm: Bool

    public static var defaultRegion: AWSRegionType {
        return Constants.DEFAULT_REGION
    }

    // Initializes a new global configuration with optional custom settings or defaults
    public init(region: AWSRegionType = defaultRegion, features: Features = .defaultFeatures, disableCsm: Bool = false) {
        self.region = region
        self.features = features
        self.disableCsm = disableCsm
    }
}

region
- This property is used to set the region of the ConnectParticipant client. This should be set to the region of your Connect instance (e.g. .USEast1)
- Type: AWSRegionType
features: Features
- The features property dictates the enablement of certain features as well as their configurations. If no value is passed for this property, the chat will be configured with default values. See Features for more details.
- Type: Features

Updating configuration

If you have set the GlobalConfig object or want to update the configurations, you can call ChatSession.configure to update the config object.

let globalConfig = GlobalConfig(region: .USEast1)
chatSession.configure(config: globalConfig)

SDKLogger

The SDKLogger class is responsible for logging relevant runtime information to the console which is useful for debugging purposes. The SDKLogger will log key events such as establishing a connection or failures such as failing to send a message. By default, logging is disabled and can be enabled/disabled at runtime.

Enabling/Disabling Logging

You can toggle logging on/off using the isLoggingEnabled flag:

// Enable logging
SDKLogger.isLoggingEnabled = true

// Disable logging
SDKLogger.isLoggingEnabled = false

`SDKLogger.configure`

This API will allow you to override the SDK's built-in logger with your own SDKLoggerProtocol implementation. This is especially useful in cases where you would want to store logs for debugging purposes. Attaching these logs to issues filed in this project will greatly expedite the resolution process.

public static func configureLogger(_ logger: SDKLoggerProtocol) {
    SDKLogger.logger = logger
}

SDKLoggerProtocol

The SDKLoggerProtocol is a protocol used for the SDKLogger. Users can override the SDKLogger with any class that implements SDKLoggerProtocol.

public protocol SDKLoggerProtocol {
    func logVerbose(
        _ message: @autoclosure () -> String
    )
    func logInfo(
        _ message: @autoclosure () -> String
    )
    func logDebug(
        _ message: @autoclosure () -> String
    )
    func logFault(
        _ message: @autoclosure () -> String
    )
    func logError(
        _ message: @autoclosure () -> String
    )
}

ChatSession APIs

`ChatSession.configure`

Configures the chat service with a GlobalConfiguration object.

func configure(config: GlobalConfig)

config
- The global configuration to use
- Type: GlobalConfig

`ChatSession.getConnectionDetailsProvider`

Returns a ConnectionDetailsProvider object that includes connection details.

fun getConnectionDetailsProvider(): ConnectionDetailsProvider

Return type: ConnectionDetailsProvider

`ChatSession.connect`

Attempts to connect to a chat session with the given details.

func connect(chatDetails: ChatDetails, completion: @escaping (Result<Void, Error>) -> Void)

public struct ChatDetails {
    var contactId: String?
    var participantId: String?
    var participantToken: String
}

chatDetails
- The details of the chat session to connect to. ChatDetails data is extracted from StartChatContact response.
- Type: ChatDetails
completion
- The completion handler to call when the connect operation is complete.
- Type: (Result<Void, Error>) -> Void

`ChatSession.disconnect`

Disconnects the current chat session.

func disconnect(completion: @escaping (Result<Void, Error>) -> Void)

completion
- The completion handler to call when the disconnect operation is complete.
- Type: (Result<Void, Error>) -> Void

`ChatSession.reset`

Resets the ChatSession object which will disconnect the webSocket and remove all session related data without disconnecting the participant from the chat contact.

func reset()

`ChatSession.suspendWebSocketConnection`

Disconnects the websocket and suspends reconnection attempts.

func suspendWebSocketConnection()

`ChatSession.resumeWebSocketConnection`

Resumes a suspended websocket and attempts to reconnect.

func resumeWebSocketConnection()

`ChatSession.sendMessage`

Sends a message within the chat session.

func sendMessage(contentType: ContentType, message: String, completion: @escaping (Result<Void, Error>) -> Void)

contentType
- The type of the message content.
- Type: ContentType
message
- The message to send.
- Type: String
completion
- The completion handler to call when the send operation is complete.
- Type: (Result<Void, Error>) -> Void

`ChatSession.sendEvent`

Sends an event within the chat session.

func sendEvent(event: ContentType, content: String, completion: @escaping (Result<Void, Error>) -> Void)

event
- The type of the event content.
- Type: ContentType
content
- The event content to send.
- Type: String
completion
- The completion handler to call when the send operation is complete.
- Type: (Result<Void, Error>) -> Void

`ChatSession.sendMessageReceipt`

Sends read receipt for a message.

func sendMessageReceipt(event: MessageReceiptType, messageId: String, completion: @escaping (Result<Void, Error>) -> Void)

event
- The type of read receipt to send (either .messageDelivered or .messageRead
- Type: MessageReceiptType
- Default: .messageRead
messageId
- The ID of the message to acknowledge.
- Type: String
completion
- The completion handler to call when the send operation is complete.
- Type: (Result<Void, Error>) -> Void

`ChatSession.getTranscript`

Retrieves the chat transcript.

func getTranscript(scanDirection: AWSConnectParticipantScanDirection?, sortOrder: AWSConnectParticipantSortKey?, maxResults: NSNumber?, nextToken: String?, startPosition: AWSConnectParticipantStartPosition?, completion: @escaping (Result<TranscriptResponse, Error>) -> Void)

scanDirection
- The direction to scan the transcript.
- Type: AWSConnectParticipantScanDirection? (String: 'FORWARD' | 'BACKWARD')
- Default: BACKWARD
sortOrder
- The order to sort the transcript.
- Type: AWSConnectParticipantSortKey? (String: 'DESCENDING | 'ASCENDING')
- Default: ASCENDING
maxResults
- The maximum number of results to retrieve.
- Type: NSNumber?
- Default: 15
nextToken
- Type: String
- The token for the next set of results.
startPosition
- The start position for the transcript.
- Type: AWSConnectParticipantStartPosition?. See StartPosition
completion
- The completion handler to call when the transcript retrieval is complete.
- Type: (Result<TranscriptResponse, Error>) -> Void

`ChatSession.sendAttachment`

Sends an attachment within the chat session.

func sendAttachment(file: URL, completion: @escaping (Result<Void, Error>) -> Void)

file
- The URL of the file to attach.
- Type: URL
completion
- The completion handler to call when the send operation is complete.
- Type: (Result<Void, Error>) -> Void

`ChatSession.downloadAttachment`

Downloads an attachment to the app's temporary directory given an attachment ID.

func downloadAttachment(attachmentId: String, filename: String, completion: @escaping (Result<URL, Error>) -> Void)

attachmentId
- The ID of the attachment to download.
- Type: String
filename
- The name of the file to save the attachment as.
- Type: String
completion
- The completion handler to call when the download operation is complete.
- Type: (Result<URL, Error>) -> Void

`ChatSession.getAttachmentDownloadUrl`

Returns the download URL link for the given attachment ID.

func getAttachmentDownloadUrl(attachmentId: String, completion: @escaping (Result<URL, Error>) -> Void)

attachmentId
- The ID of the attachment.
- Type: String
completion
- The completion handler to call when the URL retrieval is complete.
- Type: (Result<URL, Error>) -> Void

`ChatSession.resendFailedMessage`

Retry a text message or attachment that failed to be sent.

func resendFailedMessage(messageId: String, completion: @escaping (Result<Void, Error>) -> Void)

messageId
- messageId The Id of the message that failed to be sent.
- Type: String

`ChatSession.describeView`

Retrieves a view resource object containing metadata and content necessary to render the view.

func describeView(viewToken: String, completion: @escaping (Result<ViewResource, Error>) -> Void)

viewToken
- An encrypted token originating from the interactive message of a ShowView block operation.
- Type: String
completion
- The completion handler to call when the view retrieval is complete.
- Type: (Result<ViewResource, Error>) -> Void

`ChatSession.isChatSessionActive`

Returns a boolean indicating whether the chat session is still active.

func isChatSessionActive() -> Bool

ChatSession Events

`ChatSession.onConnectionEstablished`

Callback for when the connection is established.

var onConnectionEstablished: (() -> Void)? { get set }

`ChatSession.onConnectionBroken`

Callback for when the connection is broken.

var onConnectionBroken: (() -> Void)? { get set }

`ChatSession.onMessageReceived`

Callback for when a WebSocket message is received. See TranscriptItem.

var onMessageReceived: ((TranscriptItem) -> Void)? { get set }

`ChatSession.onTranscriptUpdated`

Callback for when the transcript is updated. See TranscriptData

var onTranscriptUpdated: ((TranscriptData) -> Void)? { get set }

`ChatSession.onChatEnded`

Callback for when the chat ends.

var onChatEnded: (() -> Void)? { get set }

`ChatSession.onDeepHeartbeatFailure`

Callback for when the WebSocket heartbeat is missed.

var onDeepHeartbeatFailure: (() -> Void)? { get set }

`ChatSession.onConnectionReEstablished`

Callback for when the connection is re-established.

var onConnectionReEstablished: (() -> Void)? { get set }

`ChatSession.onParticipantIdle`

Callback for when a participant becomes idle.

var onParticipantIdle: ((Event) -> Void)? { get set }

`ChatSession.onParticipantReturned`

Callback for when a participant returns from idle state.

var onParticipantReturned: ((Event) -> Void)? { get set }

`ChatSession.onAutoDisconnection`

Callback for when a participant is automatically disconnected due to inactivity.

var onAutoDisconnection: ((Event) -> Void)? { get set }

`ChatSession.onTyping`

Callback for when a participant is typing.

var onTyping: ((Event) -> Void)? { get set }

`ChatSession.onReadReceipt`

Callback for when a message read receipt is received.

var onReadReceipt: ((Event) -> Void)? { get set }

`ChatSession.onDeliveredReceipt`

Callback for when a message delivered receipt is received.

var onDeliveredReceipt: ((Event) -> Void)? { get set }

`ChatSession.onParticipantInvited`

Callback for when a participant is invited to the chat.

var onParticipantInvited: ((Event) -> Void)? { get set }

`ChatSession.onChatRehydrated`

Callback for when a chat session is rehydrated (restored from a previous session).

var onChatRehydrated: ((Event) -> Void)? { get set }

Classes and Structs

Features

Features are a list of optional chat functions that users may choose to enable, disable or reconfigure.

public struct Features {
    public var messageReceipts: MessageReceipts

    // Provides default Features configuration
    public static var defaultFeatures: Features {
        return Features(messageReceipts: .defaultReceipts)
    }

    public init(messageReceipts: MessageReceipts = .defaultReceipts) {
        self.messageReceipts = messageReceipts
    }
}

the default value for Features will contain the default values for all containing features.

Message Receipts

This feature enables the use of Read and Delivered receipts for messages. This is used to indicate whether agents have read texts that the client has sent and vice versa.

public struct MessageReceipts {
    public var shouldSendMessageReceipts: Bool
    public var throttleTime: Double
    
    // Provides default MessageReceipts configuration
    public static var defaultReceipts: MessageReceipts {
        return MessageReceipts(shouldSendMessageReceipts: true, throttleTime: Constants.MESSAGE_RECEIPT_THROTTLE_TIME)
    }
    
    public init(shouldSendMessageReceipts: Bool, throttleTime: Double) {
        self.shouldSendMessageReceipts = shouldSendMessageReceipts
        self.throttleTime = throttleTime
    }
}

shouldSendMessageReceipts
- Type: Bool
- This is the flag that dictates whether message receipts will be sent from the client side. Note that this will not block message receipt events from being sent from the agent.
- Default: true
throttleTime
- Type: Double
- This is used to determine how long to throttle message receipt events before firing them. We recommend having at least some throttling time before each event to reduce unecessary network requests
- Default: 5.0

ChatDetails

public struct ChatDetails {
    var contactId: String?
    var participantId: String?
    var participantToken: String
}

contactId
- Contact identifier received via StartChatContact response
- Type: String
particpantId
- Participant identifier received via StartChatContact response
- Type: String
participantToken
- Participant token received via StartChatContact response
- Type: String

ConnectionDetailsProvider

public protocol ConnectionDetailsProviderProtocol {
    func updateChatDetails(newDetails: ChatDetails)
    func getConnectionDetails() -> ConnectionDetails?
    func updateConnectionDetails(newDetails: ConnectionDetails)
    func getChatDetails() -> ChatDetails?
    func isChatSessionActive() -> Bool
    func setChatSessionState(isActive: Bool) -> Void
}

updateChatDetails
- Updates chat details
- newDetails
  - Type: ChatDetails
getConnectionDetails
- Gets connection details received via CreateParticipantConnection response
- Return type: ConnectionDetails
updateConnectionDetails
- Updates connection details
- newDetails
  - Type: ConnectionDetails
getChatDetails
- Gets chat details
- Return type: ChatDetails
isChatSessionActive
- Gets chat session active state
- Return type: Boolean
setChatSessionState
- Sets chat session state
- isActive
  - Type: Boolean

ConnectionDetails

public struct ConnectionDetails {
    public func getWebsocketUrl() -> String?
    public func getConnectionToken() -> String?
    public func getExpiry() -> Date?
}

getWebsocketUrl
- Returns URL of the websocket received via CreateParticipantConnection response
- Return type: String
getConnectionToken
- Returns connection token received via CreateParticipantConnection response
- Return type: String
getExpiry
- Returns expiration of the token received via CreateParticipantConnection response
- Return type: Date

ContentType

ContentType describe the type of events and messages that come through the WebSocket.

public enum ContentType: String {
    case typing = "application/vnd.amazonaws.connect.event.typing"
    case connectionAcknowledged = "application/vnd.amazonaws.connect.event.connection.acknowledged"
    case messageDelivered = "application/vnd.amazonaws.connect.event.message.delivered"
    case messageRead = "application/vnd.amazonaws.connect.event.message.read"
    case metaData = "application/vnd.amazonaws.connect.event.message.metadata"
    case joined = "application/vnd.amazonaws.connect.event.participant.joined"
    case left = "application/vnd.amazonaws.connect.event.participant.left"
    case ended = "application/vnd.amazonaws.connect.event.chat.ended"
    case participantIdle = "application/vnd.amazonaws.connect.event.participant.idle"
    case participantReturned = "application/vnd.amazonaws.connect.event.participant.returned"
    case participantInvited = "application/vnd.amazonaws.connect.event.participant.invited"
    case autoDisconnection = "application/vnd.amazonaws.connect.event.participant.autodisconnection"
    case participantDisplayNameUpdated = "application/vnd.amazonaws.connect.event.participant.displayname.updated"
    case chatRehydrated = "application/vnd.amazonaws.connect.event.chat.rehydrated"
    case plainText = "text/plain"
    case richText = "text/markdown"
    case interactiveText = "application/vnd.amazonaws.connect.message.interactive"
}

MessageReceiptType

MessageReceiptType is a subset of ContentType for message receipt related events.

public enum MessageReceiptType: String {
    case messageDelivered = "application/vnd.amazonaws.connect.event.message.delivered"
    case messageRead = "application/vnd.amazonaws.connect.event.message.read"
}

TranscriptResponse

public class TranscriptResponse: Equatable {
    public let initialContactId: String
    public let nextToken: String
    public var transcript: [TranscriptItem]
}

initialContactId
- This is the id of the chat contact
- Type: String
nextToken
- The nextToken is used to retrieve the next batch of messages from the server. This can be passed into ChatSession.getTranscript
- Type: String
transcript
- This contains the messages that were loaded
- Type: Array of TranscriptItem

TranscriptItem

This is the base class for all renderable messages in the transcript.

public class TranscriptItem: TranscriptItemProtocol {
    public var id: String
    public var timeStamp: String
    public var contentType: String
    public var serializedContent: [String: Any]?
    public var viewResource: ViewResource?
    public var persistentId: String
}

id
- Id for the message. Unique to each message in the transcript. Id can be used only for the ACPS APIs requests.
- Type: String
timeStamp
- Time when the message or event was sent. Formatted in ISO 8601 (e.g. yyyy-MM-ddThh:mm:ss.SSSZ or 2019-11-08T02:41:28.172Z)
- Type: String
contentType
- The type of message
- Type: String (See ContentType
serializedContent
- The raw JSON format of the received WebSocket message
- Type: Array of String: Any
viewResource
- Structured ViewResource data for interactive messages with templateType "ViewResource". Contains schema information including Actions, InputSchema, and Template. This property is nil for non-ViewResource messages.
- Type: ViewResource? (See ViewResource)
persistentId
- Id for the message, Unique to each message throughout chat session. This can be used only for tracking purposes by the client.
- Type: String

TranscriptData

This is the object that is passed back to the registered ChatSession.onTranscriptUpdated event handler

public struct TranscriptData {
    public let transcriptList: [TranscriptItem]
    public let previousTranscriptNextToken: String?
}

transcriptList
- The current in-memory transcript list.
- Type: Array of TranscriptItem
previousTranscriptNextToken
- This is a next token that is used as a getTranscript argument to retrieve older messages. This will be nil if there are no more available messages to fetch from the top of the currently loaded transcript.
- Type: String

Message (extends TranscriptItem)

The Message type of TranscriptItem is reserved for all messages sent by bots, contact flow or other participants. This includes interactive messages, attachments and plain text messages.

public class Message: TranscriptItem, MessageProtocol {
    public var participant: String
    public var text: String
    public var messageDirection: MessageDirection?
    public var attachmentId: String?
    public var displayName: String?
    @Published public var metadata: (any MetadataProtocol)?
}

participant
- This is the participant role of the message sender (e.g. AGENT)
- Type: String
text
- This is the text content of the message
- Type: String
messageDirection
- This is the direction of the message
- Type: MessageDirection (Outgoing | Incoming | Common)
attachmentId
- This is the id of the attachment. Only defined if this message contains an attachment.
- Type: String
displayName
- This is the display name of the message
- Type: String
metadata
- This is the metadata associated with the message.
- Type: Metadata

Event (extends TranscriptItem)

The Event type of the TranscriptItem is for events that come through the WebSocket. See ContentType for a list of possible events.

public class Event: TranscriptItem, EventProtocol {
    public var participant: String?
    public var text: String?
    public var displayName: String?
    public var eventDirection: MessageDirection?
}

participant
- This is the participant role of the message sender (e.g. AGENT)
- Type: String?
text
- This is the text content of the event
- Type: String?
displayName
- This is the display name of the event
- Type: String
eventDirection
- This is the direction of the event
- Type: eventDirection (Outgoing | Incoming | Common)

Metadata (extends TranscriptItem)

The Metadata event is used to receive additional data on a given message such as message receipt status.

public class Metadata: TranscriptItem, MetadataProtocol {
    @Published public var status: MessageStatus?
    @Published public var eventDirection: MessageDirection?

status
- This is the receipt status for the event.
- Type: MessageStatus ('Read' | 'Delivered')
eventDirection
- This is the direction of the metadata event.
- Type: eventDirection (Outgoing | Incoming | Common)

ViewResource

Contains structured schema data for ViewResource interactive messages. This data is automatically extracted and populated in the viewResource property of TranscriptItem for messages with templateType "ViewResource".

public struct ViewResource {
    public let id: String?
    public let name: String?
    public let arn: String?
    public let version: Int?
    public let content: [String: Any]?
}

id
- The ViewResource identifier (typically an ARN)
- Type: String?
content
- Dictionary containing ViewResource schema fields:
  - Actions: Array of available actions
  - InputSchema: JSON schema for input validation
  - Template: UI template structure with form fields and components
- Type: [String: Any]?

Example Usage:

chatSession.onMessageReceived = { transcriptItem in
    if let viewResource = transcriptItem.viewResource,
       let content = viewResource.content {
        let actions = content["Actions"]
        let inputSchema = content["InputSchema"]
        let template = content["Template"]
        // Use schema data to render interactive UI
    }
}

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

Name		Name	Last commit message	Last commit date
Latest commit History 148 Commits
.github		.github
AmazonConnectChatIOS.xcodeproj		AmazonConnectChatIOS.xcodeproj
AmazonConnectChatIOS		AmazonConnectChatIOS
AmazonConnectChatIOSTests/Core		AmazonConnectChatIOSTests/Core
Sources		Sources
Tests/AmazonConnectChatIOSTests		Tests/AmazonConnectChatIOSTests
.gitignore		.gitignore
AmazonConnectChatIOS.podspec		AmazonConnectChatIOS.podspec
AmazonConnectChatIOS.xctestplan		AmazonConnectChatIOS.xctestplan
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
NOTICE		NOTICE
Package.swift		Package.swift
README.md		README.md

License

amazon-connect/amazon-connect-chat-ios

Folders and files

Latest commit

History

Repository files navigation

Amazon Connect Chat SDK for iOS

Table of Contents

About

Installation Steps

Install via Cocoapods

Install via Swift Package Manager

Download Binaries Directly from GitHub Releases

How to Import the XCFramework

Getting Started

How to receive messages

How to handle events

Event Property Reference

Typing Events

Message Receipt Events

Participant State Events

Chat Lifecycle Events

Advanced Configuration

Custom Client Implementation

Overview

Implementation Steps

Use Cases

Important Considerations

API List

GlobalConfig

GlobalConfig.init

Updating configuration

SDKLogger

Enabling/Disabling Logging

SDKLogger.configure

SDKLoggerProtocol

ChatSession APIs

ChatSession.configure

ChatSession.getConnectionDetailsProvider

ChatSession.connect

ChatSession.disconnect

ChatSession.reset

ChatSession.suspendWebSocketConnection

ChatSession.resumeWebSocketConnection

ChatSession.sendMessage

ChatSession.sendEvent

ChatSession.sendMessageReceipt

ChatSession.getTranscript

ChatSession.sendAttachment

ChatSession.downloadAttachment

ChatSession.getAttachmentDownloadUrl

ChatSession.resendFailedMessage

ChatSession.describeView

ChatSession.isChatSessionActive