POST/api/public/widget/voice-transcribe

Wandelt eine Sprachaufnahme des Besuchers in Text um (Spracheingabe), sofern die Sprachfunktion für das Widget aktiviert ist.

Senden Sie `widget_code` und die Audiodaten im Feld `audio` als `multipart/form-data`. Die Antwort enthält den erkannten Text, den Sie anschließend über `POST /api/public/widget/message` senden. Ob die Sprachfunktion aktiv ist, zeigt `voice_enabled` in der Widget-Konfiguration. 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`. Die Sprachfunktion richtet Zentor für Ihr Widget ein.

Überblick

Aufruf: POST /api/public/widget/voice-transcribe. Der Endpunkt gehört zur Gruppe „Chat-Widget“ der API von Zentor App. Er erfordert ein gültiges Widget-Embed-Token. Der Aufruf ist nicht idempotent: Jeder erfolgreiche Aufruf löst die Aktion erneut aus. Pflichtparameter: widget_code (Body), audio (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: Nein

Parameter

widget_code(body, string, erforderlich)— Widget-Code aus Ihrem Einbindungscode
audio(body, binary, erforderlich)— Audioaufnahme als Datei (`multipart/form-data`)

Beispiel-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-speakWandelt Text in gesprochene Sprache um (Sprachausgabe im Widget), sofern die Sprachfunktion aktiviert ist.

Verwandte Artikel

← Chat-Widget