POST/api/public/widget/voice-speak
Iguqula umbhalo kube ulwimi olukhulunywayo (ukukhutshwa kwezwi kwiwijethi), ukuba umsebenzi wezwi uvuliwe.
Thumela `widget_code` nombhalo wokufundwa ku-`text`. Impendulo iqulethe idatha yesandi yokudlalwa kwibhrawuza. Ukuze kudlalwe ngqo nge-elementi `<audio>`, indlela enye iyafumaneka ngokongezelelweyo nge-GET. Ukuba `widget_code` ayikho, iseva iphendula ngo-400 `WIDGET_CODE_REQUIRED`; ukuba umsebenzi wezwi awuvulwa okanye awukho ngoku, ngo-503 `VOICE_UNAVAILABLE`. Qala ukudlalwa okutsha kuphela xa okwandulelayo kuphelile.
Ushwankathelo
Ukubiza: POST /api/public/widget/voice-speak. Le endpoint yeyeqela elithi “Iwijethi yencoko” le-API ye-Zentor App. Ifuna i-widget embed token esebenzayo. Ukubiza yi-idempotent: ukubiza kaninzi ngolwazi olufanayo kubuyisa isiphumo esifanayo. Iipharamitha ezinyanzelekileyo: widget_code (body), text (body). Iimeko zeempazamo ezibhaliweyo: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Impendulo engumzekelo engezantsi ibonisa ulwakhiwo lwempendulo ephumelelayo ngefomathi ye-JSON.
Ukuqinisekiswa nokhuseleko
Widget embed token (header X-Widget-Token) + uluhlu lwee-origin ezivunyiweyo
Idempotent: Yebo
Iiparamitha
widget_code(body, string, kuyafuneka)— Ikhowudi yewijethi evela kwikhowudi yakho yokufakatext(body, string, kuyafuneka)— Umbhalo omele ufundweUmzekelo we-response
{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Umsebenzi wentetho awukho ngoku."}}Iikhowudi zeempazamo
400 WIDGET_CODE_REQUIRED — Intsimi `widget_code` ayikho.503 VOICE_UNAVAILABLE — Umsebenzi wezwi awuvulwa kwiwijethi kwaye awukho ngoku.Ukuziphatha okujongwe
I-`widget_code` engekho inikeza 400 `WIDGET_CODE_REQUIRED`, iwijethi engenawo umsebenzi wezwi 503 `VOICE_UNAVAILABLE`. Imeko yempumelelo ifuna iwijethi enomsebenzi wezwi uvulwe.
Iwijethi yencoko
GET /api/public/widget/healthUvavanyo olulula lokufikeleleka kwenkonzo yewijethi.GET /api/public/widget/config/:widget_codeInikezela ukucwangciso lokawonke-wonke lwewijethi (igama elibonakalayo, umbhalo wokwamkela, uyilo, ulwimi, umsebenzi wezwi) wokuqaliswa kwibhrawuza.POST /api/public/widget/messageIthumela umyalezo wendwendwe ku-chatbot kwaye inikeze impendulo yayo – isiphelo esisembindini sewijethi yencoko.GET /api/public/widget/historyIlayisha imbali yemiyalezo ekhoyo yencoko yewijethi, umzekelo emva kokulayishwa kwakhona kwephepha.POST /api/public/widget/pollIkhupha imiyalezo efunyenwe emva kwexesha elithile – umzekelo impendulo yomsebenzi othathileyo incoko.POST /api/public/widget/ratingIgcina isivakalisi sendwendwe malunga nencoko (kuluncedo okanye akuluncedo).POST /api/public/widget/trackIrekhoda isiganeko esingaziwayo sokusetyenziswa kwewijethi (umz. „iwijethi ivuliwe“) sokuhlalutywa kwedashboard.POST /api/public/widget/voice-transcribeIguqula ukushicilelwa kwezwi kwendwendwe kube umbhalo (ukufakwa kwezwi), ukuba umsebenzi wezwi wewijethi uvuliwe.