Підключіть перший канал, гайд MyChatBot

Огляд

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-чату; сторонні платформи, які прямо не підтримуються.

Інтеграція Webhooks API