POST/api/public/widget/voice-transcribe

Convertisce una registrazione vocale del visitatore in testo (input vocale), se la funzione vocale è attivata per il widget.

Inviate `widget_code` e i dati audio nel campo `audio` come `multipart/form-data`. La risposta contiene il testo riconosciuto, che inviate poi tramite `POST /api/public/widget/message`. Se la funzione vocale è attiva lo indica `voice_enabled` nella configurazione del widget. Se manca `widget_code`, il server risponde 400 `WIDGET_CODE_REQUIRED`; se la funzione vocale non è attivata o al momento non è disponibile, 503 `VOICE_UNAVAILABLE`. Zentor configura la funzione vocale per il vostro widget.

Panoramica

Chiamata: POST /api/public/widget/voice-transcribe. Questo endpoint appartiene al gruppo «Widget di chat» dell'API di Zentor App. Richiede un token di embed del widget valido. La chiamata non è idempotente: ogni chiamata riuscita attiva nuovamente l'azione. Parametri obbligatori: widget_code (body), audio (body). Casi di errore documentati: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. La risposta di esempio riportata di seguito mostra la struttura di una risposta riuscita in formato JSON.

Autenticazione e sicurezza

Token di incorporamento del widget (header X-Widget-Token) + elenco delle origini consentite

Idempotente: No

Parametri

widget_code(body, string, obbligatorio)— Codice del widget dal vostro codice di incorporamento
audio(body, binary, obbligatorio)— Registrazione audio come file (`multipart/form-data`)

Risposta di esempio

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Sprachfunktion aktuell nicht verfügbar."}}

Codici di errore

400 WIDGET_CODE_REQUIRED — Il campo `widget_code` è mancante.
503 VOICE_UNAVAILABLE — La funzione vocale non è attivata per questo widget o al momento non è disponibile.

Comportamento verificato

Un `widget_code` mancante restituisce 400 `WIDGET_CODE_REQUIRED`, un widget senza funzione vocale 503 `VOICE_UNAVAILABLE`. Il caso di successo richiede un widget con la funzione vocale attivata.

Widget di chat

GET /api/public/widget/healthSemplice controllo di disponibilità del servizio widget.GET /api/public/widget/config/:widget_codeRestituisce la configurazione pubblica di un widget (nome visualizzato, messaggio di benvenuto, design, lingua, funzione vocale) per l'inizializzazione nel browser.POST /api/public/widget/messageInvia un messaggio del visitatore al chatbot e restituisce la sua risposta — l'endpoint centrale del widget di chat.GET /api/public/widget/historyCarica la cronologia dei messaggi precedente di una conversazione del widget, ad esempio dopo il ricaricamento della pagina.POST /api/public/widget/pollRecupera i messaggi ricevuti dopo un determinato momento — ad esempio la risposta di un collaboratore che ha preso in carico la conversazione.POST /api/public/widget/ratingSalva la valutazione del visitatore su una conversazione (utile o non utile).POST /api/public/widget/trackRegistra un evento anonimo di utilizzo del widget (ad es. «widget aperto») per le analisi nella dashboard.POST /api/public/widget/voice-speakConvertisce il testo in voce parlata (output vocale nel widget), se la funzione vocale è attivata.

Articoli correlati

← Widget di chat