POST/api/public/widget/voice-speak
Преобразует текст в произнесённую речь (голосовой вывод в виджете), если голосовая функция активирована.
Отправьте `widget_code` и текст для озвучивания в `text`. Ответ содержит аудиоданные для воспроизведения в браузере. Для прямого воспроизведения через элемент `<audio>` тот же путь дополнительно доступен через GET. Если `widget_code` отсутствует, сервер отвечает кодом 400 `WIDGET_CODE_REQUIRED`; если голосовая функция не активирована или временно недоступна — кодом 503 `VOICE_UNAVAILABLE`. Начинайте новое воспроизведение только после завершения предыдущего.
Обзор
Вызов: POST /api/public/widget/voice-speak. Этот эндпоинт относится к группе «Чат-виджет» API Zentor App. Требуется действительный embed-токен виджета. Вызов идемпотентен: повторные вызовы с теми же данными возвращают тот же результат. Обязательные параметры: widget_code (тело), text (тело). Задокументированные случаи ошибок: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Пример ответа ниже показывает структуру успешного ответа в формате JSON.
Аутентификация и защита
Токен встраивания виджета (заголовок X-Widget-Token) + список разрешённых источников (Origin)
Идемпотентный: Да
Параметры
widget_code(body, string, обязательно)— Код виджета из вашего кода встраиванияtext(body, string, обязательно)— Текст, который нужно озвучитьПример ответа
{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Функция речи в настоящее время недоступна."}}Коды ошибок
400 WIDGET_CODE_REQUIRED — Отсутствует поле `widget_code`.503 VOICE_UNAVAILABLE — Голосовая функция не активирована для этого виджета или временно недоступна.Проверенное поведение
Отсутствующий `widget_code` возвращает 400 `WIDGET_CODE_REQUIRED`, виджет без голосовой функции — 503 `VOICE_UNAVAILABLE`. Успешный случай предполагает виджет с активированной голосовой функцией.
Чат-виджет
GET /api/public/widget/healthПростая проверка доступности сервиса виджета.GET /api/public/widget/config/:widget_codeВозвращает публичную конфигурацию виджета (отображаемое имя, приветственный текст, дизайн, язык, голосовую функцию) для инициализации в браузере.POST /api/public/widget/messageОтправляет сообщение посетителя чат-боту и возвращает его ответ — центральный эндпоинт чат-виджета.GET /api/public/widget/historyЗагружает предыдущую историю сообщений конверсации виджета, например после перезагрузки страницы.POST /api/public/widget/pollЗапрашивает сообщения, поступившие после определённого момента времени — например, ответ сотрудника, принявшего разговор.POST /api/public/widget/ratingСохраняет оценку посетителя для конверсации (полезно или бесполезно).POST /api/public/widget/trackФиксирует анонимное событие использования виджета (например, «виджет открыт») для анализа в панели управления.POST /api/public/widget/voice-transcribeПреобразует голосовую запись посетителя в текст (голосовой ввод), если для виджета активирована голосовая функция.