Zum Inhalt springen

Konfiguration

Konfigurieren Sie WidgetClient, indem Sie ein WidgetConfig-Objekt an den Konstruktor übergeben. Alle Optionen außer widgetKey sind optional.

OptionTypErforderlichStandardBeschreibung
widgetKeystringJaIhr Widget-Installationsschlüssel
baseUrlstringNeinhttps://api.univerx.aiAPI-Basis-URL
debugbooleanNeinfalseAusführliches Debug-Logging in der Konsole aktivieren
containerstring | HTMLElementNeinWidget in einem bestimmten DOM-Element oder CSS-Selektor mounten
themeWidgetThemeNeinVisuelle Anpassung
cursorCursorConfigNeinEinstellungen für das Agenten-Cursor-Overlay
onReady() => voidNeinWird aufgerufen, wenn das SDK bereit ist
onError(error: Error) => voidNeinWird bei unbehandelten Fehlern aufgerufen
onAgentAssigned(agent: Agent) => voidNeinWird aufgerufen, wenn ein Agent die Sitzung akzeptiert
onCallStarted() => voidNeinWird aufgerufen, wenn der Videoanruf beginnt
onCallEnded() => voidNeinWird aufgerufen, wenn der Videoanruf endet
onCobrowseStarted() => voidNeinWird aufgerufen, wenn Cobrowsing beginnt
onCobrowseEnded() => voidNeinWird aufgerufen, wenn Cobrowsing endet
onCobrowseConsentRequired(handlers: CobrowsingConsentHandlers) => voidNeinWird aufgerufen, wenn der Agent Cobrowsing-Zustimmung anfordert

Steuern Sie das visuelle Erscheinungsbild des Widgets mit WidgetTheme:

const widget = new WidgetClient({
widgetKey: "your-widget-key",
theme: {
primaryColor: "#6366f1",
position: "bottom-right",
borderRadius: "12px",
fontFamily: "Inter, sans-serif",
},
});
OptionTypBeschreibung
primaryColorstringMarkenfarbe für Schaltflächen und Akzente (jeder gültige CSS-Farbwert)
position"bottom-right" | "bottom-left" | "top-right" | "top-left"Widget-Position auf dem Bildschirm. Standard ist bottom-right
borderRadiusstringEckenradius des Widget-Panels (jeder CSS-Wert, z.B. "8px")
fontFamilystringIm Widget verwendete Schriftart (jeder CSS-Font-Stack)

Steuern Sie das Agenten-Cursor-Overlay mit CursorConfig:

const widget = new WidgetClient({
widgetKey: "your-widget-key",
cursor: {
enabled: true,
autoHideDelay: 2000,
showLabel: true,
clickAnimation: true,
},
});
OptionTypStandardBeschreibung
enabledbooleantrueAgenten-Cursor-Overlay anzeigen oder ausblenden
autoHideDelaynumber2000Millisekunden, bevor der Cursor ausblendet, nachdem der Agent die Bewegung stoppt
showLabelbooleantrueNamen des Agenten neben dem Cursor anzeigen
clickAnimationbooleantrueRipple-Animation anzeigen, wenn der Agent klickt

Standardmäßig rendert das Widget eine schwebende Schaltfläche in der durch theme.position definierten Ecke. Um es stattdessen in Ihrem eigenen Element zu mounten, übergeben Sie einen CSS-Selektor oder eine DOM-Referenz:

const widget = new WidgetClient({
widgetKey: "your-widget-key",
container: "#support-widget",
// or: container: document.getElementById("support-widget"),
});

Das Element muss im DOM vorhanden sein, bevor widget.init() aufgerufen wird.

Jeder Widget-Schlüssel ist an eine Reihe vertrauenswürdiger Domains gebunden. Anfragen von anderen Ursprüngen werden mit einem 403-Fehler abgelehnt.

So fügen Sie eine Domain hinzu:

  1. Öffnen Sie Ihr Univerx-Dashboard und gehen Sie zu Einstellungen → Widgets.
  2. Wählen Sie Ihr Widget aus und öffnen Sie den Tab Domains.
  3. Geben Sie den vollständigen Ursprung Ihrer Website ein, einschließlich Protokoll (z.B. https://example.com).
  4. Verifizieren Sie den Besitz mithilfe des bereitgestellten DNS-TXT-Eintrags oder HTML-Meta-Tags.