GET/api/public/widget/history

Naloži pretekli potek sporočil pogovora gradnika, na primer po ponovnem nalaganju strani.

Posredujte `widget_code`, `session_id` in `visitor_id` kot parametre poizvedbe. Odgovor v objektu `data` vsebuje seznam `messages` z `role` (`user` ali `assistant`), `text` in `created_at` po vrstnem redu pogovora. Klic je izključno za branje in idempotenten. Glava `X-Widget-Token` z žetonom za vdelavo in `widget_code` sta obvezna. Če žeton manjka, strežnik odgovori s 401 `WIDGET_TOKEN_MISSING`, če je neveljaven, s 401 `WIDGET_TOKEN_INVALID`; klici z neodobrenih domen prejmejo 403 `WIDGET_ORIGIN_DENIED`, deaktiviran gradnik 404 `WIDGET_DISABLED`. Če manjka `session_id` ali `visitor_id`, strežnik odgovori s 400 `PARAMS_REQUIRED`. Če seja ni več znana, začnite nov pogovor.

Pregled

Klic: GET /api/public/widget/history. Ta endpoint spada v skupino »Klepetalni gradnik« API-ja Zentor App. Zahteva veljaven žeton za vdelavo pripomočka (widget embed token). Klic je idempotenten: ponovljeni klici z enakimi podatki vrnejo enak rezultat. Obvezni parametri: widget_code (query), session_id (query), visitor_id (query). Dokumentirani primeri napak: 400 PARAMS_REQUIRED. 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: Da

Parametri

widget_code(query, string, obvezno)— Koda gradnika iz vaše kode za vdelavo
session_id(query, string, obvezno)— ID seje pogovora iz odgovora `message`
visitor_id(query, string, obvezno)— ID obiskovalca, ki ga gradnik ustvari in shrani v brskalniku

Primer odgovora

{"ok":true,"data":{"messages":[{"role":"user","text":"Pozdravljeni ...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}

Kode napak

400 PARAMS_REQUIRED — Manjka `session_id` ali `visitor_id`.

Preverjeno vedenje

Obstoječa seja vrne 200 s potekom sporočil; manjkajoči parametri vrnejo 400 `PARAMS_REQUIRED`.

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.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-transcribePretvori glasovni posnetek obiskovalca v besedilo (glasovni vnos), če je glasovna funkcija za gradnik aktivirana.POST /api/public/widget/voice-speakPretvori besedilo v govorjeno govorico (glasovni izhod v gradniku), če je glasovna funkcija aktivirana.

Sorodni članki

← Klepetalni gradnik