GET/api/public/widget/history

Hupakia historia iliyopo ya ujumbe wa mazungumzo ya wijeti, kwa mfano baada ya kupakia upya ukurasa.

Pitisheni `widget_code`, `session_id` na `visitor_id` kama vigezo vya hoja. Jibu linajumuisha ndani ya kipengele `data` orodha `messages` yenye `role` (`user` au `assistant`), `text` na `created_at` kwa mpangilio wa mazungumzo. Ombi hili ni la kusoma tu na ni idempotent. Kichwa `X-Widget-Token` chenye tokeni ya kupachika na `widget_code` ni lazima. Tokeni ikikosekana, seva hujibu kwa 401 `WIDGET_TOKEN_MISSING`, ikiwa batili kwa 401 `WIDGET_TOKEN_INVALID`; maombi kutoka vikoa visivyoidhinishwa hupokea 403 `WIDGET_ORIGIN_DENIED`, wijeti iliyozimwa 404 `WIDGET_DISABLED`. `session_id` au `visitor_id` ikikosekana, seva hujibu kwa 400 `PARAMS_REQUIRED`. Iwapo kipindi hakijulikani tena, anzisheni mazungumzo mapya.

Muhtasari

Mwito: GET /api/public/widget/history. Endpoint hii ni sehemu ya kundi la “Wijeti ya mazungumzo” la API ya Zentor App. Inahitaji tokeni halali ya kupachika wijeti (widget embed token). Mwito huu ni idempotent: miito inayorudiwa yenye data ileile hurudisha matokeo yaleyale. Vigezo vya lazima: widget_code (query), session_id (query), visitor_id (query). Hali za hitilafu zilizoandikwa: 400 PARAMS_REQUIRED. Jibu la mfano hapa chini linaonyesha muundo wa jibu lililofanikiwa katika umbizo la JSON.

Uthibitishaji na ulinzi

Embed token ya widget (header X-Widget-Token) + orodha ya origins zilizoidhinishwa

Idempotent: Ndiyo

Vigezo

widget_code(query, string, inahitajika)— Msimbo wa wijeti kutoka msimbo wako wa kupachika
session_id(query, string, inahitajika)— Kitambulisho cha kipindi cha mazungumzo kutoka jibu la `message`
visitor_id(query, string, inahitajika)— Kitambulisho cha mgeni kinachotengenezwa na wijeti na kuhifadhiwa kwenye kivinjari

Mfano wa jibu (response)

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

Misimbo ya hitilafu

400 PARAMS_REQUIRED — `session_id` au `visitor_id` inakosekana.

Tabia iliyoangaliwa

Kipindi kilichopo hutoa 200 na historia ya ujumbe; vigezo vinavyokosekana hutoa 400 `PARAMS_REQUIRED`.

Wijeti ya mazungumzo

GET /api/public/widget/healthUkaguzi rahisi wa upatikanaji wa huduma ya wijeti.GET /api/public/widget/config/:widget_codeHutoa usanidi wa umma wa wijeti (jina linaloonyeshwa, ujumbe wa karibu, mandhari, lugha, kipengele cha sauti) kwa uanzishaji kwenye kivinjari.POST /api/public/widget/messageHutuma ujumbe wa mgeni kwa chatbot na kutoa jibu lake – kipengele kikuu cha wijeti ya gumzo.POST /api/public/widget/pollInarudisha ujumbe uliopokelewa baada ya wakati fulani – kwa mfano jibu la mfanyakazi aliyechukua mazungumzo.POST /api/public/widget/ratingHuhifadhi tathmini ya mgeni kuhusu mazungumzo (yenye manufaa au bila manufaa).POST /api/public/widget/trackHurekodi tukio la matumizi lisilojulikana la wijeti (mf. „wijeti imefunguliwa“) kwa uchambuzi kwenye dashibodi.POST /api/public/widget/voice-transcribeHubadilisha rekodi ya sauti ya mgeni kuwa maandishi (uwekaji wa sauti), iwapo kipengele cha sauti cha wijeti kimewezeshwa.POST /api/public/widget/voice-speakHubadilisha maandishi kuwa lugha inayosemwa (matokeo ya sauti kwenye wijeti), iwapo kipengele cha sauti kimewezeshwa.

Makala zinazohusiana

← Wijeti ya mazungumzo