POST/api/public/widget/voice-speak
Wandelt Text in gesprochene Sprache um (Sprachausgabe im Widget), sofern die Sprachfunktion aktiviert ist.
Senden Sie `widget_code` und den vorzulesenden Text in `text`. Die Antwort enthält die Audiodaten zur Wiedergabe im Browser. Für die direkte Wiedergabe über ein `<audio>`-Element steht derselbe Pfad zusätzlich per GET zur Verfügung. Fehlt `widget_code`, antwortet der Server mit 400 `WIDGET_CODE_REQUIRED`; ist die Sprachfunktion nicht aktiviert oder derzeit nicht verfügbar, mit 503 `VOICE_UNAVAILABLE`. Starten Sie eine neue Wiedergabe erst, wenn die vorherige beendet ist.
Überblick
Aufruf: POST /api/public/widget/voice-speak. 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 (Body), text (Body). Dokumentierte Fehlerfälle: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. 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(body, string, erforderlich)— Widget-Code aus Ihrem Einbindungscodetext(body, string, erforderlich)— Text, der vorgelesen werden sollBeispiel-Response
{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Sprachfunktion aktuell nicht verfügbar."}}Fehlercodes
400 WIDGET_CODE_REQUIRED — Das Feld `widget_code` fehlt.503 VOICE_UNAVAILABLE — Die Sprachfunktion ist für dieses Widget nicht aktiviert oder derzeit nicht verfügbar.Geprüftes Verhalten
Ein fehlender `widget_code` liefert 400 `WIDGET_CODE_REQUIRED`, ein Widget ohne Sprachfunktion 503 `VOICE_UNAVAILABLE`. Der Erfolgsfall setzt ein Widget mit aktivierter Sprachfunktion voraus.
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.GET /api/public/widget/historyLädt den bisherigen Nachrichtenverlauf einer Widget-Konversation, zum Beispiel nach dem Neuladen der Seite.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.