Zum Inhalt springen

Embed

Für: Entwickler, die das Widget in Ihr Produkt einbauen, und Administratoren, die seine Toolkits wählenVoraussetzung: Die Rolle Admin zum Anlegen, Bearbeiten und Löschen von Widgets; ansehen und den Einbettungscode kopieren kann jede angemeldete Person; kein Feature-FlagScreenshots zeigen Beispieldaten

Die Seite Embed ist der letzte Schritt, bevor Ihr Widget live geht. Sie legen fest, welche Toolkits und welches Wissen der Assistent des Widgets nutzen darf, und kopieren dann den Code, der das Widget in Ihr Produkt bringt, mit der Identität der besuchenden Person und, wo nötig, ihren Zugangsdaten für Ihre API. Für Widgets, die Ihre eigenen Schaltflächen öffnen, liefert die Seite außerdem fertige JavaScript-Snippets. Sie öffnen sie über KonfigurierenEmbed und wählen oben die Widget-Karte. Überschrift, Widget-Karte und Snippet-Schaltflächen sind in jeder Sprache englisch; diese Anleitung zitiert sie so, wie die Seite sie zeigt.

Die Seite Embed unter Konfigurieren; Überschrift und Karte erscheinen auch auf Deutsch in Englisch. Die Widget-Karte "Demo Ltd Support chat" ist ausgewählt. Die Karte Widget Details darunter zeigt Name "Demo Ltd Support chat", die Beschreibung, Display type "custom-trigger", die Toolkits "Demo Billing API" und "Demo Accounts API" sowie die Wissensdatenbank-Ordner "Billing & invoices (5)" und "Help Centre — Billing". Oben rechts in der Karte stehen "Preview widget" und die hervorgehobene Schaltfläche "Edit", die die Karte in ein Formular verwandelt.Die Seite Embed unter Konfigurieren; Überschrift und Karte erscheinen auch auf Deutsch in Englisch. Die Widget-Karte "Demo Ltd Support chat" ist ausgewählt. Die Karte Widget Details darunter zeigt Name "Demo Ltd Support chat", die Beschreibung, Display type "custom-trigger", die Toolkits "Demo Billing API" und "Demo Accounts API" sowie die Wissensdatenbank-Ordner "Billing & invoices (5)" und "Help Centre — Billing". Oben rechts in der Karte stehen "Preview widget" und die hervorgehobene Schaltfläche "Edit", die die Karte in ein Formular verwandelt.
Widget Details zeigt, welche Toolkits und Wissensdatenbank-Ordner das ausgewählte Widget nutzt; mit Edit ändern Sie sie.
Was dieser Screenshot zeigt
Ansicht
Embed (/admin/configure/embed?widgetId=…)
Hervorgehoben
button “”, widget-details-card-top-right, enabled. switches the card to an edit form for name, description, toolkits and knowledge base
Außerdem sichtbar
Widget cards with Demo Ltd Support chat selected; Toolkits: Demo Billing API, Demo Accounts API; Knowledge Base: Billing & invoices (5), Help Centre — Billing; Preview widget button
Zweck
entry point of the Embed page
BereichWas er zeigtWas Sie dort tun
Widget-Karten, obenIhre Widgets und eine gestrichelte Karte „New widget“Das Widget wählen, eines anlegen oder löschen
Widget DetailsName, Beschreibung, Darstellungsart, Toolkits und Wissensdatenbank des Widgets, mit Preview widget und EditPrüfen und ändern, was das Widget nutzen darf
SnippetDen Einbettungscode mit Copy embed codeDen Code für Ihr Produkt kopieren
Inline-EinbettungIn einen Container einbettenDas Widget in einen Container setzen
Inject authInject Authorization, ein Schalter pro Toolkit mit ZugangsdatenZugangsdaten in den Code aufnehmen
TriggersCustom Trigger Button Snippets, nur bei Darstellungsarten mit eigenem AuslöserSnippets für Ihre Schaltflächen kopieren
Kontext in den Chat einspeisenGib der KI verborgenen Kontext zu deiner Seite, mit Regeln und BeispielenLernen, wie Sie Seitenkontext übergeben

Das gewählte Widget bleibt auf KI & UX und User Interface gewählt.

  1. Wählen Sie die gestrichelte Karte „New widget“. Der Dialog Neue Widget-Konfiguration erstellen öffnet sich.
  2. Geben Sie Widget-Name * ein, etwa Demo Ltd Support chat, und optional eine Beschreibung.
  3. Wählen Sie die Darstellungsart, Pop-up oder seitliche Leiste, und ob sich Besucher anmelden müssen. Die Anmeldung ist standardmäßig an.
  4. Schalten Sie die Toolkits ein, die das Widget nutzen darf. Sie können bis zu 5 wählen; die Beschriftungen des Dialogs sprechen von einem Toolkit und der Zähler zeigt „von 1“, das Limit ist aber 5. Sind 5 eingeschaltet, werden die übrigen Schalter ausgegraut. Es erscheinen nur aktive Toolkits.
  5. Wählen Sie optional Dokumente und Webquellen der Wissensdatenbank.
  6. Wählen Sie Widget erstellen. Die Meldung Widget erfolgreich erstellt! erscheint, und das neue Widget wird kurz danach ausgewählt.

Das Widget erhält ein eigenes Application-Token, die Kennung in seinem Einbettungscode. Außerdem bekommt es eine Reihe Standard-Agenten und zwei Start-Karten auf seinem Begrüßungsbildschirm. Der Dialog übernimmt nur Name, Beschreibung, Darstellungsart, die Wahl zur Anmeldung, Toolkits und Wissen; Farben und Größe stellen Sie danach unter User Interface ein.

Tool-Namen müssen über die Toolkits eines Widgets hinweg eindeutig sein. Haben zwei Toolkits je ein Tool namens getInvoice, wird das Widget mit „Cannot assign servers: Tool names must be unique. The following tools exist in multiple servers: …“ abgelehnt. Benennen Sie das Tool in einem Toolkit unter Toolkits um.

Um ein Widget zu löschen, öffnen Sie das ⋮-Menü seiner Karte, wählen „Delete“ und bestätigen „Delete this widget?“. Sein Einbettungscode funktioniert danach nicht mehr.

  1. Wählen Sie die Widget-Karte. Widget Details zeigt Name, Beschreibung, Darstellungsart, Toolkits und Ordner der Wissensdatenbank.
  2. Wählen Sie Edit. Die Karte wird zu Edit Widget.
  3. Ändern Sie bei Bedarf Name * oder Description.
  4. Schalten Sie unter Toolkits * Toolkits ein oder aus. Der Hinweis lautet Select up to 5 toolkits., und der Zähler zeigt, wie viele gewählt sind.
  5. Wählen Sie in der Auswahl der Wissensdatenbank die Ordner, Dokumente und Webquellen, aus denen der Assistent antworten darf.
  6. Wählen Sie Save. Die Karte zeigt wieder Widget Details mit den neuen Werten; eine Meldung erscheint nicht.
Die Seite Embed mit der Widget-Karte im Modus "Edit Widget", oben rechts "Cancel" und "Save"; das Formular ist auf Englisch. Es zeigt "Name *" (Demo Ltd Support chat), "Description" und "Toolkits *" mit dem hervorgehobenen Hinweis "Select up to 5 toolkits." Darunter hat jedes aktive Toolkit einen Schalter: "Demo Billing API" und "Demo Accounts API" sind eingeschaltet, "Demo Reporting API" ist ausgeschaltet, jeweils mit Beschreibung; der Zähler lautet "2 of 5 toolkits selected". Die Wissensdatenbank-Auswahl beginnt unterhalb des sichtbaren Bereichs.Die Seite Embed mit der Widget-Karte im Modus "Edit Widget", oben rechts "Cancel" und "Save"; das Formular ist auf Englisch. Es zeigt "Name *" (Demo Ltd Support chat), "Description" und "Toolkits *" mit dem hervorgehobenen Hinweis "Select up to 5 toolkits." Darunter hat jedes aktive Toolkit einen Schalter: "Demo Billing API" und "Demo Accounts API" sind eingeschaltet, "Demo Reporting API" ist ausgeschaltet, jeweils mit Beschreibung; der Zähler lautet "2 of 5 toolkits selected". Die Wissensdatenbank-Auswahl beginnt unterhalb des sichtbaren Bereichs.
Ein Widget kann ein bis fünf aktive Toolkits nutzen; schalten Sie sie hier ein oder aus und speichern Sie.
Was dieser Screenshot zeigt
Ansicht
Embed (/admin/configure/embed?widgetId=…)
Hervorgehoben
hint “”, edit-widget-toolkits, 2 of 5 toolkits selected. none (hint); the switches below choose the widget's toolkits
Außerdem sichtbar
Name and Description fields; Toolkit switches: Demo Billing API on, Demo Accounts API on, Demo Reporting API off; Cancel and Save buttons
Zweck
changing which toolkits a widget uses
MeldungUrsache
Widget name is required.Der Name ist leer
At least one toolkit must be selected.Kein Toolkit ist eingeschaltet; ein Widget braucht mindestens 1
Maximum 5 toolkits can be selected.Sie wollten ein sechstes Toolkit einschalten
„Cannot assign servers: Tool names must be unique…“Zwei gewählte Toolkits haben ein Tool gleichen Namens
Failed to save widget.Das Speichern scheiterte aus einem anderen Grund; versuchen Sie es erneut

Es erscheinen nur aktive Toolkits; gibt es keines, zeigt die Karte No active toolkits available. Ein Toolkit mit fehlgeschlagenem Import ist inaktiv und erscheint nicht.

Der Abschnitt Snippet zeigt den Code für das gewählte Widget. Er hat zwei Teile:

  1. Ein <script>-Tag, das das Widget-Skript lädt, mit einem Attribut data-api-url. Beide Adressen sind für Ihre StrikeUp-Umgebung ausgefüllt; lassen Sie sie unverändert.
  2. Einen Aufruf von window.initStrikeUpChatWidget({...}) mit dem applicationToken des Widgets und Platzhaltern für die besuchende Person.
Der Einbettungscode des Widgets "Demo Ltd Support chat" auf der Seite Embed. Der Codeblock enthält ein Script-Tag, das widget.js mit dem Attribut data-api-url lädt, und danach den Aufruf window.initStrikeUpChatWidget mit "applicationToken": "b1bf86fb-0567-4df1-c229-4987319bb1bf" sowie Platzhaltern für "userId", "userDisplayName", "userEmail", "userCompanyId", "userCompanyName" und "handoffUserId". Unter dem Block kopiert die hervorgehobene, englisch beschriftete Schaltfläche "Copy embed code" das ganze Snippet. Darunter beginnen die "Custom Trigger Button Snippets" mit "Open widget".Der Einbettungscode des Widgets "Demo Ltd Support chat" auf der Seite Embed. Der Codeblock enthält ein Script-Tag, das widget.js mit dem Attribut data-api-url lädt, und danach den Aufruf window.initStrikeUpChatWidget mit "applicationToken": "b1bf86fb-0567-4df1-c229-4987319bb1bf" sowie Platzhaltern für "userId", "userDisplayName", "userEmail", "userCompanyId", "userCompanyName" und "handoffUserId". Unter dem Block kopiert die hervorgehobene, englisch beschriftete Schaltfläche "Copy embed code" das ganze Snippet. Darunter beginnen die "Custom Trigger Button Snippets" mit "Open widget".
Kopieren Sie das Snippet in Ihre Website und ersetzen Sie die Platzhalter durch die Daten des angemeldeten Kunden.
Was dieser Screenshot zeigt
Ansicht
Embed (/admin/configure/embed?widgetId=…)
Hervorgehoben
button “”, embed-code-block-bottom, enabled. copies the full embed snippet to the clipboard
Außerdem sichtbar
Script tag loading widget.js with data-api-url; initStrikeUpChatWidget with applicationToken b1bf86fb-0567-4df1-c229-4987319bb1bf; Placeholders userId, userDisplayName, userEmail, userCompanyId, userCompanyName, handoffUserId; Start of Custom Trigger Button Snippets
Zweck
getting the code that puts the widget on your site
  1. Wählen Sie die Widget-Karte.
  2. Schalten Sie optional die Optionen unter dem Code ein, etwa die Einbettung in einen Container oder übergebene Zugangsdaten; der Code passt sich sofort an.
  3. Wählen Sie Copy embed code. Die Schaltfläche zeigt kurz Copied!.
  4. Fügen Sie den Code in die Seitenvorlage Ihres Produkts ein, am Ende des <body>.
  5. Ersetzen Sie die Platzhalter, etwa your_customer_id, durch die echten Werte der angemeldeten Person aus Ihrem Produkt.

Die Optionen unter dem Code werden nicht gespeichert. Sie ändern nur den angezeigten Code; schalten Sie sie also erneut ein, wenn Sie den Code ein anderes Mal kopieren.

Was das Widget mit dem Code macht:

  • Es liest aus dem Script-Tag nur data-api-url. Vorgaben wie Farben oder Position lassen sich nicht als Script-Attribute übergeben; sie kommen von User Interface.
  • Es fragt StrikeUp mit dem applicationToken nach den Vorgaben des Widgets. Ist das Token falsch oder das Widget gelöscht, wird nichts angezeigt.
  • Aufrufe, die erfolgen, bevor das Skript geladen ist, werden gesammelt und ausgeführt, sobald es bereit ist.

Der Einbettungscode teilt dem Widget mit, wer die besuchende Person ist:

FeldWas hineingehört
userIdIhre eigene eindeutige, dauerhafte ID der angemeldeten Person, etwa cus_48247
userDisplayNameDer Name, den der Assistent und Ihr Team sehen
userEmailDie E-Mail-Adresse der Person, etwa für Berichte, die der Assistent mailt
userCompanyId, userCompanyNameDas Unternehmen der Person in Ihrem Produkt, bei Geschäftskunden
handoffUserIdDie ID der Person in Ihrem Helpdesk, für die Übergabe an Mitarbeitende

Übergeben Sie die Identität der besuchenden Person immer ausdrücklich im Einbettungscode, aus der Anmeldung Ihres eigenen Produkts, und lassen Sie sie nie aus der Seitenadresse kommen. Der Kundendatensatz unter CRM, der Chatverlauf der Person und die von ihr eingegebenen Zugangsdaten hängen alle an userId.

Schalten Sie für jedes Widget, dessen Tools die eigenen Daten einer Person lesen oder ändern, die Anmeldung von Endkunden ein, unter User Interface, damit eine Person vor dem Chat eine PIN oder ein Passwort festlegt. Wie die Anmeldung für Ihre Kunden funktioniert und welche Wege es gibt, sie aus Ihrem Produkt heraus anzumelden, steht in Anmeldung von Endkunden (PIN oder Passwort).

Braucht ein Toolkit die Zugangsdaten der besuchenden Person, wird sie normalerweise im Chat danach gefragt. Hat Ihr Produkt sie bereits, können Sie sie stattdessen im Einbettungscode übergeben.

Die Seite Embed zwischen der Inline-Option und dem Kontextbereich. Unter "Inline-Einbettung" ist "In einen Container einbetten" ausgeschaltet. Unter "Inject auth" listet der englisch beschriftete Kasten "Inject Authorization" die Toolkits "Demo Billing API" (CustomAuthEndpoint), dessen hervorgehobener Schalter jetzt eingeschaltet ist, und "Demo Accounts API" (CustomAuthEndpoint) mit ausgeschaltetem Schalter. Ein eingeschaltetes Toolkit ergänzt den Einbettungscode um einen Eintrag serverAuthorizations mit serverId und authData dieses Toolkits; die Auswahl selbst wird nicht gespeichert.Die Seite Embed zwischen der Inline-Option und dem Kontextbereich. Unter "Inline-Einbettung" ist "In einen Container einbetten" ausgeschaltet. Unter "Inject auth" listet der englisch beschriftete Kasten "Inject Authorization" die Toolkits "Demo Billing API" (CustomAuthEndpoint), dessen hervorgehobener Schalter jetzt eingeschaltet ist, und "Demo Accounts API" (CustomAuthEndpoint) mit ausgeschaltetem Schalter. Ein eingeschaltetes Toolkit ergänzt den Einbettungscode um einen Eintrag serverAuthorizations mit serverId und authData dieses Toolkits; die Auswahl selbst wird nicht gespeichert.
Schalten Sie Inject Authorization für ein Toolkit ein, um die Zugangsdaten Ihres Kunden im Einbettungscode mitzugeben.
Was dieser Screenshot zeigt
Ansicht
Embed (/admin/configure/embed?widgetId=…)
Hervorgehoben
switch “”, inject-authorization-box, on. adds serverAuthorizations for this toolkit to the generated snippet (not saved)
Außerdem sichtbar
Inline embed: Embed inside a container, off; Inject Authorization: Demo Billing API on, Demo Accounts API off, both CustomAuthEndpoint
Zweck
passing toolkit credentials from the host page instead of asking the customer
  1. Schalten Sie unter Inject Authorization das Toolkit ein. Aufgeführt sind nur die Toolkits des Widgets, die eine Autorisierung nutzen, jeweils mit ihrer Art.
  2. Der Einbettungscode erhält einen Eintrag serverAuthorizations mit der serverId des Toolkits und einem Beispiel für authData passend zu seiner Art: username und password bei Nutzername und Passwort, ein Wert pro eigenem Platzhalter bei einem Token-Endpunkt.
  3. Kopieren Sie den Code und ersetzen Sie die Beispielwerte durch die echten Zugangsdaten der Person aus Ihrem Produkt.

Sobald sich der Chat verbindet, speichert StrikeUp die übergebenen Zugangsdaten für diese Person und nutzt sie bei den Aufrufen des Toolkits; bei einem Token-Endpunkt ruft es das Token mit den übergebenen Werten ab. Ein Toolkit, das nicht zu diesem Widget gehört, wird abgelehnt. Das genaue authData je Autorisierungsart steht in Den Assistenten Ihre API im Namen des Nutzers aufrufen lassen.

Standardmäßig schwebt das Widget über Ihrer Seite. So setzen Sie es in Ihr Layout, etwa als Bereich in Ihrer App:

  1. Schalten Sie unter Inline-Einbettung den Schalter In einen Container einbetten ein.
  2. Tragen Sie den Container-Selektor ein, etwa #strikeup-widget, die Voreinstellung.
  3. Schalten Sie optional Kundenportal inline öffnen ein, damit sich das Kundenportal im selben Container öffnet.
  4. Kopieren Sie den Code. Er beginnt nun mit einem <div> für den Container, 600 Pixel hoch, und setzt displayType auf inline.

Tipp: Geben Sie dem Container eine explizite Höhe. Ohne Höhe wird das Widget auf null reduziert. Ein eingebettetes Widget hat keine Starter-Schaltfläche und füllt seinen Container aus.

Bei einem Widget mit eigenem Auslöser erscheinen unter Triggers die Custom Trigger Button Snippets. Jedes Snippet hat eine eigene Schaltfläche Copy.

SnippetWas es tut
„Open widget“Öffnet das Widget ohne Nachricht, mit StrikeUpChat.open()
Öffnen mit NachrichtÖffnet das Widget und zeigt Ihre Nachricht, etwa „What would you like to know about this page?“, als Eröffnung des Assistenten
Öffnen mit KontextÖffnet das Widget und übergibt einen verborgenen Satz openContext dazu, warum die Schaltfläche gedrückt wurde, nur für die erste Antwort
Prüfen, ob das Widget geöffnet istNutzt StrikeUpChat.isOpen(), damit eine Schaltfläche das Widget umschalten kann
Widget schließenSchließt das Widget mit StrikeUpChat.close()

Automatisch senden ergänzt autoSend: true: Ihre Nachricht wird dann als erste eigene Nachricht der Person in einem neuen Chat gesendet, und der Assistent antwortet sofort.

isOpen() meldet den tatsächlichen Zustand, auch wenn die Person das Widget mit dessen eigenen Bedienelementen schließt, löst aber kein Ereignis aus: Rufen Sie es beim Klick auf Ihre Schaltfläche auf, oder prüfen Sie es alle 200 Millisekunden, um das Aussehen einer Schaltfläche mitzuführen. Jede Methode von window.StrikeUpChat steht in der Referenz der Widget-JavaScript-API, und wie sich jede Darstellungsart verhält, in Darstellungsarten und eigene Auslöser.

Der Kontextbereich der Seite Embed mit den Überschriften "Kontext in den Chat einspeisen" und "Gib der KI verborgenen Kontext zu deiner Seite". Er erklärt "Live-Seitenkontext" (StrikeUpChat.context.set(value) bei jedem Routenwechsel) und "Kontext beim Öffnen" (openContext für StrikeUpChat.open()), einen Hinweis zur Abrechnung und "Die wichtigsten Regeln". Es folgen zwei Codebeispiele, "Seitenkontext bei jedem Routen-/Zustandswechsel" und "Kontext beim Öffnen über einen eigenen Trigger-Button", jeweils mit "Kopieren". Unten öffnet der hervorgehobene Link "Vollständige Widget-Integrationsanleitung ansehen (Best Practices in §7.1)" die technische Anleitung.Der Kontextbereich der Seite Embed mit den Überschriften "Kontext in den Chat einspeisen" und "Gib der KI verborgenen Kontext zu deiner Seite". Er erklärt "Live-Seitenkontext" (StrikeUpChat.context.set(value) bei jedem Routenwechsel) und "Kontext beim Öffnen" (openContext für StrikeUpChat.open()), einen Hinweis zur Abrechnung und "Die wichtigsten Regeln". Es folgen zwei Codebeispiele, "Seitenkontext bei jedem Routen-/Zustandswechsel" und "Kontext beim Öffnen über einen eigenen Trigger-Button", jeweils mit "Kopieren". Unten öffnet der hervorgehobene Link "Vollständige Widget-Integrationsanleitung ansehen (Best Practices in §7.1)" die technische Anleitung.
Senden Sie verborgenen Seitenkontext mit context.set() und einen einmaligen Hinweis mit open(); der Link führt zu allen Regeln.
Was dieser Screenshot zeigt
Ansicht
Embed (/admin/configure/embed?widgetId=…)
Hervorgehoben
link “Vollständige Widget-Integrationsanleitung ansehen (Best Practices in §7.1)”, context-panel-bottom, enabled. opens the Widget Integration technical guide in Help
Außerdem sichtbar
Live page context and Open-time context explanations; Cost note about staged context rows; Rules that matter most; Two code examples with Copy buttons
Zweck
teaching how to give the assistant page context from the host site

Gib der KI verborgenen Kontext zu deiner Seite erklärt, wie Ihre Seite dem Assistenten mitteilt, was die Person gerade ansieht, ohne dass sie es tippen muss:

  • Live-Seitenkontext: Rufen Sie bei jedem Routenwechsel StrikeUpChat.context.set(value) auf. Der Wert reist mit der nächsten Nachricht der Person und bleibt in der Unterhaltung.
  • Kontext beim Öffnen: Übergeben Sie openContext an StrikeUpChat.open() als einmaligen Hinweis zur gedrückten Schaltfläche.

Ein Wert darf bis zu 8.192 Zeichen lang sein; ein größerer wird abgelehnt, und set() liefert false. Kontext wird der Person nie angezeigt und geht beim Neuladen der Seite verloren. Regeln und Beispiele des Bereichs sowie Vollständige Widget-Integrationsanleitung ansehen (Best Practices in §7.1) zeigen, was Sie senden und was Sie weglassen sollten. Verlassen Sie sich nicht auf Seitenkontext, um die Person zu identifizieren: Übergeben Sie die Identität im Einbettungscode.

Wo

Die Karte unter den Widget-Karten. Edit schaltet sie auf Edit Widget; Save und Cancel stehen oben rechts.

Was

Ansicht: Name, Beschreibung, Darstellungsart, Toolkits und Wissensdatenbank. Bearbeiten: Name * (Pflicht), Description, Toolkits * (1 bis 5 aktive Toolkits, eindeutige Tool-Namen) und die Auswahl der Wissensdatenbank. Die Auswahl der Wissensdatenbank erscheint auch, wenn die Wissensdatenbank-Funktion für Ihren Workspace aus ist.

Warum

Welche Toolkits ein Widget nutzen darf, bestimmt, was sein Assistent in Ihrem Produkt tun kann; hier, neben dem Einbettungscode, prüfen Sie beides vor dem Livegang.

Wo

Rechts oben in Widget Details und als Symbol auf der Widget-Karte, sofern Ihre Installation eine Vorschau anbietet.

Was

Öffnet das Widget in einem neuen Browser-Tab mit einer vorübergehenden Vorschau-Person und den gespeicherten Vorgaben.

Warum

Probieren Sie den Assistenten aus, bevor Sie ihn irgendwo einbetten.

Wo

Unter dem Codeblock in Snippet.

Was

Kopiert den ganzen angezeigten Code, einschließlich der darunter eingeschalteten Optionen. Die Schaltfläche zeigt kurz Copied!.

Warum

Der Code muss exakt eingefügt werden; Kopieren vermeidet Tippfehler im Token.

Wo

Unter Inline-Einbettung.

Was

In einen Container einbetten schaltet den Code auf Inline-Modus; Container-Selektor (Voreinstellung #strikeup-widget) und Kundenportal inline öffnen verfeinern ihn. Wird nicht gespeichert; ändert nur den angezeigten Code.

Warum

In einer App passt ein Bereich innerhalb Ihres Layouts oft besser als ein schwebendes Fenster.

Wo

Unter Inject auth. Ein Schalter pro Toolkit des Widgets, das eine Autorisierung nutzt.

Was

Ergänzt für jedes eingeschaltete Toolkit einen Eintrag serverAuthorizations mit einem Beispiel für authData passend zur Art. Wird nicht gespeichert; ändert nur den angezeigten Code.

Warum

Hat Ihr Produkt die Zugangsdaten der Person für Ihre API bereits, muss sie sie im Chat nicht erneut eingeben.

Wo

Unter Triggers, nur bei Widgets mit eigenem Auslöser.

Was

Snippets zum Öffnen (einfach, mit Nachricht, mit Kontext), Prüfen und Schließen des Widgets, jedes mit Copy. Automatisch senden lässt die Nachricht sofort als erste Nachricht der Person senden.

Warum

Ein Widget ohne Starter-Schaltfläche öffnet sich nur, wenn Ihre Seite es verlangt.

ThemaFakt
Toolkits pro WidgetMindestens 1, höchstens 5, nur aktive, mit eindeutigen Tool-Namen.
Wer Widgets ändern darfPersonen mit der Rolle Admin legen Widgets an, bearbeiten und löschen sie. Alle anderen können sie ansehen und Einbettungscode kopieren nutzen; ihre Änderungen schlagen fehl mit “This action requires the Admin role.”
Application-TokenJedes Widget hat ein eigenes; es kennzeichnet das Widget im Einbettungscode. Eine Schaltfläche zum Ändern gibt es nicht.
Snippet-OptionenContainer, übergebene Zugangsdaten und Auslöser-Optionen werden nicht gespeichert; sie ändern nur den angezeigten Code.
Script-AttributeAus dem Script-Tag wird nur data-api-url gelesen.
PlatzierungLaden Sie das Skript am Ende des <body>.
Falsches TokenDas Widget zeigt nichts.
KontextgrößeBis zu 8.192 Zeichen pro Wert.

Wo finde ich die ID oder das Token meines Widgets?

Abschnitt betitelt „Wo finde ich die ID oder das Token meines Widgets?“

Das applicationToken des Widgets steht im Einbettungscode auf KonfigurierenEmbed, im Aufruf window.initStrikeUpChatWidget. Jedes Widget hat sein eigenes Token, und die Admin-App hat keine Schaltfläche, um es durch ein neues zu ersetzen.

Kann ich Vorgaben als data-Attribute am Script-Tag übergeben?

Abschnitt betitelt „Kann ich Vorgaben als data-Attribute am Script-Tag übergeben?“

Nein. Das Widget liest aus seinem Script-Tag nur data-api-url. Darstellungsart, Farben, Größe und die Seiten, auf denen es erscheint, legen Sie auf KonfigurierenUser Interface fest; Identität und Zugangsdaten gehören in den Aufruf initStrikeUpChatWidget.

Am Ende des <body> jeder Seite, auf der das Widget erscheinen darf, nachdem Sie die Platzhalter durch die echten Werte der angemeldeten Person ersetzt haben. Um die Seiten einzugrenzen, nutzen Sie die URL-Regeln auf KonfigurierenUser Interface, statt den Code wegzulassen.

Warum sind meine Container- oder Zugangsdaten-Optionen weg, wenn ich zurückkomme?

Abschnitt betitelt „Warum sind meine Container- oder Zugangsdaten-Optionen weg, wenn ich zurückkomme?“

Die Optionen unter dem Code auf KonfigurierenEmbed, etwa In einen Container einbetten und Inject Authorization, werden nicht gespeichert. Sie ändern nur den gerade angezeigten Code; schalten Sie sie vor dem nächsten Kopieren erneut ein.

Zwischen 1 und 5 aktive Toolkits, gewählt unter Toolkits * auf KonfigurierenEmbed oder im Anlege-Dialog. Tool-Namen müssen über die gewählten Toolkits hinweg eindeutig sein, sonst wird das Widget mit einer Liste der doppelten Tools abgelehnt.

Es erscheinen nur aktive Toolkits. Ein Toolkit, dessen Import auf KonfigurierenToolkits fehlgeschlagen ist, bleibt inaktiv und erscheint nicht; löschen Sie es und importieren Sie die Spezifikation erneut.

Ja, bei jedem Widget für angemeldete Personen. Füllen Sie userId und die übrigen Felder im Einbettungscode aus der Anmeldung Ihres Produkts. Kundendatensatz, Chatverlauf und gespeicherte Zugangsdaten hängen an userId; eine fehlende oder geteilte ID bringt Personen durcheinander.

Sollen sich Besucher zusätzlich am Widget anmelden?

Abschnitt betitelt „Sollen sich Besucher zusätzlich am Widget anmelden?“

Schalten Sie die Anmeldung von Endkunden auf KonfigurierenUser Interface für jedes Widget ein, dessen Tools die eigenen Daten einer Person lesen oder ändern. Besucher legen dann vor dem Chat eine PIN oder ein Passwort fest. Für ein Widget, das nur allgemeine Fragen beantwortet, ist sie optional.

Wie öffne ich das Widget über meine eigene Schaltfläche?

Abschnitt betitelt „Wie öffne ich das Widget über meine eigene Schaltfläche?“

Wählen Sie auf KonfigurierenUser Interface eine Darstellungsart mit eigenem Auslöser, speichern Sie und kopieren Sie „Open widget“ aus Custom Trigger Button Snippets auf KonfigurierenEmbed. Hängen Sie es an den Klick-Handler Ihrer Schaltfläche; es ruft StrikeUpChat.open() auf.

Rufen Sie StrikeUpChat.isOpen() auf. Es meldet den tatsächlichen Zustand, auch wenn die Person das Widget mit dessen eigenen Bedienelementen geschlossen hat. Es gibt kein Ereignis dafür; rufen Sie es beim Klick auf Ihre Schaltfläche auf oder prüfen Sie es alle 200 Millisekunden.

Nein. Seitenkontext aus StrikeUpChat.context.set() und der an StrikeUpChat.open() übergebene openContext sind für die Person verborgen und werden nur vom Assistenten gelesen. Ein Wert ist auf 8.192 Zeichen begrenzt und geht beim Neuladen der Seite verloren.

SymptomWas Sie prüfen sollten
Auf der Seite erscheint nichtsPrüfen Sie das applicationToken gegen KonfigurierenEmbed, ob das Widget noch existiert, und die URL-Regeln auf KonfigurierenUser Interface. Laden Sie das Skript am Ende des <body>.
Das eingebettete Widget ist unsichtbarGeben Sie dem Container eine feste Höhe; ohne sie fällt das Widget auf null zusammen.
Ein Widget mit eigenem Auslöser öffnet sich niePrüfen Sie, ob Ihre Schaltfläche StrikeUpChat.open() aufruft, kopiert aus Custom Trigger Button Snippets.
„Cannot assign servers: Tool names must be unique…“Benennen Sie das doppelte Tool in einem der Toolkits auf KonfigurierenToolkits um.
Maximum 5 toolkits can be selected.Schalten Sie ein Toolkit aus, bevor Sie ein anderes einschalten.
No active toolkits available.Importieren Sie ein Toolkit oder ersetzen Sie ein fehlgeschlagenes auf KonfigurierenToolkits.
Besucher werden trotzdem nach Zugangsdaten gefragtPrüfen Sie, ob das Toolkit im ausgelieferten Code unter Inject Authorization eingeschaltet war und ob die Werte in authData die echten Werte der Person sind.
context.set() liefert falseDer Wert ist länger als 8.192 Zeichen. Senden Sie weniger Angaben.
Eine Änderung schlägt mit Anfrage fehlgeschlagen und “This action requires the Admin role.” fehlÄnderungen auf dieser Seite erfordern die Rolle Admin. Bitten Sie eine Person mit der Rolle Admin, die Änderung vorzunehmen oder Ihnen die Rolle unter Einstellungen › Benutzer zu geben.