Чат-віджет

Усі ендпоінти, які використовує вбудований чат-віджет на вашому сайті.

Чат-віджет вбудовує вашого чат-бота на ваш сайт. Ця група описує всі ендпоінти, які використовує віджет: перевірку доступності, публічну конфігурацію віджета, надсилання повідомлень, історію розмови, отримання нових повідомлень (наприклад, після перехоплення розмови співробітником), оцінку, події використання, а також голосовий ввід і вивід.

`health` і `config` доступні без автентифікації, щоб віджет міг ініціалізуватися в браузері. Усі інші ендпоінти очікують `widget_code` і embed-токен віджета в заголовку `X-Widget-Token`. Zentor створює віджет під час налаштування, зберігає дозволені домени та надає вам код вбудовування з кодом віджета та embed-токеном. Викликі з недозволених доменів сервер відхиляє кодом 403 `WIDGET_ORIGIN_DENIED`, деактивований віджет отримує відповідь кодом 404 `WIDGET_DISABLED`.

Додатково діють правила доступу вашого акаунта (правила за IP, країнами та доменами). `message` не ідемпотентний: кожне повторне надсилання створює нове повідомлення і нову відповідь.

GET/api/public/widget/healthGET/api/public/widget/config/:widget_codePOST/api/public/widget/messageGET/api/public/widget/historyPOST/api/public/widget/pollPOST/api/public/widget/ratingPOST/api/public/widget/trackPOST/api/public/widget/voice-transcribePOST/api/public/widget/voice-speak
← Довідник API