GET/api/public/widget/history
Ilayisha imbali yemiyalezo ekhoyo yencoko yewijethi, umzekelo emva kokulayishwa kwakhona kwephepha.
Nikezela `widget_code`, `session_id` ne-`visitor_id` njengeeparamitha zomxanduva. Impendulo iqulethe kwisikhongozelo `data` uluhlu `messages` olune-`role` (`user` okanye `assistant`), `text` kunye no-`created_at` ngokulandelelana kwencoko. Isicelo sifunda kuphela kwaye silingananisayo. I-header `X-Widget-Token` enetoken yokufaka ne-`widget_code` iyafuneka. Ukuba itoken ayikho, iseva iphendula ngo-401 `WIDGET_TOKEN_MISSING`, ukuba ayivumelekile ngo-401 `WIDGET_TOKEN_INVALID`; izicelo ezivela kwiidomeyini ezingavuliweyo zifumana 403 `WIDGET_ORIGIN_DENIED`, iwijethi ecinezelweyo 404 `WIDGET_DISABLED`. Ukuba `session_id` okanye `visitor_id` ayikho, iseva iphendula ngo-400 `PARAMS_REQUIRED`. Ukuba iseshoni ayisaziwa, qalisa incoko entsha.
Ushwankathelo
Ukubiza: GET /api/public/widget/history. 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 (query), session_id (query), visitor_id (query). Iimeko zeempazamo ezibhaliweyo: 400 PARAMS_REQUIRED. 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(query, string, kuyafuneka)— Ikhowudi yewijethi evela kwikhowudi yakho yokufakasession_id(query, string, kuyafuneka)— I-ID yeseshoni yencoko evela kwimpendulo ye-`message`visitor_id(query, string, kuyafuneka)— I-ID yendwendwe eyenziwa yiwijethi kwaye igcinwe kwibhrawuzaUmzekelo we-response
{"ok":true,"data":{"messages":[{"role":"user","text":"Molo...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}Iikhowudi zeempazamo
400 PARAMS_REQUIRED — `session_id` okanye `visitor_id` ayikho.Ukuziphatha okujongwe
Iseshoni ekhoyo inikeza 200 nembali yemiyalezo; iiparamitha ezingekho zinikeza 400 `PARAMS_REQUIRED`.
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.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.POST /api/public/widget/voice-speakIguqula umbhalo kube ulwimi olukhulunywayo (ukukhutshwa kwezwi kwiwijethi), ukuba umsebenzi wezwi uvuliwe.