GET/api/public/widget/history
Ngarkon historinë e mëparshme të mesazheve të një bisede widget-i, për shembull pas rifreskimit të faqes.
Kaloni `widget_code`, `session_id` dhe `visitor_id` si parametra kërkese. Përgjigja përmban në objektin `data` listën `messages` me `role` (`user` ose `assistant`), `text` dhe `created_at` sipas rendit të bisedës. Thirrja është vetëm për lexim dhe idempotente. Header-i `X-Widget-Token` me token-in e ngulitjes dhe `widget_code` janë të detyrueshme. Nëse token-i mungon, serveri përgjigjet me 401 `WIDGET_TOKEN_MISSING`, nëse është i pavlefshëm me 401 `WIDGET_TOKEN_INVALID`; thirrjet nga domene të pamiratuara marrin 403 `WIDGET_ORIGIN_DENIED`, një widget i deaktivizuar 404 `WIDGET_DISABLED`. Nëse mungon `session_id` ose `visitor_id`, serveri përgjigjet me 400 `PARAMS_REQUIRED`. Nëse seanca nuk njihet më, filloni një bisedë të re.
Përmbledhje
Thirrja: GET /api/public/widget/history. 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 (query), session_id (query), visitor_id (query). Rastet e dokumentuara të gabimeve: 400 PARAMS_REQUIRED. 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(query, string, i detyrueshëm)— Kodi i widget-it nga kodi juaj i integrimitsession_id(query, string, i detyrueshëm)— ID-ja e seancës së bisedës nga përgjigja e `message`visitor_id(query, string, i detyrueshëm)— ID-ja e vizitorit, që e krijon dhe e ruan widget-i në shfletuesShembull response-i
{"ok":true,"data":{"messages":[{"role":"user","text":"Përshëndetje...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}Kodet e gabimeve
400 PARAMS_REQUIRED — Mungon `session_id` ose `visitor_id`.Sjellja e verifikuar
Një seancë ekzistuese kthen 200 me historinë e mesazheve; parametra që mungojnë kthejnë 400 `PARAMS_REQUIRED`.
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.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.POST /api/public/widget/voice-speakShndërron tekstin në të folur (dalje me zë në widget), nëse funksioni i zërit është aktivizuar.