GET/api/public/widget/history
Laster den tidligere meldingshistorikken til en widget-samtale, for eksempel etter at siden er lastet på nytt.
Oppgi `widget_code`, `session_id` og `visitor_id` som forespørselsparametre. Svaret inneholder i objektet `data` listen `messages` med `role` (`user` eller `assistant`), `text` og `created_at` i samtalens rekkefølge. Kallet er rent lesende og idempotent. Headeren `X-Widget-Token` med innbyggingstokenet og `widget_code` er obligatoriske. Mangler tokenet, svarer serveren med 401 `WIDGET_TOKEN_MISSING`, er det ugyldig, med 401 `WIDGET_TOKEN_INVALID`; kall fra domener som ikke er godkjent, får 403 `WIDGET_ORIGIN_DENIED`, en deaktivert widget 404 `WIDGET_DISABLED`. Mangler `session_id` eller `visitor_id`, svarer serveren med 400 `PARAMS_REQUIRED`. Hvis sesjonen ikke lenger er kjent, starter du en ny samtale.
Oversikt
Kall: GET /api/public/widget/history. Endepunktet tilhører gruppen «Chat-widget» i API-et til Zentor App. Det krever et gyldig widget-innbyggingstoken. Kallet er idempotent: Gjentatte kall med de samme opplysningene gir samme resultat. Obligatoriske parametere: widget_code (query), session_id (query), visitor_id (query). Dokumenterte feiltilfeller: 400 PARAMS_REQUIRED. Eksempelsvaret nedenfor viser strukturen til et vellykket svar i JSON-format.
Autentisering og sikring
Widget-embed-token (header X-Widget-Token) + godkjenningsliste for origins
Idempotent: Ja
Parametere
widget_code(query, string, påkrevd)— Widget-kode fra innbyggingskoden dinsession_id(query, string, påkrevd)— Samtalens sesjons-ID fra svaret på `message`visitor_id(query, string, påkrevd)— Besøkende-ID, som widgeten genererer og lagrer i nettleserenEksempel på svar
{"ok":true,"data":{"messages":[{"role":"user","text":"Hei...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}Feilkoder
400 PARAMS_REQUIRED — `session_id` eller `visitor_id` mangler.Verifisert oppførsel
En eksisterende sesjon returnerer 200 med meldingshistorikken; manglende parametre returnerer 400 `PARAMS_REQUIRED`.
Chat-widget
GET /api/public/widget/healthEnkel tilgjengelighetskontroll av widget-tjenesten.GET /api/public/widget/config/:widget_codeReturnerer en widgets offentlige konfigurasjon (visningsnavn, velkomsttekst, design, språk, talefunksjon) for initialisering i nettleseren.POST /api/public/widget/messageSender en besøkendes melding til chatboten og returnerer svaret – chat-widgetens sentrale endepunkt.POST /api/public/widget/pollHenter meldinger som er mottatt etter et gitt tidspunkt – for eksempel svaret fra en ansatt som har tatt over samtalen.POST /api/public/widget/ratingLagrer den besøkendes vurdering av en samtale (nyttig eller ikke nyttig).POST /api/public/widget/trackRegistrerer en anonym widget-brukshendelse (f.eks. «widget åpnet») for analysene i dashbordet.POST /api/public/widget/voice-transcribeKonverterer en besøkendes taleopptak til tekst (taleinnput), hvis talefunksjonen er aktivert for widgeten.POST /api/public/widget/voice-speakKonverterer tekst til tale (taleutgang i widgeten), hvis talefunksjonen er aktivert.