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.

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

Widget-Embed-Token (заголовок 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Перетворює голосовий запис відвідувача в текст (голосове введення), якщо для віджета активовано голосову функцію.

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

← Чат-віджет