GET/api/public/widget/history

Laadt de eerdere berichtgeschiedenis van een widgetgesprek, bijvoorbeeld na het opnieuw laden van de pagina.

Geef `widget_code`, `session_id` en `visitor_id` als querystringparameters door. Het antwoord bevat in het object `data` de lijst `messages` met `role` (`user` of `assistant`), `text` en `created_at` in de volgorde van het gesprek. De aanroep is alleen-lezen en idempotent. De header `X-Widget-Token` met het embed-token en `widget_code` zijn verplicht. Ontbreekt het token, dan antwoordt de server met 401 `WIDGET_TOKEN_MISSING`; is het ongeldig, met 401 `WIDGET_TOKEN_INVALID`; aanroepen vanaf niet-goedgekeurde domeinen krijgen 403 `WIDGET_ORIGIN_DENIED`, een gedeactiveerde widget 404 `WIDGET_DISABLED`. Ontbreken `session_id` of `visitor_id`, dan antwoordt de server met 400 `PARAMS_REQUIRED`. Is de sessie niet meer bekend, start dan een nieuw gesprek.

Overzicht

Aanroep: GET /api/public/widget/history. Dit endpoint hoort bij de groep ‘Chatwidget’ van de API van Zentor App. Het vereist een geldig widget-embedtoken. De aanroep is idempotent: herhaalde aanroepen met dezelfde gegevens leveren hetzelfde resultaat op. Verplichte parameters: widget_code (query), session_id (query), visitor_id (query). Gedocumenteerde foutgevallen: 400 PARAMS_REQUIRED. Het voorbeeldantwoord hieronder toont de opbouw van een geslaagd antwoord in JSON-formaat.

Auth & beveiliging

Widget-embed-token (header X-Widget-Token) + origin-toestemmingslijst

Idempotent: Ja

Parameters

widget_code(query, string, vereist)— Widgetcode uit uw embedcode
session_id(query, string, vereist)— Sessie-ID van het gesprek uit het antwoord van `message`
visitor_id(query, string, vereist)— Bezoeker-ID die de widget genereert en in de browser opslaat

Voorbeeld-response

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

Foutcodes

400 PARAMS_REQUIRED — `session_id` of `visitor_id` ontbreekt.

Geverifieerd gedrag

Een bestaande sessie geeft 200 met de berichtgeschiedenis; ontbrekende parameters geven 400 `PARAMS_REQUIRED`.

Chatwidget

GET /api/public/widget/healthEenvoudige bereikbaarheidscontrole van de widgetservice.GET /api/public/widget/config/:widget_codeGeeft de publieke configuratie van een widget (weergavenaam, welkomsttekst, vormgeving, taal, spraakfunctie) voor initialisatie in de browser.POST /api/public/widget/messageStuurt een bericht van de bezoeker naar de chatbot en geeft diens antwoord terug — het centrale endpoint van de chatwidget.POST /api/public/widget/pollHaalt berichten op die na een bepaald tijdstip zijn ontvangen — bijvoorbeeld het antwoord van een medewerker die het gesprek heeft overgenomen.POST /api/public/widget/ratingSlaat de beoordeling van de bezoeker over een gesprek op (nuttig of niet nuttig).POST /api/public/widget/trackRegistreert een anoniem gebruiksevent van de widget (bijv. “widget geopend”) voor de analyses in het dashboard.POST /api/public/widget/voice-transcribeZet een spraakopname van de bezoeker om in tekst (spraakinvoer), als de spraakfunctie voor de widget is geactiveerd.POST /api/public/widget/voice-speakZet tekst om in gesproken taal (spraakuitvoer in de widget), als de spraakfunctie is geactiveerd.

Gerelateerde artikelen

← Chatwidget