POST/api/public/widget/voice-transcribe

Prevedie hlasovú nahrávku návštevníka na text (hlasový vstup), ak je pre widget aktivovaná hlasová funkcia.

Odošlite `widget_code` a zvukové dáta v poli `audio` ako `multipart/form-data`. Odpoveď obsahuje rozpoznaný text, ktorý potom odošlete cez `POST /api/public/widget/message`. Či je hlasová funkcia aktívna, ukazuje `voice_enabled` v konfigurácii widgetu. Chýba-li `widget_code`, server odpovie 400 `WIDGET_CODE_REQUIRED`; ak hlasová funkcia nie je aktivovaná alebo je momentálne nedostupná, 503 `VOICE_UNAVAILABLE`. Hlasovú funkciu pre váš widget nastaví Zentor.

Prehľad

Volanie: POST /api/public/widget/voice-transcribe. Tento endpoint patrí do skupiny „Chatový widget“ API aplikácie Zentor App. Vyžaduje platný token na vloženie widgetu. Volanie nie je idempotentné: Každé úspešné volanie akciu spustí znova. Povinné parametre: widget_code (body), audio (body). Zdokumentované chybové prípady: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Ukážková odpoveď nižšie zobrazuje štruktúru úspešnej odpovede vo formáte JSON.

Autentifikácia a zabezpečenie

Embed token widgetu (hlavička X-Widget-Token) + zoznam povolených pôvodov (Origin)

Idempotentné: Nie

Parametre

widget_code(body, string, povinné)— Kód widgetu z vášho vkladacieho kódu
audio(body, binary, povinné)— Zvuková nahrávka ako súbor (`multipart/form-data`)

Príklad odpovede

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Funkcia reči v súčasnosti nie je dostupná."}}

Chybové kódy

400 WIDGET_CODE_REQUIRED — Chýba pole `widget_code`.
503 VOICE_UNAVAILABLE — Hlasová funkcia nie je pre tento widget aktivovaná alebo je momentálne nedostupná.

Overené správanie

Chýbajúci `widget_code` vráti 400 `WIDGET_CODE_REQUIRED`, widget bez hlasovej funkcie 503 `VOICE_UNAVAILABLE`. Prípad úspechu vyžaduje widget s aktivovanou hlasovou funkciou.

Chatový widget

GET /api/public/widget/healthJednoduchá kontrola dostupnosti služby widgetu.GET /api/public/widget/config/:widget_codeVracia verejnú konfiguráciu widgetu (zobrazovaný názov, uvítací text, dizajn, jazyk, hlasová funkcia) na inicializáciu v prehliadači.POST /api/public/widget/messageOdošle správu návštevníka chatbotovi a vráti jeho odpoveď – centrálny endpoint chatovacieho widgetu.GET /api/public/widget/historyNačíta predchádzajúcu históriu správ konverzácie widgetu, napríklad po opätovnom načítaní stránky.POST /api/public/widget/pollZíska správy prijaté po určitom okamihu – napríklad odpoveď pracovníka, ktorý prevzal konverzáciu.POST /api/public/widget/ratingUloží hodnotenie návštevníka konverzácie (užitočné alebo neužitočné).POST /api/public/widget/trackZaznamená anonymnú udalosť využitia widgetu (napr. „widget otvorený“) pre analýzy v dashboarde.POST /api/public/widget/voice-speakPrevedie text na hovorené slovo (hlasový výstup v widgete), ak je hlasová funkcia aktivovaná.

Súvisiace články

← Chatový widget