GET/api/public/widget/history

Завантажує попередню історію повідомлень конверсації віджета, наприклад після перезавантаження сторінки.

Передайте `widget_code`, `session_id` і `visitor_id` як параметри запиту. Відповідь містить в об’єкті `data` список `messages` з `role` (`user` або `assistant`), `text` і `created_at` у порядку розмови. Виклик виключно читальний та ідемпотентний. Заголовок `X-Widget-Token` з embed-токеном і `widget_code` обов’язкові. Якщо токен відсутній, сервер відповідає кодом 401 `WIDGET_TOKEN_MISSING`, якщо недійсний — 401 `WIDGET_TOKEN_INVALID`; виклики з незареєстрованих доменів отримують 403 `WIDGET_ORIGIN_DENIED`, деактивований віджет — 404 `WIDGET_DISABLED`. Якщо відсутній `session_id` або `visitor_id`, сервер відповідає кодом 400 `PARAMS_REQUIRED`. Якщо сесія більше не відома, почніть нову розмову.

Огляд

Виклик: GET /api/public/widget/history. Цей ендпоінт належить до групи «Чат-віджет» API Zentor App. Потрібен дійсний embed-токен віджета. Виклик ідемпотентний: повторні виклики з тими самими даними повертають той самий результат. Обов’язкові параметри: widget_code (query), session_id (query), visitor_id (query). Задокументовані випадки помилок: 400 PARAMS_REQUIRED. Приклад відповіді нижче показує структуру успішної відповіді у форматі JSON.

Автентифікація та захист

Widget-Embed-Token (заголовок X-Widget-Token) + список дозволених Origin

Ідемпотентний: Так

Параметри

widget_code(query, string, обов'язково)— Код віджета з вашого коду вбудовування
session_id(query, string, обов'язково)— ID сесії розмови з відповіді `message`
visitor_id(query, string, обов'язково)— ID відвідувача, який створює і зберігає віджет у браузері

Приклад відповіді

{"ok":true,"data":{"messages":[{"role":"user","text":"Вітаємо...","created_at":"..."},{"role":"assistant","text":"...","created_at":"..."}]}}

Коди помилок

400 PARAMS_REQUIRED — Відсутній `session_id` або `visitor_id`.

Перевірена поведінка

Наявна сесія повертає 200 з історією повідомлень; відсутні параметри повертають 400 `PARAMS_REQUIRED`.

Чат-віджет

GET /api/public/widget/healthПроста перевірка доступності сервісу віджета.GET /api/public/widget/config/:widget_codeПовертає публічну конфігурацію віджета (ім’я для показу, текст привітання, дизайн, мову, голосову функцію) для ініціалізації в браузері.POST /api/public/widget/messageНадсилає повідомлення відвідувача чат-боту і повертає його відповідь — центральний кінцевий пункт чат-віджета.POST /api/public/widget/pollЗапитує повідомлення, що надійшли після певного моменту часу — наприклад, відповідь співробітника, який прийняв розмову.POST /api/public/widget/ratingЗберігає оцінку відвідувача для розмови (корисно або некорисно).POST /api/public/widget/trackФіксує анонімну подію використання віджета (наприклад, «віджет відкрито») для аналізу в панелі керування.POST /api/public/widget/voice-transcribeПеретворює голосовий запис відвідувача в текст (голосове введення), якщо для віджета активовано голосову функцію.POST /api/public/widget/voice-speakПеретворює текст на вимовлену мову (голосовий вивід у віджеті), якщо голосову функцію активовано.

Споріднені статті

← Чат-віджет