GET/api/public/widget/history
Laddar den tidigare meddelandehistoriken för ett widget-samtal, till exempel efter att sidan har laddats om.
Ange `widget_code`, `session_id` och `visitor_id` som frågeparametrar. Svaret innehåller i objektet `data` listan `messages` med `role` (`user` eller `assistant`), `text` och `created_at` i samtalets ordning. Anropet är enbart läsande och idempotent. Headern `X-Widget-Token` med inbäddningstoken och `widget_code` krävs. Saknas token svarar servern med 401 `WIDGET_TOKEN_MISSING`, är den ogiltig med 401 `WIDGET_TOKEN_INVALID`; anrop från domäner som inte godkänts får 403 `WIDGET_ORIGIN_DENIED`, en inaktiverad widget 404 `WIDGET_DISABLED`. Saknas `session_id` eller `visitor_id` svarar servern med 400 `PARAMS_REQUIRED`. Om sessionen inte längre är känd startar du ett nytt samtal.
Översikt
Anrop: GET /api/public/widget/history. Endpointen tillhör gruppen ”Chattwidget” i Zentor Apps API. Den kräver en giltig widget-inbäddningstoken. Anropet är idempotent: Upprepade anrop med samma uppgifter ger samma resultat. Obligatoriska parametrar: widget_code (query), session_id (query), visitor_id (query). Dokumenterade felfall: 400 PARAMS_REQUIRED. Exempelsvaret nedan visar strukturen för ett lyckat svar i JSON-format.
Autentisering & säkerhet
Widget-embed-token (header X-Widget-Token) + lista över godkända origins
Idempotent: Ja
Parametrar
widget_code(query, string, obligatorisk)— Widget-kod från din inbäddningskodsession_id(query, string, obligatorisk)— Samtalets sessions-ID från svaret på `message`visitor_id(query, string, obligatorisk)— Besökar-ID som widgeten genererar och lagrar i webbläsarenExempel på response
{"ok":true,"data":{"messages":[{"role":"user","text":"Hej...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}Felkoder
400 PARAMS_REQUIRED — `session_id` eller `visitor_id` saknas.Verifierat beteende
En befintlig session returnerar 200 med meddelandehistoriken; saknade parametrar returnerar 400 `PARAMS_REQUIRED`.
Chattwidget
GET /api/public/widget/healthEnkel tillgänglighetskontroll av widget-tjänsten.GET /api/public/widget/config/:widget_codeReturnerar en widgets offentliga konfiguration (visningsnamn, välkomsttext, design, språk, röstfunktion) för initiering i webbläsaren.POST /api/public/widget/messageSkickar en besökares meddelande till chattboten och returnerar dess svar – chattwidgetens centrala slutpunkt.POST /api/public/widget/pollHämtar meddelanden som mottagits efter en viss tidpunkt – till exempel svaret från en medarbetare som har tagit över samtalet.POST /api/public/widget/ratingSparar besökarens omdöme om ett samtal (hjälpsamt eller inte hjälpsamt).POST /api/public/widget/trackRegistrerar en anonym widget-användningshändelse (t.ex. ”widget öppnad”) för analyserna i kontrollpanelen).POST /api/public/widget/voice-transcribeKonverterar en besökares röstinspelning till text (röstinmatning), om röstfunktionen är aktiverad för widgeten.POST /api/public/widget/voice-speakKonverterar text till tal (röstutmatning i widgeten), om röstfunktionen är aktiverad.