iOS Chatbot SDK

Requirements

Installation

Manual XCFramework

1. Copy dialogs_Chatbot_iOS.xcframework into your Xcode project
2. In Xcode → Target → General → Frameworks, Libraries, and Embedded Content
3. Add dialogs_Chatbot_iOS.xcframework → set to Embed & Sign

Swift Package Manager

// Package.swift
.binaryTarget(
    name: "dialogs_Chatbot_iOS",
    url: "https://your-release-url/dialogs_Chatbot_iOS.xcframework.zip",
    checksum: "YOUR_CHECKSUM_HERE"
)

Project Setup

Info.plist Permissions

Add the following keys to your Info.plist if you enable media/file attachments:

<key>NSCameraUsageDescription</key>
<string>Required to take photos and videos for the chat bot</string>

<key>NSPhotoLibraryUsageDescription</key>
<string>Required to attach images and videos from your library</string>

<key>NSMicrophoneUsageDescription</key>
<string>Required for audio and video calls</string>

App Transport Security

The SDK connects to remote bot servers over HTTPS. Ensure ATS is not blocking your bot's host domain.

Step 1 — Import

import dialogs_Chatbot_iOS

Step 2 — Create Configuration

let config = EnxBotConfiguration(
    botId:       "YOUR_BOT_ID",      // from EnableX/Dialogs dashboard
    host:        "https://dialogs.enablex.io",
    path:        "",                  // optional, leave empty if not needed
    callingView: false               // true = click-to-call UI
)

Step 3 — Connect and Display

class ViewController: UIViewController {

    var botView: EnxBotContainerView!

    override func viewDidLoad() {
        super.viewDidLoad()

        botView = EnxChatClient.connect(
            configuration: config,
            eventListner: self
        )
        botView.attach(to: self.view)
    }
}

Step 4 — Handle Delegate

extension ViewController: EnxChatClientDelegate {
    func didBotConnected(_ botInfo: [String: Any]) {
        print("Bot name:", botInfo["name"] ?? "")
    }
}

Chat Mode vs Click-to-Call Mode

The SDK supports two distinct UI modes controlled by EnxBotConfiguration.callingView.

Chat Mode (callingView: false)

• Displays the full chat interface (message list + input bar)
• Input bar includes attachment options: camera, photo, video, file
• Bot can send: text, images, videos, files, suggestions, action cards, date picker
• User can send: text messages + media attachments

Click-to-Call Mode (callingView: true)

• Displays a full-screen click-to-call interface
• Shows a large call button; tapping sends "Hi" to start the bot flow
• Bot responds with handover status updates displayed on screen
• When bot triggers a call, a floating WebView appears with the video/audio session
• Use EnxChatClient.getCallingView() to get audio/video call buttons for the navigation bar

// Click-to-Call setup
let config = EnxBotConfiguration(
    botId: "YOUR_BOT_ID",
    host:  "https://dialogs.enablex.io",
    callingView: true
)
let botView = EnxChatClient.connect(configuration: config, eventListner: self)
botView.attach(to: self.view)

// Add call buttons to nav bar
let callingView = EnxChatClient.getCallingView()
navigationItem.rightBarButtonItem = UIBarButtonItem(customView: callingView)

Resetting the Bot

To clear the current conversation and restart:

botView.resetBot()

This sends a JavaScript command to the embedded WebView to call resetConversation() or equivalent on the bot engine.

Supported Message Types

Supported Media Types

Sending (User → Bot)

Receiving (Bot → User)

Architecture Overview

┌─────────────────────────────────────────────────────┐
│                   Host Application                   │
│                                                      │
│   ViewController  ──────────────────────────────┐   │
│        │                                        │   │
│        │ EnxChatClient.connect(...)             │   │
│        ▼                                        │   │
├─────────────────────────────────────────────────┤   │
│              EnxChatClient (Static API)         │   │
│        │                                        │   │
│        ▼                                        ▼   │
│  EnxBotContainerView         EnxChatClientDelegate  │
│   ├── EnxChatListView               ▲               │
│   ├── EnxChatInputView              │               │
│   ├── EnxClickToCallingView   didBotConnected(...)  │
│   ├── EnxVideoContainerView         │               │
│   └── EnxBotWebViewManager ─────────┘               │
│         ├── WKWebView                               │
│         └── EnxBotJSBridgeManager                  │
│               └── WKScriptMessageHandler            │
└─────────────────────────────────────────────────────┘

Data Flow

User types → EnxChatInputView → EnxBotWebViewManager.sendMessage()
                                        │
                                        ▼
                                  WKWebView (JS)
                                  sendMessageToBot()
                                        │
                                   Bot Server
                                        │
                                        ▼
                                  WKScriptMessageHandler
                                  EnxBotJSBridgeManager
                                        │
                                        ▼
                                 EnxBotWebViewManager
                                  onBotMessage callback
                                        │
                                        ▼
                                EnxBotResponseParser
                                        │
                                        ▼
                                 EnxChatListView
                                 (renders message)

Component Descriptions

Feature Support (v1.0.0)

Error Handling

The SDK handles most errors internally. The host app does not need error handling for normal flows.

FAQ

Can I add the bot view without using attach(to:)?

Yes. attach(to:) is a convenience helper. You can add EnxBotContainerView to your view hierarchy manually and set constraints yourself.

Can I use the SDK with multiple bots simultaneously?

Not in the current version. EnxChatClient uses static properties — only one bot connection is supported per app session.

Does the SDK support Objective-C?

Yes. EnxChatClient, EnxBotConfiguration, EnxBotContainerView, and EnxCallingView are annotated with @objcMembers and public visibility, making them accessible from Objective-C.

How large can attachments be?

The SDK compresses images to ~30% of original size before sending. Videos and files are sent at original size. There is no hard limit enforced by the SDK — limits are applied server-side.

What happens if callingView is set to true but the bot does not support calling?

The click-to-call UI is displayed, but calling buttons will be inert since no audio_video_action events will be received from the bot.

How do I customise the UI?

UI customisation is not available in the public API in v1.0. The SDK renders its own complete UI.