Notiondesk Messenger bringt Ihr Notiondesk Hilfecenter direkt in Ihre Website oder Webanwendung.
Besucher können Messenger nutzen, um in Ihrem Hilfecenter zu suchen, Artikel zu lesen, mit Ihrem KI-Assistenten zu chatten, Änderungsprotokoll-Updates einzusehen und Ihr Team zu kontaktieren, ohne Ihre Website zu verlassen.
Diese Anleitung erklärt, wie man Notiondesk Messenger auf einer Standardwebsite installiert.
Bevor Sie beginnen
Bevor Sie Notiondesk Messenger installieren, stellen Sie sicher, dass Sie Folgendes haben:
- A Notiondesk Hilfezentrum
- Ein Messenger, konfiguriert in Notiondesk
- Zugriff auf den Quellcode Ihrer Website oder auf die seitenweiten benutzerdefinierten Codeeinstellungen
- Ihr einzigartiger Notiondesk Messenger-Installations-Snippet
Wählen Sie eine Installationsmethode
Verwenden Sie die Installationsmethode, die zu Ihrer Website passt.
| Website-Typ | Empfohlene Methode |
|---|---|
| Standard-HTML- oder mehrseitige Website | JavaScript-Codeausschnitt |
| Reagieren | Notiondesk Messenger SDK |
| Next.js | Notiondesk Messenger SDK |
| Vue | Notiondesk Messenger SDK |
| Nuxt | Notiondesk Messenger SDK |
| Andere einseitige Anwendung | Notiondesk Messenger SDK |
Für die meisten traditionellen Websites ist der JavaScript-Codeausschnitt die einfachste Installationsmethode.
Messenger auf einer Standard-Website installieren
1. Kopieren Sie Ihren Messenger-Installationscode
Öffnen Sie Ihre Messenger-Einstellungen in Notiondesk und suchen Sie den Abschnitt Installation .
Kopieren Sie den für Ihren Messenger generierten Installations-Snippet.
Der Code hat folgendes Format:
YOUR_MESSENGER_ID kennzeichnet den Messenger, der auf Ihrer Website geladen werden soll.
Kopieren Sie den Codeausschnitt aus Ihrem eigenen Notiondesk-Dashboard, anstatt eine Messenger-ID von einer anderen Website oder einem anderen Konto zu kopieren.
2. Fügen Sie den Code-Schnipsel zu Ihrer Website hinzu.
Fügen Sie den Messenger-Codeausschnitt direkt vor dem schließenden </body>-Tag ein:
Wenn Ihre Website ein gemeinsames Layout, eine Vorlage, eine Fußzeile oder einen seitenweiten benutzerdefinierten Codebereich verwendet, fügen Sie den Code-Schnipsel dort einmalig ein, damit Messenger auf der gesamten Website geladen wird.
Soll Messenger nur auf bestimmten Seiten erscheinen, fügen Sie den Code-Schnipsel nur auf diesen Seiten ein.
3. Veröffentlichen Sie Ihre Änderungen
Speichern und veröffentlichen Sie Ihre Website, nachdem Sie den Code-Schnipsel hinzugefügt haben.
Der Messenger-Code muss auf der veröffentlichten Website vorhanden sein. Wenn der Code nur zu einer lokalen oder unveröffentlichten Version hinzugefügt wird, steht Messenger den Besuchern nicht zur Verfügung.
<script
async
src="https://static.notiondesk.help/messenger/widget.js"
data-messenger-id="YOUR_MESSENGER_ID">
</script><body>
<!-- Your website -->
<script
async
src="https://static.notiondesk.help/messenger/widget.js"
data-messenger-id="YOUR_MESSENGER_ID">
</script>
</body>Überprüfen Sie die Installation
Öffnen Sie die veröffentlichte Webseite in Ihrem Browser.
Bei erfolgreicher Installation sollte der Messenger-Launcher Notiondesk auf Seiten geladen werden, die den Installationscode enthalten.
Öffnen Sie Messenger und überprüfen Sie, ob der erwartete Inhalt Notiondesk angezeigt wird.
Sie können Folgendes testen:
- Öffnen und Schließen des Messengers
- Suche in Ihrem Hilfezentrum
- Einen Artikel öffnen
- Starten einer KI-Konversation, falls der KI-Chatbot aktiviert ist.
- Öffnen aller anderen Messenger-Bereiche, die Sie aktiviert haben
Falls Messenger nicht angezeigt wird, öffnen Sie die Entwicklertools Ihres Browsers und prüfen Sie, ob das Widget erfolgreich geladen wird.
React, Next.js, Vue, Nuxt und Single-Page-Anwendungen (SPAs)
React, Next.js, Vue, Nuxt und andere Single-Page-Anwendungen sollten das offizielle @notiondesk-so/messenger-js-sdk-Paket verwenden, anstatt den Standard-Skript-Snippet manuell hinzuzufügen.
Installieren Sie das Paket mit:
Sie können es auch mit Yarn oder pnpm installieren.
Das SDK bietet spezielle Integrationen für:
npm install @notiondesk-so/messenger-js-sdk- JavaScript und TypeScript
- Reagieren
- Next.js
- Vue
- Nuxt
Das SDK bietet außerdem Methoden zum Anzeigen, Ausblenden, Umschalten, Konfigurieren und Zerstören von Messenger.
Framework-Integrationen müssen Notiondesk Messenger clientseitig initialisieren. Initialisieren Sie das Messenger SDK nicht während des serverseitigen Renderings.
Installieren Sie nicht sowohl den Standard-Messenger-Codeausschnitt als auch das SDK in derselben Anwendung, es sei denn, Sie verwalten absichtlich separate Messenger-Instanzen.
Eine vollständige Anleitung zur Einrichtung des Frameworks finden Sie unter Install Notiondesk Messenger with React and Next.js guide.
Fehlerbehebung
Der Messenger erscheint nicht.
Prüfen Sie Folgendes:
- Prüfen Sie, ob der Messenger-Ausschnitt auf der Seite vorhanden ist.
- Prüfen Sie, ob der Codeausschnitt die korrekten
data-messenger-identhält.
- Bestätigen Sie, dass Ihre letzten Website-Änderungen veröffentlicht wurden.
- Seite nach der Bereitstellung aktualisieren
- Überprüfen Sie die Browserkonsole auf JavaScript- oder Content-Security-Policy-Fehler.
- Überprüfen Sie das Netzwerk-Panel und vergewissern Sie sich, dass
widget.jsnicht blockiert wird.
Messenger wird auf einigen Seiten angezeigt, auf anderen jedoch nicht.
Notiondesk Messenger wird nur auf Seiten geladen, die den Installationscode enthalten.
Verschieben Sie den Codeausschnitt in das globale Layout, die Vorlage oder die Fußzeile Ihrer Website, wenn Messenger auf jeder Seite angezeigt werden soll.
Der falsche Bote erscheint.
Der Parameter data-messenger-id bestimmt, welcher Notiondesk Messenger geladen wird.
Kopieren Sie den Installations-Snippet erneut aus dem richtigen Messenger in Ihrem Notiondesk-Dashboard.
Messenger wird durch eine Content Security Policy blockiert.
Eine restriktive Content Security Policy (CSP) kann das Laden von JavaScript-Dateien oder Netzwerk-Anfragen von Drittanbietern verhindern. Überprüfen Sie die Browserkonsole auf CSP-Fehler, falls das Messenger-Skript vorhanden ist, aber nicht geladen wird.
Die Content Security Policy Ihrer Website muss die von Notiondesk Messenger benötigten Ressourcen zulassen.
Messenger funktioniert nach dem Aktualisieren, aber nicht während der Navigation in der Single-Page-Anwendung.
Single-Page-Anwendungen führen bei normaler Navigation keinen vollständigen Seitenneuladen durch.
Verwenden Sie @notiondesk-so/messenger-js-sdk für React, Next.js, Vue, Nuxt und andere SPA-basierte Anwendungen, anstatt sich auf den Standardinstallations-Snippet zu verlassen.
Ein identifizierter Benutzer wird nicht erkannt
Vergewissern Sie sich, dass Ihr Backend ein gültiges, nicht abgelaufenes Notiondesk Benutzertoken generiert.
Generieren Sie das Token nicht im Browsercode.
Wenn sich ein Benutzer abmeldet, entfernen Sie das Benutzertoken aus der Messenger-Konfiguration oder zerstören Sie die Messenger-Instanz, bevor Sie eine neue Benutzersitzung starten.
Der Messenger ist hinter einem anderen Element verborgen.
Das Messenger SDK unterstützt eine benutzerdefinierte zIndex-Konfiguration.
Erhöhen Sie den Messenger-Stapelwert, wenn ein anderes festes oder schwebendes Element über dem Messenger-Launcher oder -Panel angezeigt wird.