Messenger-SDK
Den ChaosDesk-Messenger auf Ihrer Website oder in Ihrer App einbetten, mit zE() steuern und Besucher per JWT anmelden.
Zur besseren Verständlichkeit übersetzt. Code, Feldnamen und die API-Referenz bleiben auf Englisch. Englische Fassung
Der ChaosDesk-Messenger ist ein Chatfenster für Ihre Website und Apps. Bot-Abläufe antworten zuerst und übergeben das Gespräch dann an einen Agent, wo es zu einem Messaging-Ticket wird.
Einbetten
Jede Marke hat ihren eigenen Schlüssel unter Admin Center, Channels, Messenger. Fügen Sie das Snippet vor </body> ein:
<script id="ze-snippet" src="https://app.chaosdesk.io/messenger.js?key=YOUR_KEY"></script>id="ze-snippet" und die zE()-API entsprechen dem Zendesk Web Widget (Messaging), sodass eine Website, die von Zendesk wechselt, nur die Skript-URL und den Schlüssel ändert. Fügen Sie https://app.chaosdesk.io zu script-src, frame-src und connect-src hinzu, wenn Ihre Website eine Content Security Policy hat. Ihr ChaosDesk-Hilfe-Center fügt das Snippet selbst ein, wenn der Messenger der Marke eingeschaltet ist.
Die zE()-API
| Aufruf | Was er tut |
|---|---|
zE('messenger', 'open') / 'close' | Öffnet oder schließt das Gesprächsfenster |
zE('messenger', 'show') / 'hide' | Zeigt oder verbirgt den Launcher |
zE('messenger', 'loginUser', cb => cb(jwt)) | Meldet den Besucher an (siehe unten) |
zE('messenger', 'logoutUser') | Beendet die angemeldete Sitzung |
zE('messenger:on', 'open' | 'close', fn) | Führt fn aus, wenn sich das Fenster öffnet oder schließt |
zE('messenger:on', 'unreadMessages', fn) | fn(count) bei jeder Änderung der Zahl ungelesener Nachrichten |
zE('messenger:set', 'locale', 'fr') | Legt die Sprache der Oberfläche fest |
zE('messenger:set', 'zIndex', 99999) | Legt die Stapelreihenfolge fest |
zE('messenger:set', 'cookies', false) | Verbirgt den Messenger und löscht seine gespeicherten Daten (Einwilligung aus) |
zE('messenger:set', 'conversationFields', [{ id, value }]) | Legt Ticketfelder fest, die bei der Übergabe gesetzt werden (ChaosDesk-Feld-ID oder -Schlüssel) |
zE('messenger:set', 'conversationTags', ['vip']) | Legt Tags fest; jeder Aufruf ersetzt die vorherigen |
Besucher anmelden
Angemeldete Besucher sehen ihren Gesprächsverlauf auf jedem Gerät, und Agents sehen, wer sie sind. Das JWT hat dasselbe Format wie das Messaging-JWT von Zendesk, daher braucht ein bestehender Token-Dienst nur das neue Secret:
- Header:
{"alg": "HS256", "typ": "JWT", "kid": "<key id>"}, signiert mit dem gemeinsamen Secret aus Admin Center, Channels, Messenger (erstellen Sie ein neues Secret, verwenden Sie kein altes wieder). RS256 mit einer JWKS-URL wird ebenfalls unterstützt. - Claims:
scope: "user",external_id(Pflicht) und optionalname,email,email_verifiedundexp. - ChaosDesk verknüpft den Besucher mit dem Nutzer mit dieser
external_id, sonst mit dem Nutzer mit dieser verifizierten E-Mail, sonst mit einem neuen Endnutzer.
zE('messenger', 'loginUser', function (callback) {
fetch('/chat-token').then(r => r.text()).then(callback);
});Erlaubte Domains, Geschäftszeiten und die Bot-Abläufe werden pro Marke im Admin Center festgelegt.
Mobile Apps
Betten Sie den Messenger heute in iOS- und Android-Apps in einer WebView ein. Native SDKs stehen auf der Roadmap.