Zum Inhalt springen

iOS-SDK

Aktualisiert am

Das iOS-SDK von ChatFrom bringt Ihren Chatbot in Ihre eigene iPhone- und iPad-App: als Chat-Bubble in einer Ecke oder als Zeile in einer Liste. Ein Tippen darauf öffnet den Chat, auf dem iPhone im Vollbild und auf dem iPad als Karte, mit demselben Wissen, denselben Tools und Workflows wie auf Ihrer Website, und alle Unterhaltungen landen im selben Protokoll.

So funktioniert es

Die Bubble und die Kopfzeile des Chats zeichnet die App selbst, in der Farbe, dem Icon, der Größe und der Ecke, die Sie unter Einbinden gewählt haben. Der Chat darin ist die eigene Chatseite von ChatFrom, sodass Verbesserungen dort ohne neues Release in Ihre App gelangen. Nutzer können Dateien anhängen, Links folgen, die sich außerhalb Ihrer App öffnen, und dort weitermachen, wo sie aufgehört haben.

Der Chat braucht iOS 16.4 oder neuer. Das Paket lässt sich auch in eine App einbauen, die noch iOS 15 unterstützt: Auf Geräten mit einer älteren Version als iOS 16.4 zeigt es keine Bubble, seine Zeilen sind grau, und ChatFrom.isSupported sagt, welcher Fall auf einem Gerät gilt.

Bevor Sie beginnen

  1. Öffnen Sie in ChatFrom Ihren Chatbot, gehen Sie zu Einbinden und schalten Sie Mobile Apps ein. Schalten Sie ihn dann live. Ein Chatbot, der nicht live ist oder nicht für Apps freigegeben ist, zeigt keine Bubble.
  2. Kopieren Sie die ID des Chatbots aus seiner Adresse im Dashboard: den Teil nach /dashboard/.

Wer die ID eines Chatbots hat, kann aus einer App mit ihm chatten, wie über seinen Freigabelink. Er sollte daher nur aus dem antworten, was Sie auch öffentlich zeigen würden.

Das Paket hinzufügen

Wählen Sie in Xcode File > Add Package Dependencies, geben Sie https://github.com/rouzbeh-abadi/chatfrom-ios ein, stellen Sie die Regel auf Up to Next Minor Version, da vor 1.0 schon eine Minor-Version die API ändern kann, und fügen Sie Ihrer App die Bibliothek ChatFromSDK hinzu. Oder in Package.swift:

Package.swiftSwift
.package(url: "https://github.com/rouzbeh-abadi/chatfrom-ios", .upToNextMinor(from: "0.2.0")),

// und in den Abhängigkeiten Ihres Targets:
.product(name: "ChatFromSDK", package: "chatfrom-ios"),

Die Bubble anzeigen

Eine Zeile beim Start Ihrer App, in application(_:didFinishLaunchingWithOptions:) oder im init() einer SwiftUI-App:

SwiftSwift
import ChatFromSDK

ChatFrom.start(botId: "your-chatbot-id")
  • Die Bubble setzt sich von selbst über eine Tab-Leiste und weicht aus, solange die Tastatur darüber liegt. Bildschirme, die Ihre App darüber einblendet, verdecken sie.
  • Für eine eigene Leiste, die kommt und geht, etwa einen Player oder einen Timer, schiebt ChatFrom.setBottomInset(_:) die Bubble aus dem Weg.
  • ChatFrom.setBubbleHidden(true) blendet sie auf einem Bildschirm aus, auf dem sie stören würde, etwa auf Ihrem eigenen Sperrbildschirm oder einem Einführungsbildschirm, und ChatFrom.stop() entfernt sie.
  • Ein Chatbot, der auf Ihrer Website die Eingabeleiste zeigt, zeigt in einer App trotzdem eine Bubble, so wie die Bubble-Einstellungen unter Einbinden sie festlegen.

Oder eine Zeile hinzufügen

In SwiftUI, in einer List oder einer Form:

SwiftSwift
ChatFromRow(botId: "your-chatbot-id", title: "Ask our assistant")

In UIKit ist ChatFromCell dieselbe Zeile für eine Table View und ChatFromButton für alle anderen Stellen. Um den Chat von etwas Eigenem aus zu öffnen, etwa einem Menüeintrag, rufen Sie ChatFrom.open(botId:) auf. Eine Zeile ist grau, solange der Chatbot nicht live ist.

Angemeldete Personen

Wenn sich Personen in Ihrer App anmelden, teilen Sie mit, wer sie gerade nutzt, damit die nächste Person auf einem gemeinsam genutzten Gerät nicht den Chat der vorherigen sieht:

SwiftSwift
// Bei der Anmeldung und bei jedem Start, sobald Sie es wissen.
ChatFrom.identify(userId: user.id, userToken: tokenFromYourServer)

// Immer wenn die Anmeldung in Ihrer App endet.
ChatFrom.logout()
  • userId ist die ID der Person in Ihrer App. Verwendet wird nur ein Fingerabdruck davon, und er bleibt auf dem Gerät.
  • userToken ist optional, für einen Chatbot, dessen Tools für den angemeldeten Nutzer handeln, wie auf Ihrer Website. Holen Sie das Token von Ihrem eigenen Server und signieren Sie es nie in der App. Es geht nur an die Tool-Server, die Sie dafür markiert haben.

Fragen zu Abonnements

Ist RevenueCat unter Tools verbunden, können Kunden den Chatbot ab Version 0.2.0 des Pakets nach ihrem eigenen Abonnement fragen. Ihre App gibt an, wer fragt: mit einem Token von Ihrem Server als userToken wie oben, mit der anonymen ID von RevenueCat oder mit den Angaben des App Store selbst zu den Abonnements.

SwiftSwift
// Für einen Kunden, der sich nicht angemeldet hat, wenn Sie anonyme IDs zulassen.
ChatFrom.revenueCatAppUserId = Purchases.shared.isAnonymous ? Purchases.shared.appUserID : nil

// Die Angaben des App Store, sobald Ihre Bundle-ID unter Tools eingetragen ist.
ChatFrom.sharesAppStoreSubscriptions = true

Setzen Sie die RevenueCat-ID erneut, wann immer sie sich ändert. ChatFrom.logout() vergisst sie, setzen Sie danach also die des nächsten Kunden. Weitergegeben werden nur die anonymen IDs von RevenueCat: Für einen angemeldeten Kunden verwenden Sie ein Token.

Was Ihre App tun muss

  • Einwilligung. Die Antworten kommen über ChatFrom von einem KI-Modell, daher müssen Sie die App-Review-Regel von Apple zur Weitergabe personenbezogener Daten an die KI eines Dritten (Richtlinie 5.1.2(i)) selbst erfüllen: Weisen Sie in Ihrer App darauf hin und holen Sie die Einwilligung ein, bevor jemand den Chat zum ersten Mal nutzt. Die Bubble und die Zeilen laden die Chatseite und öffnen sie beim Antippen, rufen Sie ChatFrom.start also erst auf oder zeigen Sie eine Zeile erst an, wenn Sie diese Einwilligung haben. Um direkt beim Antippen zu fragen, verwenden Sie einen eigenen Button, der zuerst fragt und dann ChatFrom.open(botId:) aufruft.
  • Datenschutz. Ihre Datenschutzhinweise müssen abdecken, was Personen dem Chatbot schreiben und was seine Tools abfragen, etwa einen Namen, eine E-Mail-Adresse oder eine Telefonnummer, um einen Anruf zu vereinbaren. Das Privacy Manifest des SDK gibt diese an, ebenso den Kaufverlauf, den der Chat liest, wenn Sie App-Store-Abonnements teilen. Was der Chat auf dem Gerät speichert, richtet sich nach dem Schalter Wiederkehrende Besucher erkennen unter Einbinden: über App-Starts hinweg, wenn es eingeschaltet ist, und für die Laufzeit der App, wenn es ausgeschaltet ist.
  • Die Kamera. Die Dateiauswahl kann anbieten, ein Foto aufzunehmen, fügen Sie also NSCameraUsageDescription zu Ihrer Info.plist hinzu.
  • App-Bound Domains. Steht WKAppBoundDomains in Ihrer Info.plist, fügen Sie dort chatfrom.io hinzu, sonst kann der Chat nicht laden.

Antworten in einer App verbrauchen Ihre monatlichen Credits, genau wie auf Ihrer Website.

Im README des SDK finden Sie jeden Aufruf und jede Option. Wie Sie denselben Chatbot auf Ihre Website bringen, steht in der Anleitung Erste Schritte.