GET/api/public/widget/history
Wczytuje wcześniejszą historię wiadomości rozmowy widżetu, na przykład po ponownym wczytaniu strony.
Przekażcie `widget_code`, `session_id` i `visitor_id` jako parametry zapytania. Odpowiedź zawiera w obiekcie `data` listę `messages` z `role` (`user` lub `assistant`), `text` i `created_at` w kolejności rozmowy. Wywołanie jest tylko do odczytu i idempotentne. Nagłówek `X-Widget-Token` z tokenem osadzania oraz `widget_code` są wymagane. Jeśli token jest brak, serwer odpowiada 401 `WIDGET_TOKEN_MISSING`; jeśli jest nieprawidłowy, 401 `WIDGET_TOKEN_INVALID`; wywołania z niezatwierdzonych domen otrzymują 403 `WIDGET_ORIGIN_DENIED`, a dezaktywowany widżet 404 `WIDGET_DISABLED`. Jeśli brakuje `session_id` lub `visitor_id`, serwer odpowiada 400 `PARAMS_REQUIRED`. Jeśli sesja nie jest już znana, zacznijcie nową rozmowę.
Przegląd
Wywołanie: GET /api/public/widget/history. Ten endpoint należy do grupy „Widżet czatu” API Zentor App. Wymaga ważnego tokenu osadzania widżetu. Wywołanie jest idempotentne: powtarzane wywołania z tymi samymi danymi zwracają ten sam wynik. Parametry wymagane: widget_code (query), session_id (query), visitor_id (query). Udokumentowane przypadki błędów: 400 PARAMS_REQUIRED. Poniższa przykładowa odpowiedź pokazuje strukturę udanej odpowiedzi w formacie JSON.
Uwierzytelnianie i zabezpieczenia
Token osadzenia widżetu (nagłówek X-Widget-Token) + lista dozwolonych originów
Idempotentny: Tak
Parametry
widget_code(query, string, wymagane)— Kod widżetu z Waszego kodu osadzaniasession_id(query, string, wymagane)— ID sesji rozmowy z odpowiedzi `message`visitor_id(query, string, wymagane)— ID odwiedzającego generowany przez widżet i zapisywany w przeglądarcePrzykładowa odpowiedź
{"ok":true,"data":{"messages":[{"role":"user","text":"Cześć...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}Kody błędów
400 PARAMS_REQUIRED — Brakuje `session_id` lub `visitor_id`.Zweryfikowane zachowanie
Istniejąca sesja zwraca 200 z historią wiadomości; brakujące parametry zwracają 400 `PARAMS_REQUIRED`.
Widżet czatu
GET /api/public/widget/healthProste sprawdzenie dostępności usługi widżetu.GET /api/public/widget/config/:widget_codeZwraca publiczną konfigurację widżetu (nazwa wyświetlana, powitanie, wygląd, język, funkcja głosowa) do inicjalizacji w przeglądarce.POST /api/public/widget/messageWysyła wiadomość odwiedzającego do chatbota i zwraca jego odpowiedź — centralny punkt końcowy widżetu czatu.POST /api/public/widget/pollPobiera wiadomości otrzymane po określonym momencie — na przykład odpowiedź pracownika, który przejął rozmowę.POST /api/public/widget/ratingZapisuje ocenę odwiedzającego dotyczącą rozmowy (pomocna lub niepomocna).POST /api/public/widget/trackRejestruje anonimowe zdarzenie użycia widżetu (np. „widżet otwarty”) na potrzeby analiz w panelu.POST /api/public/widget/voice-transcribeZamienia nagranie głosowe odwiedzającego na tekst (wprowadzanie głosowe), jeśli funkcja głosowa jest aktywowana dla widżetu.POST /api/public/widget/voice-speakZamienia tekst na mowę (wyjście głosowe w widżecie), jeśli funkcja głosowa jest aktywowana.