POST/api/public/widget/voice-transcribe

Convertește o înregistrare vocală a vizitatorului în text (intrare vocală), dacă funcția vocală este activată pentru widget.

Trimiteți `widget_code` și datele audio în câmpul `audio` ca `multipart/form-data`. Răspunsul conține textul recunoscut, pe care îl trimiteți apoi prin `POST /api/public/widget/message`. Dacă funcția vocală este activă indică `voice_enabled` în configurația widgetului. Dacă lipsește `widget_code`, serverul răspunde cu 400 `WIDGET_CODE_REQUIRED`; dacă funcția vocală nu este activată sau este momentan indisponibilă, cu 503 `VOICE_UNAVAILABLE`. Zentor configurează funcția vocală pentru widgetul dumneavoastră.

Prezentare generală

Apel: POST /api/public/widget/voice-transcribe. Acest endpoint aparține grupului „Widget de chat” al API-ului Zentor App. Necesită un token valid de încorporare a widgetului. Apelul nu este idempotent: fiecare apel reușit declanșează din nou acțiunea. Parametri obligatorii: widget_code (body), audio (body). Cazuri de eroare documentate: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Răspunsul exemplu de mai jos arată structura unui răspuns reușit în format JSON.

Autentificare și securitate

Token de embed pentru widget (header X-Widget-Token) + listă de origini permise

Idempotent: Nu

Parametri

widget_code(body, string, obligatoriu)— Codul widgetului din codul dumneavoastră de încorporare
audio(body, binary, obligatoriu)— Înregistrare audio ca fișier (`multipart/form-data`)

Exemplu de răspuns

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Funcția de vorbire nu este disponibilă în prezent."}}

Coduri de eroare

400 WIDGET_CODE_REQUIRED — Câmpul `widget_code` lipsește.
503 VOICE_UNAVAILABLE — Funcția vocală nu este activată pentru acest widget sau este momentan indisponibilă.

Comportament verificat

Un `widget_code` lipsă returnează 400 `WIDGET_CODE_REQUIRED`, un widget fără funcție vocală 503 `VOICE_UNAVAILABLE`. Cazul de succes necesită un widget cu funcția vocală activată.

Widget de chat

GET /api/public/widget/healthVerificare simplă a disponibilității serviciului de widget.GET /api/public/widget/config/:widget_codeOferă configurația publică a unui widget (nume afișat, mesaj de bun venit, design, limbă, funcție vocală) pentru inițializarea în browser.POST /api/public/widget/messageTrimite un mesaj al vizitatorului către chatbot și returnează răspunsul acestuia — endpointul central al widgetului de chat.GET /api/public/widget/historyÎncarcă istoricul de mesaje anterior al unei conversații de widget, de exemplu după reîncărcarea paginii.POST /api/public/widget/pollObține mesajele primite după un anumit moment — de exemplu răspunsul unui angajat care a preluat conversația.POST /api/public/widget/ratingSalvează evaluarea vizitatorului despre o conversație (utilă sau neutilă).POST /api/public/widget/trackÎnregistrează un eveniment anonim de utilizare a widgetului (de ex. „widget deschis”) pentru analizele din panoul de control.POST /api/public/widget/voice-speakConvertește text în vorbire (ieșire vocală în widget), dacă funcția vocală este activată.

Articole similare

← Widget de chat