Zum Inhalt springen
XICBOT

Einstellungen

English
Dokumentation · Widget auf der Website

Ansprache-Regeln

Besucher nach Zeit, Lesetiefe, Stillstand, beim Verlassen oder beim zweiten Besuch mit einem Satz ansprechen: Regeln, Grenzen, Pfadfilter und Sprechblase.

In einfacher Sprache

Das Chatfenster kann Besucher von sich aus ansprechen. Das geschieht mit einem kurzen Satz in einer Sprechblase. Sie legen fest, wann das passiert. Das kann nach einer Zeit auf der Seite sein oder wenn ein Teil gelesen ist. Es kann auch nach einer Pause, beim Verlassen der Seite oder beim zweiten Besuch sein. Mit einem Filter wählen Sie die Seiten aus. Diese Seite nennt jedes Feld und jede Grenze.

Stand

Alle Themen der Dokumentation

Im Feldsatz Proaktive Ansprache legen Sie fest, wann das Chatfenster Besucher Ihrer Website von sich aus mit einem Satz anspricht: nach einer Zeit auf der Seite, nach einem gelesenen Anteil, nach einem Stillstand, beim Verlassen der Seite oder beim zweiten Besuch. Diese Seite beschreibt jedes Feld, jede Grenze und jede Meldung und zeigt, wie sich die Sprechblase auf Ihrer Website verhält.

Wo Sie die Regeln einstellen

  1. Schritt 1

    Assistenten öffnen

    Öffnen Sie in der Anwendung Arbeit › Assistenten, also app.xicbot.de/assistenten.

  2. Schritt 2

    Assistent aufklappen

    Wählen Sie beim gewünschten Assistenten Bearbeiten. Mit der Rolle Lesen heißt der Knopf Ansehen, und die Felder bleiben gesperrt. Schließen klappt den Assistenten wieder zu.

  3. Schritt 3

    Feldsatz finden

    Im Abschnitt Chatfenster auf Ihrer Website steht der Feldsatz Proaktive Ansprache. Unter den Regeln und dem Knopf Regel hinzufügen steht ein Hinweis; an seinem Ende zeigt ein Zähler, wie viele Regeln bestehen, etwa 0/5.

  4. Schritt 4

    Regel anlegen

    Regel hinzufügen hängt am Ende eine neue Zeile an. Wählen Sie das Ereignis, tragen Sie bei Bedarf Zahl und Pfad ein und schreiben Sie den Satz.

  5. Schritt 5

    Speichern

    Speichern sendet das ganze Formular des Chatfensters. Während des Sendens steht dort Wird gespeichert …, danach erscheint „Gespeichert.“

Die Felder einer Regel

Über jedem Feld einer Zeile steht seine Beschriftung: Ereignis, Wert, Nur auf Pfad und Satz der Ansprache. Hinter dem Zahlfeld steht die Einheit, Sekunden oder Prozent. Bildschirmleser nennen das Zahlfeld mit Beschriftung und Einheit, etwa „Wert Sekunden“.

FeldPflichtGrenzenVorgabe
Ereignisjaeines der fünf EreignisseNach Zeit auf der Seite
Wert, dahinter Sekunden oder Prozentnur bei Zeit, Anteil und Stillstandganze Zahl im Bereich des Ereignisses20
Nur auf Pfadneinhöchstens 120 Zeichen, beginnt mit /leer, also alle Seiten
Satz der Anspracheja, ohne Satz entfällt die Regel beim Speichernhöchstens 200 Zeichenleer
Entfernen–nimmt die Zeile aus dem Formular–

Regel hinzufügen erscheint, solange weniger als fünf Regeln bestehen. Darunter steht „Je Regel ein Ereignis und ein Satz. Die erste Regel, die zutrifft, spricht; danach schweigt das Widget für diesen Besuch. Ohne Regel erscheint nichts ungefragt.“ und der Zähler, etwa 2/5. Mit „Besuch“ ist dabei der einzelne Seitenaufruf gemeint. Neue Regeln kommen ans Ende der Liste; verschieben lassen sich Regeln nicht.

Die fünf Ereignisse

EreignisZahlBereichTritt ein, wenn …
Nach Zeit auf der Seite (zeit)Sekunden1 bis 600die eingestellte Zeit abgelaufen ist, gezählt ab dem Laden des Chatfensters
Nach gelesenem Anteil (tiefe)Prozent1 bis 100die untere Kante des sichtbaren Bereichs den eingestellten Anteil der Seitenhöhe erreicht
Nach Stillstand (untaetig)Sekunden5 bis 600der Besucher so lange weder den Zeiger bewegt, klickt, tippt, scrollt noch den Bildschirm berührt
Beim Verlassen der Seite (ausstieg)––der Mauszeiger das Fenster über die obere Kante verlässt; nur auf Geräten mit Maus oder Touchpad
Beim zweiten Besuch (wiederkehr)––der Browser in den letzten 90 Tagen schon eine Seite mit dieser Regel geladen hat

Ab wann die Zeit zählt

Das Chatfenster lädt erst, wenn die Seite fertig geladen ist. Sobald es seine Einstellungen vom Server erhalten hat, werden die Regeln scharf geschaltet, und ab dann laufen die Uhren für Nach Zeit auf der Seite und Nach Stillstand. Die Ladezeit der Seite zählt nicht mit. Scrollen und Mausrad gelten nicht als Stillstand: wer liest, ist nicht untätig.

Wie der gelesene Anteil gemessen wird

Gemessen wird, wie weit die untere Kante des sichtbaren Bereichs in die Seite reicht, gerundet auf ganze Prozent. Oben auf einer Seite, die dreimal so hoch ist wie das Fenster, sind das bereits 33 Prozent; eine Regel mit 30 Prozent spricht dort sofort. Eine Seite, die nicht höher ist als das Fenster, zählt als ganz gelesen. Geprüft wird beim Scharfschalten, beim Scrollen und wenn sich die Fenstergröße ändert.

Beim zweiten Besuch

Für Beim zweiten Besuch legt das Widget im Browser eine Marke ab. Sie sagt nur „schon einmal hier gewesen“ und trägt keine Kennung.

  • Name im lokalen Speicher: xicbot.besuch.<Schlüssel>, gültig 90 Tage.
  • Jedes Scharfschalten der Regel liest die Marke und schreibt sie neu; die 90 Tage beginnen damit von vorn.
  • Die Regel spricht, wenn die Marke schon bestand. Das trifft bereits beim nächsten Seitenaufruf zu, auch innerhalb derselben Sitzung.
  • Die Marke entsteht nur auf Seiten, deren Pfad zur Regel passt.
  • Lässt der Browser keinen Speicher zu, spricht die Regel nicht.
  • <Schlüssel> ist der Wert des Attributs data-xicbot im Einbaucode. Mit einem anderen Schlüssel beginnt die Zählung von vorn.

Welche Regel spricht

  • Scharf geschaltet werden die Regeln in der Reihenfolge des Formulars, höchstens fünf. Regeln ohne Satz und Regeln, deren Pfad nicht passt, fallen dabei weg.
  • Die Regel, deren Ereignis zuerst eintritt, spricht. Alle übrigen werden in diesem Moment abgeschaltet.
  • Treffen schon beim Scharfschalten mehrere Regeln zu, etwa Beim zweiten Besuch oder ein kleiner Anteil auf einer kurzen Seite, spricht die oberste davon.
  • Die Sperre gilt für den Seitenaufruf. Auf der nächsten Seite derselben Website werden die Regeln neu scharf geschaltet.

Pfadfilter

Nur auf Pfad vergleicht den Anfang des Seitenpfads, ohne Domain, Abfrage und Anker. Groß- und Kleinschreibung zählen. Ein leeres Feld lässt die Regel auf allen Seiten gelten, auf denen das Widget eingebunden ist.

Nur auf PfadSeitenpfadRegel gilt
/preise/preiseja
/preise/preise/teamja
/preise/preiselisteja
/preise//preisenein
/preise/Preisenein
leerjeder Pfadja

Die Sprechblase

Die Sprechblase erscheint dort, wo sich das Chatfenster öffnet: in derselben Ecke wie der Knopf, 12 Pixel über ihm oder 12 Pixel darunter, wenn der Knopf oben steht. Weicht der Knopf einer festen Leiste der Seite aus, rückt die Sprechblase mit. Sie ist höchstens 320 Pixel breit, auf schmalen Bildschirmen höchstens die Fensterbreite abzüglich 32 Pixel, weiß mit dunkler Schrift in 15 Pixeln und abgerundeten Ecken.

  • Der Satz selbst ist ein Knopf mit mindestens 48 Pixeln Höhe. Ein Klick öffnet das Chatfenster.
  • Das Kreuz daneben, 44 Pixel breit, schließt die Sprechblase. Bildschirmleser nennen es „Hinweis schließen“, bei englischem Chatfenster „Dismiss message“. Die Regeln bleiben für diesen Seitenaufruf abgeschaltet.

Die Sprechblase trägt die Rolle status; Bildschirmleser melden den Satz, ohne den Fokus zu verschieben. Der Satz steht als reiner Text da: Sternchen, Links oder HTML erscheinen so, wie Sie sie eintippen. Übersetzt wird er nicht. Für eine englische Fassung Ihrer Website legen Sie eine eigene Regel mit passendem Pfad an, etwa /en/.

Tritt der Knopf vor einem Aufbau zurück, der fast das ganze Fenster deckt (ab 80 Prozent der Fensterhöhe), ist auch die Sprechblase ausgeblendet. Näheres unter Darstellung und Bedienung.

Wann keine Sprechblase erscheint

  • Keine Regel hat einen Satz, oder kein Pfad passt zur aufgerufenen Seite.
  • Der Besucher hat das Chatfenster auf dieser Seite schon geöffnet. Ab dann bleibt die Ansprache für den Seitenaufruf aus.
  • Das Skript trägt data-einwilligung="erforderlich", und der Besucher hat noch nicht über window.xicbot.einwilligen() zugestimmt. Siehe Einwilligung und Besucherrechte.
  • Der Assistent hat nicht den Status aktiv, sondern Entwurf oder pausiert, Chatfenster freigeben ist ausgeschaltet, oder das Konto ist nicht aktiv. Das Widget nimmt dann auch seinen Knopf von der Seite.
  • Der Assistent hat noch keine aktive Fassung. Dann wird keine Regel scharf geschaltet. Der Knopf bleibt auf der Seite, das geöffnete Chatfenster zeigt „Dieser Assistent ist noch nicht bereit.“
  • Das Chatfenster hat seine Einstellungen noch nicht vom Server erhalten, etwa ohne Netzverbindung. Bis dahin ist keine Regel scharf geschaltet.
  • window.xicbot.widerrufen() wurde aufgerufen. Der Widerruf nimmt Regeln und Sprechblase sofort von der Seite. Bis zum nächsten Seitenaufruf bleibt die Ansprache aus, auch wenn Ihre Seite erneut einwilligen() aufruft.

Speichern und Wirksamkeit

Vor dem Senden räumt das Formular auf: Regeln ohne Satz fallen weg, Pfad und Satz verlieren führende und folgende Leerzeichen, und die Zahl wird in den Bereich des Ereignisses geholt. Bei Beim Verlassen der Seite und Beim zweiten Besuch geht der Wert 0 mit. Der Server prüft die Liste erneut, speichert je Regel nur ereignis, wert, pfad und text und legt eine leere Liste als „keine Regeln“ ab.

Besucher bekommen neue Regeln mit dem nächsten Seitenaufruf. Auf einer Seite, die schon offen ist, sieht das Widget nur beim Öffnen des Chatfensters und bei der Rückkehr in den Browser-Tab nach Änderungen, höchstens einmal je Minute, und übernimmt dabei nur die Anzeige: Überschrift, Farbe, Ecke, Abstände, Breite, Höhe, Skalierung, Eckenradius und Bild sowie den Hinweis unter der Überschrift und den Grenzenhinweis. Die Regeln gelten dort erst nach dem Neuladen.

Meldungen beim Speichern

MeldungWann
„Gespeichert.“Die Änderungen sind gespeichert.
„Gespeichert. Der Einbaucode für „…“ konnte danach nicht neu geladen werden. Öffnen Sie diesen Assistenten erneut, um ihn zu sehen.“Die Änderungen sind gespeichert, nur der Einbaucode ließ sich danach nicht neu abrufen.
„Bitte prüfen Sie die markierten Felder.“Der Server hat eine Regel abgelehnt (422). Den Grund nennt ein Satz am Ende des Feldsatzes Proaktive Ansprache, siehe unten.
„Mit der Rolle Lesen lässt sich hier nur ansehen. Ändern kann, wer mindestens die Rolle Bearbeiten hat.“Die Rolle reicht zum Ändern nicht (403).
„Zu viele Versuche. Bitte warten Sie einen Moment.“Mehr als 30 Änderungen an Assistenten je Minute durch denselben angemeldeten Nutzer (429). Anlegen, Fassungen, Wiederherstellen, das Erneuern des Widget-Schlüssels sowie Anlegen, Ändern und Laufenlassen der Prüffragen unter Abnahme zählen mit.
„Dieser Bereich bleibt gesperrt, bis die E-Mail-Adresse bestätigt ist.“Die E-Mail-Adresse des Zugangs ist noch nicht bestätigt (403).
„Der Dienst antwortet gerade nicht.“Die Anfrage hat den Dienst nicht erreicht, etwa ohne Netzverbindung.
„Nicht gespeichert: Der Eintrag ins Protokoll kam nicht zustande. Bitte versuchen Sie es erneut.“Die Änderung ließ sich nicht im Protokoll vermerken (500 mit not_logged). Sie wurde deshalb nicht übernommen.
„Der Dienst hat einen Fehler gemeldet. Bitte versuchen Sie es später erneut.“Der Dienst hat mit einem anderen Serverfehler geantwortet (5xx).

Lehnt der Server eine Regel ab, steht am Ende des Feldsatzes Proaktive Ansprache ein Satz zum Grund: bei outreach_rule_path „Der Pfad einer Regel muss mit „/“ beginnen und darf höchstens 120 Zeichen lang sein, zum Beispiel /kontakt.“, bei jeder anderen Kennung „Eine Regel der proaktiven Ansprache ist ungültig. Prüfen Sie je Regel Ereignis, Wert, Pfad und Satz.“ Welche Zeile betroffen ist, nennt die Anwendung nicht. Lehnt der Server zugleich ein Feld ab, das die Anwendung nicht markiert, lautet die Meldung beim Speichern „Das hat nicht geklappt. Bitte prüfen Sie Ihre Eingaben.“ Die Antwort der Schnittstelle führt beim Feld widget_outreach_rules eine der folgenden Kennungen. Die Prüfung endet beim ersten Fehler.

KennungUrsache
outreach_rules_not_a_listDas Feld ist keine Liste.
outreach_rules_too_manyMehr als fünf Regeln.
outreach_rule_not_an_objectEin Eintrag ist kein Objekt.
outreach_rule_unknown_eventDas Ereignis ist keines der fünf.
outreach_rule_textDer Satz ist nach dem Trimmen leer oder länger als 200 Zeichen.
outreach_rule_pathDer Pfad beginnt nicht mit / oder ist länger als 120 Zeichen. Geprüft wird nach dem Entfernen führender und folgender Leerzeichen; Leerzeichen vor dem / stören also nicht.
outreach_rule_valueDie Zahl ist keine ganze Zahl oder liegt außerhalb des Bereichs. Eine fehlende Zahl gilt als 0 und passt damit nur zu ausstieg und wiederkehr, die nur 0 annehmen. Ziffern als Zeichenkette wie "45" gelten als Zahl.

Rollen

RolleRegeln ansehenRegeln ändern
Lesenjanein
Bearbeitenjaja
Verwaltungjaja
Inhaberjaja

Mit Lesen ist das Formular im Abschnitt Chatfenster auf Ihrer Website gesperrt, einschließlich Speichern. Mehr unter Team und Rollen.

Schnittstelle

Die Regeln stehen beim Assistenten im Feld widget_outreach_rules und werden mit dem Assistenten gelesen und geändert. Antworten tragen sie unter widget.outreach_rules. Fehlt das Feld in einer Änderung, bleiben die Regeln, wie sie sind; null oder [] löscht sie. Allgemeines unter API: Wissen und Assistenten und API-Grenzen.

PUT /api/v1/assistants/{id}

Ändert einen Assistenten. Alle Felder sind optional, für die Ansprache genügt widget_outreach_rules: eine Liste mit höchstens fünf Objekten aus ereignis, wert, pfad und text. Antwort 200 mit assistant; eine abgelehnte Regel ergibt 422, ein unbekannter Assistent 404.

Anmeldung
Angemeldet, bestätigte E-Mail-Adresse, Rolle Bearbeiten oder höher
Begrenzung
30 je Minute je angemeldetem Nutzer, gemeinsam mit Anlegen, Fassungen, Wiederherstellen, dem Erneuern des Widget-Schlüssels sowie Anlegen, Ändern und Laufenlassen der Prüffragen

outreach-rules.json json

{
  "widget_outreach_rules": [
    { "ereignis": "tiefe", "wert": 60, "pfad": "/preise", "text": "Fragen zu den Paketen? Ich helfe gern." },
    { "ereignis": "ausstieg", "wert": 0, "pfad": "", "text": "Bevor Sie gehen: Kann ich noch etwas beantworten?" },
    { "ereignis": "zeit", "wert": 45, "pfad": "", "text": "Suchen Sie etwas Bestimmtes?" }
  ]
}

In diesem Beispiel spricht auf /preise die erste Regel, sobald 60 Prozent gelesen sind, sofern nicht vorher der Mauszeiger die Seite verlässt oder 45 Sekunden vergehen. Auf allen anderen Seiten entscheiden Verlassen und Zeit.

Weiterlesen

Häufige Fragen

Warum sehe ich beim Testen keine Sprechblase?

Prüfen Sie der Reihe nach: Hat die Regel einen Satz, passt der Pfad am Anfang genau, ist der Assistent aktiv, und haben Sie das Chatfenster auf dieser Seite schon geöffnet? Trägt das Skript data-einwilligung="erforderlich", braucht es vorher die Zustimmung. Laden Sie die Seite nach dem Speichern neu; Beim Verlassen der Seite greift nur mit Maus oder Touchpad.

Können mehrere Sprechblasen nacheinander erscheinen?

Auf einer Seite spricht höchstens eine Regel. Wechselt der Besucher auf eine andere Seite, werden die Regeln dort neu scharf geschaltet, und es kann erneut eine sprechen.

Wird der Satz in die Sprache des Besuchers übersetzt?

Nein, er erscheint so, wie Sie ihn eingeben. Für mehrsprachige Websites legen Sie je Sprache eine Regel mit eigenem Pfad an, etwa /de/ und /en/.

Wie setze ich den zweiten Besuch für einen Test zurück?

Löschen Sie in den Entwicklerwerkzeugen des Browsers den Eintrag xicbot.besuch.<Schlüssel> im lokalen Speicher der Website. Der nächste Seitenaufruf gilt dann wieder als erster Besuch und legt die Marke neu an; die Regel spricht beim Aufruf danach.

Funktioniert „Beim Verlassen der Seite“ auf dem Smartphone?

Nein. Auf Geräten, die per Finger bedient werden, schaltet das Widget diese Regel nicht scharf, weil es dort keinen Mauszeiger gibt, der die Seite verlässt. Nehmen Sie dort Nach Stillstand oder Nach gelesenem Anteil.

Eine Stelle ist unklar geblieben?

Schreiben Sie uns, welche Seite und welcher Schritt gemeint ist. Wir antworten persönlich.

Anfrage in drei Schritten

  1. 1. Anliegen
  2. 2. Ihr Fall
  3. 3. Kontakt

Worum geht es?

Ein Klick genügt, alles Weitere ist freiwillig.

Erzählen Sie kurz von Ihrem Fall

Alle Angaben in diesem Schritt sind freiwillig. Sie helfen uns, gleich mit etwas Konkretem zu antworten statt mit Rückfragen.

Anfragen im Monat, ungefähr (optional)
Wann soll es losgehen? (optional)
Wie erreichen wir Sie?

Name und E-Mail-Adresse genügen. Wir antworten persönlich.

Wir verwenden Ihre Angaben, um Ihre Anfrage zu bearbeiten. Mehr dazu in der Datenschutzerklärung.