GET/api/public/widget/history
Lädt den bisherigen Nachrichtenverlauf einer Widget-Konversation, zum Beispiel nach dem Neuladen der Seite.
Übergeben Sie `widget_code`, `session_id` und `visitor_id` als Query-Parameter. Die Antwort enthält im Objekt `data` die Liste `messages` mit `role` (`user` oder `assistant`), `text` und `created_at` in der Reihenfolge des Gesprächs. Der Aufruf ist rein lesend und idempotent. Header `X-Widget-Token` mit dem Embed-Token und `widget_code` sind erforderlich. Fehlt der Token, antwortet der Server mit 401 `WIDGET_TOKEN_MISSING`, ist er ungültig mit 401 `WIDGET_TOKEN_INVALID`; Aufrufe von nicht freigegebenen Domains erhalten 403 `WIDGET_ORIGIN_DENIED`, ein deaktiviertes Widget 404 `WIDGET_DISABLED`. Fehlen `session_id` oder `visitor_id`, antwortet der Server mit 400 `PARAMS_REQUIRED`. Ist die Sitzung nicht mehr bekannt, beginnen Sie eine neue Konversation.
Überblick
Aufruf: GET /api/public/widget/history. Der Endpunkt gehört zur Gruppe „Chat-Widget“ der API von Zentor App. Er erfordert ein gültiges Widget-Embed-Token. Der Aufruf ist idempotent: Wiederholte Aufrufe mit denselben Angaben liefern dasselbe Ergebnis. Pflichtparameter: widget_code (Query), session_id (Query), visitor_id (Query). Dokumentierte Fehlerfälle: 400 PARAMS_REQUIRED. Die Beispielantwort unten zeigt den Aufbau einer erfolgreichen Antwort im JSON-Format.
Auth & Absicherung
Widget-Embed-Token (Header X-Widget-Token) + Origin-Freigabeliste
Idempotent: Ja
Parameter
widget_code(query, string, erforderlich)— Widget-Code aus Ihrem Einbindungscodesession_id(query, string, erforderlich)— Sitzungs-ID der Konversation aus der Antwort von `message`visitor_id(query, string, erforderlich)— Besucher-ID, die das Widget erzeugt und im Browser speichertBeispiel-Response
{"ok":true,"data":{"messages":[{"role":"user","text":"Hallo...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}Fehlercodes
400 PARAMS_REQUIRED — `session_id` oder `visitor_id` fehlt.Geprüftes Verhalten
Eine bestehende Sitzung liefert 200 mit dem Nachrichtenverlauf; fehlende Parameter liefern 400 `PARAMS_REQUIRED`.
Chat-Widget
GET /api/public/widget/healthEinfache Erreichbarkeitsprüfung des Widget-Dienstes.GET /api/public/widget/config/:widget_codeLiefert die öffentliche Konfiguration eines Widgets (Anzeigename, Begrüßungstext, Design, Sprache, Sprachfunktion) für die Initialisierung im Browser.POST /api/public/widget/messageSendet eine Nachricht des Besuchers an den Chatbot und liefert dessen Antwort – der zentrale Endpunkt des Chat-Widgets.POST /api/public/widget/pollRuft Nachrichten ab, die nach einem Zeitpunkt eingegangen sind – etwa die Antwort eines Mitarbeiters, der das Gespräch übernommen hat.POST /api/public/widget/ratingSpeichert die Bewertung des Besuchers zu einer Konversation (hilfreich oder nicht hilfreich).POST /api/public/widget/trackErfasst ein anonymes Nutzungsereignis des Widgets (z. B. „Widget geöffnet“) für die Auswertungen im Dashboard.POST /api/public/widget/voice-transcribeWandelt eine Sprachaufnahme des Besuchers in Text um (Spracheingabe), sofern die Sprachfunktion für das Widget aktiviert ist.POST /api/public/widget/voice-speakWandelt Text in gesprochene Sprache um (Sprachausgabe im Widget), sofern die Sprachfunktion aktiviert ist.