Чат-виджет

Все эндпоинты, которые использует встроенный чат-виджет на вашем сайте.

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

`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