POST/api/public/widget/voice-transcribe

Pretvori glasovni posnetek obiskovalca v besedilo (glasovni vnos), če je glasovna funkcija za gradnik aktivirana.

Pošljite `widget_code` in avdio podatke v polju `audio` kot `multipart/form-data`. Odgovor vsebuje prepoznano besedilo, ki ga nato pošljete prek `POST /api/public/widget/message`. Ali je glasovna funkcija aktivna, prikazuje `voice_enabled` v konfiguraciji gradnika. Če `widget_code` manjka, strežnik odgovori s 400 `WIDGET_CODE_REQUIRED`; če glasovna funkcija ni aktivirana ali trenutno ni na voljo, s 503 `VOICE_UNAVAILABLE`. Glasovno funkcijo za vaš gradnik nastavi Zentor.

Pregled

Klic: POST /api/public/widget/voice-transcribe. Ta endpoint spada v skupino »Klepetalni gradnik« API-ja Zentor App. Zahteva veljaven žeton za vdelavo pripomočka (widget embed token). Klic ni idempotenten: vsak uspešen klic znova sproži dejanje. Obvezni parametri: widget_code (body), audio (body). Dokumentirani primeri napak: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Spodnji primer odgovora prikazuje strukturo uspešnega odgovora v formatu JSON.

Avtentikacija in zaščita

Žeton za vdelavo gradnika (glava X-Widget-Token) + seznam dovoljenih izvorov

Idempotentno: Ne

Parametri

widget_code(body, string, obvezno)— Koda gradnika iz vaše kode za vdelavo
audio(body, binary, obvezno)— Avdioposnetek kot datoteka (`multipart/form-data`)

Primer odgovora

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Funkcija govora trenutno ni na voljo."}}

Kode napak

400 WIDGET_CODE_REQUIRED — Manjka polje `widget_code`.
503 VOICE_UNAVAILABLE — Glasovna funkcija za ta gradnik ni aktivirana ali trenutno ni na voljo.

Preverjeno vedenje

Manjkajoč `widget_code` vrne 400 `WIDGET_CODE_REQUIRED`, gradnik brez glasovne funkcije 503 `VOICE_UNAVAILABLE`. Primer uspeha predpostavlja gradnik z aktivirano glasovno funkcijo.

Klepetalni gradnik

GET /api/public/widget/healthEnostavno preverjanje dosegljivosti storitve gradnika (widgeta).GET /api/public/widget/config/:widget_codeVrne javno konfiguracijo gradnika (prikazno ime, pozdravno besedilo, oblikovanje, jezik, glasovno funkcijo) za inicializacijo v brskalniku.POST /api/public/widget/messagePošlje sporočilo obiskovalca klepetalnemu robotu in vrne njegov odgovor – osrednja končna točka klepetalnega gradnika.GET /api/public/widget/historyNaloži pretekli potek sporočil pogovora gradnika, na primer po ponovnem nalaganju strani.POST /api/public/widget/pollPrikliče sporočila, prejeta po določenem trenutku – na primer odgovor sodelavca, ki je prevzel pogovor.POST /api/public/widget/ratingShrani oceno obiskovalca za pogovor (koristno ali ni koristno).POST /api/public/widget/trackZajame anonimen dogodek uporabe gradnika (npr. „gradnik odprt“) za analize na nadzorni plošči.POST /api/public/widget/voice-speakPretvori besedilo v govorjeno govorico (glasovni izhod v gradniku), če je glasovna funkcija aktivirana.

Sorodni članki

← Klepetalni gradnik