SDK-Referenz

Jedes Telybot SDK – Android, iOS, React Native, Flutter, Ionic – implementiert denselben kompakten Vertrag. Wenn Sie eines verwendet haben, kennen Sie alle.

Die API

Mit einer Frage öffnen. Übergeben Sie show eine Frage, und sie steht im Nachrichtenfeld des Chats; der Kunde liest sie und tippt auf Senden. Sie reist im #fragment des Links und erreicht so nie ein Server-Log. Bis zu 500 Zeichen, als eine Zeile.

Der Chat in Ihrem eigenen Bildschirm. Android KeydaBotView, iOS KeydaBot.makeChatViewController oder SwiftUI KeydaBotView, React Native <KeydaBotChat />, Flutter KeydaBotChat und das embedWidget() des Ionic-Pakets. Er hat keinen Schließen-Button — die Navigation Ihres Bildschirms ist der Weg hinaus. Auf Android schließt Zurück zuerst ein geöffnetes Element oder den Warenkorb: React Native und Flutter tun das für Sie, solange der Chat der vorderste Bildschirm ist, und mit der nativen KeydaBotView ruft Ihre Zurück-Behandlung deren goBack() auf.

Ihr angemeldeter Kunde. Geben Sie dem SDK Name, Telefonnummer oder E-Mail Ihres Kunden, und der Chat füllt aus, was Ihre App bereits weiß. Die Angaben werden angeboten, nie gesendet: Sie erscheinen im Formular „Mit einer Person sprechen“, in einer Bestellung, einer Buchung und einer Willkommensfrage nach Name, Telefon oder E-Mail, und der Kunde schickt sie ab. Sie reisen im #fragment des Links und sind die Angabe Ihrer App, keine geprüfte Identität. Ein Wert, den der Chat ablehnen würde, wird weggelassen: ein Name mit mehr als 80 Zeichen, eine Telefonnummer ohne 8 bis 15 Ziffern, eine E-Mail-Adresse ohne richtige Domain. Der Vollbild-Chat von Ionic öffnet sich im Systembrowser, der Adressen in seinem Verlauf behält, und nimmt sie deshalb nicht an; sein eingebettetes Widget schon.

Eine Antwort, während der Chat geschlossen ist. Wenn ein Kunde nach einer Person fragt und den Chat schließt, wartet Ihre Antwort aus dem Dashboard in der Konversation. Die SDKs für Android, iOS, React Native und Flutter prüfen das, wenn Ihre App in den Vordergrund kommt, und melden es Ihrer App, sodass Sie einen Punkt auf Ihrem Chat-Button anzeigen können, bis der Kunde den Chat öffnet. Sie fragen nur nach Chats, in denen der Kunde in den letzten 14 Tagen nach einer Person gefragt hat. Ein Chat, den Ihre App außer Sicht geladen hält, etwa ein Hilfe-Tab im Hintergrund, gilt nicht als gelesen: Der Punkt bleibt, bis der Kunde hinsieht. Das ist keine Push-Benachrichtigung: Eine Antwort wird bemerkt, wenn die App geöffnet wird.

Mehr gibt es absichtlich nicht. Keine API zum Senden von Nachrichten und keinen Aufruf für die Nutzeridentität — weil beides noch nicht durchgängig funktioniert, und eine Methode, die nicht funktioniert, ist schlimmer als eine, die fehlt.

Die URL, die jedes SDK öffnet

{baseUrl}/chat/{clientId}

baseUrl ist standardmäßig auf https://telybot.com eingestellt und kann auf jeder Plattform für Staging oder eine selbst gehostete Installation überschrieben werden.

Warum eine Web-Ansicht und was sie Sie kostet

Es gibt eine einzige Chat-Oberfläche, die von der Plattform bereitgestellt und von jedem Kanal geladen wird.

Was Sie erhalten: Änderungen, die ein Inhaber im Dashboard vornimmt – Akzentfarbe, Begrüßungsnachricht, Bot-Name, Live-Schaltung – erreichen sofort jede App, ohne dass ein Release erforderlich ist. Eine Korrektur wird überall gleichzeitig wirksam. Der Chat ist über alle Plattformen hinweg identisch.

Was es kostet: der Chat benötigt eine Verbindung. Es gibt keinen Offline-Modus und noch keine Push-Benachrichtigungen.

Wir möchten, dass Sie dies vor der Veröffentlichung wissen, anstatt es erst danach zu entdecken.

Garantien, die jedes SDK bietet

1. Navigation entweicht. Ein Link zu einem anderen Ursprung öffnet sich im Systembrowser, anstatt den Chat zu ersetzen. Ohne dies beendet ein einziger Klick auf einen Footer-Link das Gespräch des Kunden ohne Rückweg.
2. Konversationsfortführung. Der DOM-Speicher ist aktiviert, sodass Kunden, die die App schließen und zurückkehren, ihren Chatverlauf dort vorfinden, wo sie ihn verlassen haben (für 24 Stunden).
3. Die Tastatur verdeckt niemals das Eingabefeld.
4. Sicherheitsbereiche werden respektiert – kein Chat wird unter einer Notch oder einem Home-Indikator angezeigt.
5. Kein Absturz erreicht Ihre App. Ein fehlgeschlagener Ladevorgang zeigt eine Wiederholungsoption an.
6. Keine Analysen, keine Gerätekennungen, keine Abhängigkeiten von Drittanbietern. Das Hinzufügen eines Telybot SDK fügt Ihrer App keinen Tracker hinzu.
7. Zurück schließt zuerst, was der Kunde gerade ansieht. Auf Android schließt Zurück über einem geöffneten Element, Warenkorb oder einer Buchung zuerst dieses und erst dann den Chat (SDK 0.2.0 und neuer).

Im Chat

All das kommt von der gehosteten Seite und erreicht so jede App ohne SDK-Update:

• Eine Willkommensnachricht mit Vorschlagsbuttons, in der Sprache, auf die der Bot eingestellt ist.
• Die Konversation bleibt 24 Stunden auf dem Gerät, und der Chat erzeugt keine Besucher-ID. Auf einer Website dauert eine Konversation einen Browser-Tab lang. (Der Vollbild-Chat des Ionic-SDKs braucht dafür 0.2.0.)
• Bestellungen und Buchungen, wenn das Unternehmen sie annimmt: ein Warenkorb, Buchungsdaten und -zeiten, ein Link, um das Unternehmen anzurufen, wenn eine Bestellung oder Buchung zu lange gewartet hat, und „Zum Kalender hinzufügen“ für eine bestätigte Buchung.
• Anhänge: Fotos (JPEG, PNG, WebP, GIF) sowie PDF-, DOCX-, TXT-, CSV- und MD-Dateien. Die Android- und Flutter-SDKs brauchen 0.1.4 oder neuer für den Anhang-Button, Flutter braucht 0.2.0 für Dokumente.
• „Zum Kalender hinzufügen“ ist ein Link zu einer .ics-Datei. iOS öffnet sie in Kalender als Kalender zum Abonnieren. Android bietet die Kalender-App des Telefons an, wenn diese .ics-Dateien importiert — der aktuelle Google Kalender tut das — und sonst lädt der Browser die Datei herunter.

Format der Client ID

kb_live_ followed by 8-48 hexadecimal characters

Alles andere wird bei der Initialisierung abgelehnt, anstatt einen 404-Fehler vor dem Kunden anzuzeigen. Die Client ID ist konzeptbedingt öffentlich — sie ist auf jeder Website sichtbar, die das Widget einbindet — und bietet keine Möglichkeit, Ihr Konto zu lesen oder zu ändern. Siehe Limits und Sicherheit.

Quelle

Öffentlich, MIT-lizenziert: github.com/telybotai/telybot-Sdks. Der gemeinsame Vertrag, an den jedes Paket gebunden ist, befindet sich in CONTRACT.md oben in diesem Repository.