Обзор
Webhooks API MyChatBot позволяет интегрировать любую внешнюю чат- или мессенджер-систему с агентом. Это даёт AI-ассистенту возможность общаться с пользователями с любой чат-платформы или кастомного приложения, способного отправлять HTTP-запросы.
Настройка webhooks
Обязательные поля: API Token (уникальный токен для аутентификации запросов), Unique Page ID (уникальный идентификатор страницы интеграции), Reply Webhook URL (куда MyChatBot отправляет ответы).
Шаги подключения: перейдите на вкладку Integrations → выберите агента → прокрутите до Webhooks API → нажмите Connect → заполните API Token, Unique Page ID и Reply Webhook URL → включите Connect assistant to this channel → установите Reply Delay (секунды) ползунком → нажмите Connect Webhooks API для сохранения.
Отправка сообщений в MyChatBot
Сделайте POST-запрос на endpoint webhook:
POST https://api.mychatbot.app/webhook/mychatbotДобавьте следующий JSON-payload:
{
"client_id": "UNIQUE_CLIENT_IDENTIFIER",
"page_id": "YOUR_PAGE_ID",
"client_name": "User Name",
"client_avatar": "https://example.com/avatar.jpg",
"platform": "YOUR_PLATFORM_NAME",
"text": "Hello, I have a question",
"attachments": ["https://example.com/image.jpg"]
}Обязательные поля: client_id (уникальный идентификатор конечного пользователя), page_id (настроенный Page ID), platform (название вашей платформы, напр. «CustomApp»), text (сообщение пользователя). Опциональные поля: client_name (отображаемое имя), client_avatar (URL аватара), audio (URL для голосовых сообщений), attachments (массив URL файлов/изображений).
Получение ответов
MyChatBot отправляет ответы на указанный Reply Webhook URL как form-encoded POST-запрос с параметрами: text (текст ответа), images (URL изображений, при наличии), file (URL вложенного файла), audio (URL аудио для голосовых ответов).
Поддержка голосовых сообщений
API поддерживает голос в обоих направлениях. Отправка голоса в MyChatBot: добавьте audio URL в запрос, MyChatBot автоматически транскрибирует его и обрабатывает как текст:
{
"client_id": "UNIQUE_CLIENT_IDENTIFIER",
"page_id": "YOUR_PAGE_ID",
"client_name": "User Name",
"platform": "YOUR_PLATFORM_NAME",
"audio": "https://example.com/audio.mp3"
}Получение голосовых ответов: если голосовые ответы включены в настройках, ассистент может отвечать голосовыми сообщениями, которые включаются в ответ webhook как параметр audio.
Технические детали
Обработка сообщений: запрос декодируется и валидируется; система проверяет, что канал активен для Page ID; запись чата извлекается или создаётся; аудио (при наличии) транскрибируется; сообщение добавляется в историю; ассистент генерирует ответ; ответ отправляется на Reply Webhook URL.
Транскрипция аудио: MyChatBot скачивает аудиофайл, транскрибирует его через speech-to-text, обрабатывает транскрибированный текст как обычное сообщение и добавляет префикс, указывающий на голосовое происхождение.
Генерация ответа: ассистент генерирует ответ на основе контекста; ссылки/медиа извлекаются; текст разбивается на управляемые части при необходимости; каждая часть отправляется на Reply Webhook URL; если голос включён, текст также конвертируется в речь.
Обработка ошибок
MyChatBot возвращает стандартные HTTP-коды: 200 OK (успешно), 400 Bad Request (некорректный запрос или отсутствуют обязательные поля), 401 Unauthorized (недействительный API-токен), 500 Internal Server Error (ошибка на сервере).
Расширенные возможности и сценарии
Многочастные сообщения: ответы, превышающие максимальную длину, автоматически разбиваются на несколько частей и отправляются последовательно. Поддержка медиа: изображения (параметр images), файлы (file) и аудио (audio), всё как URL-ссылки. Задержка ответа: настраивается в кабинете для более естественного потока.
Сценарии использования: кастомные чат-приложения; интеграция с существующими системами поддержки; чат в мобильных приложениях; IoT-устройства с мессенджингом; кастомные бизнес-приложения, требующие AI-чата; сторонние платформы, не поддерживаемые напрямую.