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.

Аутентификация и защита

Токен встраивания виджета (заголовок 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Преобразует текст в произнесённую речь (голосовой вывод в виджете), если голосовая функция активирована.

Связанные статьи

← Чат-виджет