Den Chat über URL-Query-Parameter der Webseite steuern
Sie können URL-Query-Parameter verwenden, um den LoyJoy-Chat-Agenten zu steuern. Die folgenden Parameter sind verfügbar:
| Parameter | Wert | Funktion |
|---|---|---|
loyjoy-debug | true | Debug-Modus aktivieren, der in die JavaScript-Konsole loggt |
loyjoy-fullscreen | true | Erzwingt, dass der Chat-Messenger immer im Vollbildmodus ist, nicht nur auf Mobilgeräten, sondern auch auf Tablets usw. |
loyjoy-iframe | true | Erzwingt, dass der Chat-Messenger in einem iframe statt in einer Web Component gerendert wird. Nicht empfohlen, aber möglicherweise notwendig, wenn das JavaScript Ihrer Hosting-Webseite DOM-Elemente von LoyJoy-Web-Components verändert und Sie das nicht beheben können. |
loyjoy-locale | Z. B. de oder de-CH | Setzt das Gebietsschema für den Chat. Z. B. damit der Chat auf der französisch lokalisierten Website immer auf Französisch startet |
loyjoy-open | true oder false | Chat-Messenger beim Laden der Seite öffnen / Chat-Messenger beim Laden der Seite nicht öffnen |
loyjoy-process | <PROCESS_ID> | Chat-UI zu der angegebenen Prozess-ID leiten |
loyjoy-reset | true | Chat-Verlauf beim Laden der Seite löschen |
loyjoy-restart | true | KI-Agenten nach dem Laden der Seite neu starten |
loyjoy-route | process/<PROCESS_ID> | Chat-UI zu der angegebenen Route leiten. In den meisten Fällen ist loyjoy-process ausreichend. loyjoy-route ist technischer und ermöglicht alle Arten von Routen (Prozess, View, Story, Web-View, ...). |
loyjoy-show | true oder false | LoyJoy-Chat beim Laden der Seite anzeigen oder ausblenden. Standardmäßig anzeigen. |
loyjoy-view | <VIEW_ID> | Chat-UI zu der angegebenen Home-View-ID leiten |
So hängen Sie Query-Parameter an Webseiten-URLs/Links an
Sie können jeden dieser Parameter einfach nach einem ? an die URL der Hosting-Webseite anhängen. Zum Beispiel so:
https://www.example.org?loyjoy-open=true
Wenn die URL der Hosting-Webseite bereits Query-Parameter enthält oder Sie mehr als einen Parameter hinzufügen möchten, müssen Sie das Zeichen & verwenden, um Parameter zu verketten:
https://www.example.org?foo=bar&loyjoy-show=false
Freie Parameter
Sie können frei gewählte Parameter an den KI-Agenten übergeben, die im BPMN-Prozess mit BPMN-Bedingungen und anderen Ausdrücken ausgewertet werden können. Auf die Parameter kann mit der GetParam-Funktion in LoyJoy zugegriffen werden. Um Parameterwerte in Variablen zu speichern, verwenden Sie die GetParam-Funktion als Quelle im Variablen-Modul.
https://www.example.org?foo=bar
Beachten Sie, dass Parameter als case-insensitive Strings übergeben werden. foo=bar ist z. B. dasselbe wie FOO=bar oder fOo=bar. Die Parameterwerte sind jedoch case-sensitive. foo=bar ist z. B. nicht dasselbe wie foo=BAR.