Интеграция чат-ботов
В этом разделе мы опишем, как вы можете интегрировать свой чат-сервис с нашими чат-ботами.
Наша платформа предоставляет возможность интеграции чат-ботов, таких как Claude Opus, GPT-4 и других моделей, с внешними чат-сервисами через систему взаимодействия вебхуков. Этот интерфейс позволяет легко подключить ваш чат-сервис к нашим чат-ботам и обеспечить бесшовное общение между пользователями и ботами.
Принцип работы
Для интеграции чат-бота с внешним чат-сервисом необходимо настроить вебхуки с каждой стороны. Обмен данными происходит через авторизованные POST-запросы, где токен авторизации передается в заголовке Authorization
. Данные передаются в формате JSON, что требует наличия специального заголовка Content-Type: application/json
.
Инициатором обмена всегда выступает сторона чат-сервиса. При отправке сообщения пользователем, чат-сервис отправляет событие CLIENT_MESSAGE
на вебхук нашего чат-бота. Бот обрабатывает полученное сообщение и генерирует ответ, который отправляется обратно на вебхук чат-сервиса в событии BOT_MESSAGE
.
В случае, если бот считает необходимым перевести диалог на живого оператора, он отправляет событие INVITE_AGENT
на вебхук чат-сервиса. Это событие сигнализирует о том, что дальнейшее общение должно быть передано реальному оператору для более персонализированной поддержки.
Адрес для отправки POST событий
Пример запроса:
При получении события мы ответим кодом 200 👍
Чтобы получать ответы от чат-бота, баланс пользователя или организации должен быть положительный!
Мы будем отправлять ответ на ваш webhook, который вы можете задать при создании интеграции на нашем сервисе в разделе Боты
Примеры основных событий
Если есть необходимость в использовании функции Vision (только для моделей Сlaude и GPT-4) в message также будет необходимо передать список изображения "images": ["url"]
Существую еще несколько событий, которые мы рекомендуем отправлять нам:
Отправьте это событие если оператор принял чат,
Получить баланс
Для интеграции может понадобиться знать текущий баланс, чтобы клиент мог отслеживать необходимость оплаты сервиса. Для того чтобы получить баланс необходимо отправить запрос
В ответ мы отдадим вот такой JSON
Настройка обратного Webhook через API
Для удобства клиентов вам может потребоваться настроить URL для ответов программно без участия клиента, это можно сделать запросом.
Если все гуд то ответ будет такой:
Если у вас остались вопросы по интеграции сервиса, вы можете задать их в нашем Телеграм сообществе: https://t.me/gptunnel_ru
Last updated