GET/api/public/widget/history

Laai die bestaande boodskapgeskiedenis van 'n widget-konversasie, byvoorbeeld na die herlaai van die bladsy.

Gee `widget_code`, `session_id` en `visitor_id` as navraagparameters deur. Die antwoord bevat in die `data`-objek die lys `messages` met `role` (`user` of `assistant`), `text` en `created_at` in die volgorde van die gesprek. Die oproep is suiwer lesend en idempotent. Die header `X-Widget-Token` met die inbedtoken en `widget_code` is verpligtend. Ontbreek die token, antwoord die bediener met 401 `WIDGET_TOKEN_MISSING`, is dit ongeldig met 401 `WIDGET_TOKEN_INVALID`; oproepe van nie-vrygestelde domeine ontvang 403 `WIDGET_ORIGIN_DENIED`, 'n gedeaktiveerde widget 404 `WIDGET_DISABLED`. Ontbreek `session_id` of `visitor_id`, antwoord die bediener met 400 `PARAMS_REQUIRED`. Is die sessie nie meer bekend nie, begin 'n nuwe konversasie.

Oorsig

Oproep: GET /api/public/widget/history. Hierdie eindpunt behoort tot die groep “Chat-widget” van die Zentor App-API. Dit vereis ’n geldige widget-inbedtoken. Die oproep is idempotent: herhaalde oproepe met dieselfde insette lewer dieselfde resultaat. Verpligte parameters: widget_code (query), session_id (query), visitor_id (query). Gedokumenteerde foutgevalle: 400 PARAMS_REQUIRED. Die voorbeeldrespons hieronder toon die struktuur van ’n suksesvolle respons in JSON-formaat.

Verifikasie en sekuriteit

Widget-inbedtoken (X-Widget-Token-header) + lys van toegelate origins

Idempotent: Ja

Parameters

widget_code(query, string, vereis)— Widget-kode uit u inbedkode
session_id(query, string, vereis)— Sessie-ID van die konversasie uit die antwoord van `message`
visitor_id(query, string, vereis)— Besoeker-ID wat die widget genereer en in die blaaier stoor

Voorbeeldrespons

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

Foutkodes

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

Gekontroleerde gedrag

'n Bestaande sessie lewer 200 met die boodskapgeskiedenis; ontbrekende parameters lewer 400 `PARAMS_REQUIRED`.

Chat-widget

GET /api/public/widget/healthEenvoudige bereikbaarheidstoets van die widget-diens.GET /api/public/widget/config/:widget_codeLewer die openbare konfigurasie van 'n widget (vertoonnaam, verwelkomingsteks, ontwerp, taal, spraakfunksie) vir die inisialisering in die blaaier.POST /api/public/widget/messageStuur 'n boodskap van die besoeker aan die kletsbot en lewer sy antwoord – die sentrale endpunt van die kletswidget.POST /api/public/widget/pollHaal boodskappe op wat ná 'n tydstip ontvang is – byvoorbeeld die antwoord van 'n personeellid wat die gesprek oorgeneem het.POST /api/public/widget/ratingStoor die beoordeling van die besoeker oor 'n konversasie (nuttig of nie nuttig nie).POST /api/public/widget/trackRegistreer 'n anonieme gebruiksgebeurtenis van die widget (bv. „widget geopen“) vir die evaluasies in die kontrolepaneel.POST /api/public/widget/voice-transcribeVerander 'n stemopname van die besoeker in teks (spraakinvoer), indien die spraakfunksie vir die widget geaktiveer is.POST /api/public/widget/voice-speakVerander teks in gesproke taal (spraakuitvoer in die widget), indien die spraakfunksie geaktiveer is.

Verwante artikels

← Chat-widget