POST/api/public/widget/voice-speak
Shndërron tekstin në të folur (dalje me zë në widget), nëse funksioni i zërit është aktivizuar.
Dërgoni `widget_code` dhe tekstin që duhet lexuar në `text`. Përgjigja përmban të dhënat audio për riprodhim në shfletues. Për riprodhim të drejtpërdrejtë përmes elementit `<audio>`, i njëjti shteg është gjithashtu i disponueshëm përmes GET. Nëse `widget_code` mungon, serveri përgjigjet me 400 `WIDGET_CODE_REQUIRED`; nëse funksioni i zërit nuk është aktivizuar ose momentalisht nuk është i disponueshëm, me 503 `VOICE_UNAVAILABLE`. Nisni një riprodhim të ri vetëm kur i mëparshmi ka përfunduar.
Përmbledhje
Thirrja: POST /api/public/widget/voice-speak. Ky endpoint i përket grupit “Widget-i i bisedës” të API-së së Zentor App. Kërkon një token të vlefshëm për ngulitjen e widget-it (widget embed token). Thirrja është idempotente: thirrjet e përsëritura me të njëjtat të dhëna kthejnë të njëjtin rezultat. Parametrat e detyrueshëm: widget_code (body), text (body). Rastet e dokumentuara të gabimeve: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Përgjigjja shembull më poshtë tregon strukturën e një përgjigjeje të suksesshme në formatin JSON.
Autentifikimi dhe siguria
Widget-Embed-Token (header X-Widget-Token) + lista e lejimeve të Origin
Idempotent: Po
Parametrat
widget_code(body, string, i detyrueshëm)— Kodi i widget-it nga kodi juaj i integrimittext(body, string, i detyrueshëm)— Teksti që duhet lexuarShembull response-i
{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Funksioni i zërit aktualisht nuk është i disponueshëm."}}Kodet e gabimeve
400 WIDGET_CODE_REQUIRED — Mungon fusha `widget_code`.503 VOICE_UNAVAILABLE — Funksioni i zërit nuk është aktivizuar për këtë widget ose momentalisht nuk është i disponueshëm.Sjellja e verifikuar
Një `widget_code` që mungon kthen 400 `WIDGET_CODE_REQUIRED`, një widget pa funksion zëri 503 `VOICE_UNAVAILABLE`. Rasti i suksesit kërkon një widget me funksionin e zërit aktivizuar.
Widget-i i bisedës
GET /api/public/widget/healthKontroll i thjeshtë i disponueshmërisë së shërbimit të widget-it.GET /api/public/widget/config/:widget_codeKthen konfigurimin publik të një widget-i (emri i shfaqjes, mesazhi i mirëseardhjes, dizajni, gjuha, funksioni i zërit) për inicializim në shfletues.POST /api/public/widget/messageDërgon një mesazh të vizitorit te chatbot-i dhe kthen përgjigjen e tij – endpoint-i qendror i widget-it të bisedës.GET /api/public/widget/historyNgarkon historinë e mëparshme të mesazheve të një bisede widget-i, për shembull pas rifreskimit të faqes.POST /api/public/widget/pollMerr mesazhet e marra pas një momenti të caktuar – për shembull përgjigjen e një punonjësi që ka marrë përsipër bisedën.POST /api/public/widget/ratingRuan vlerësimin e vizitorit për një bisedë (e dobishme ose jo e dobishme).POST /api/public/widget/trackRegjistron një ngjarje anonime përdorimi të widget-it (p.sh. „widget-i u hap“) për analizat në panelin e kontrollit.POST /api/public/widget/voice-transcribeShndërron një regjistrim zanor të vizitorit në tekst (hyrje me zë), nëse funksioni i zërit është aktivizuar për widget-in.