Chat-Widget

Alle Endpunkte, die das eingebettete Chat-Widget auf Ihrer Website verwendet.

Das Chat-Widget bindet Ihren Chatbot in Ihre Website ein. Diese Gruppe beschreibt alle Endpunkte, die das Widget verwendet: Erreichbarkeitsprüfung, öffentliche Widget-Konfiguration, Senden von Nachrichten, Gesprächsverlauf, Abruf neuer Nachrichten (etwa nach der Übernahme durch einen Mitarbeiter), Bewertung, Nutzungsereignisse sowie Spracheingabe und Sprachausgabe.

`health` und `config` sind ohne Authentifizierung erreichbar, damit sich das Widget im Browser initialisieren kann. Alle übrigen Endpunkte erwarten den `widget_code` und den Embed-Token des Widgets im Header `X-Widget-Token`. Zentor legt das Widget bei der Einrichtung an, hinterlegt die freigegebenen Domains und stellt Ihnen den Einbindungscode mit Widget-Code und Embed-Token bereit. Aufrufe von nicht freigegebenen Domains lehnt der Server mit 403 `WIDGET_ORIGIN_DENIED` ab, ein deaktiviertes Widget beantwortet er mit 404 `WIDGET_DISABLED`.

Zusätzlich gelten die Zugriffsregeln Ihres Kontos (IP-, Länder- und Domainregeln). `message` ist nicht idempotent: Jedes erneute Senden erzeugt eine weitere Nachricht und eine weitere Antwort.

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
← API-Referenz