-
Notifications
You must be signed in to change notification settings - Fork 1
roschat bot api
В приложении РОСЧАТ реализована возможность работы пользователей с чат-ботами. Пользователь подписывается на выбранного бота из предложенного ему списка. Затем общение с ботом осуществляется в чате с расширенным для бота функционалом (клавиатуры чата и сообщения, команды управления и т.д.).
Протокол взаимодействия бота с сервером РОСЧАТ реализован на библиотеке Socket.IO, обеспечивающей обмен данными между клиентом и сервером на основе событий в режиме реального времени. Сообщения передаются в формате JSON с учетом регистра символов.
Для начала проектирования бота, необходимо запросить параметры учетной записи разработчика у администратора РОСЧАТ или запросить демо версию сервера на сайте: ros.chat.
После авторизации у разработчика появляется возможность создания учетной записи бота и генерации ключа для подключения к серверу. Подробнее о редактировании и создании бота см. описание страницы разработчика.
Для определения параметров подключения к серверу РОСЧАТ по протоколу реализованному на Socket.IO, клиенту необходимо предварительно выполнить запрос /ajax/config.json по протоколу http.
- start-bot - Открытие сессии бота.
- send-bot-message - Отправка сообщения.
- bot-message-event - Входящие сообщение.
- bot-message-received - Сообщение получено.
- bot-message-watched - Сообщение просмотрено.
- delete-bot-message - Сообщение удалено.
- delete-bot-conversation-event - Удаления чата пользователем.
- get-bot-messages - Запрос истории сообщений.
- get-bot-message - Запрос сообщенийя.
- get-bot-message-details - Запрос деталей сообщения для группового чата.
- get-bot-messages-changes - Запрос изменений в истории сообщений.
- get-bot-messages-last-revision - Запрос последней ревизии истории сообщений.
- get-bot-unwatched-messages - Запрос входящих непросмотренных сообщений.
- get-bot-chats-changes - Запрос изменений в списке чатов.
- get-bot-chats-last-revision - Запрос последней ревизии чатов.
- set-bot-keyboard - Изменение клавиатуры чата.
- bot-button-event - Нажатие кнопки клавиатуры.
- bot-get-acs-info - Запрос информации о пользователе РОСЧАТ из СКУД.
Для передачи управляющий команд, пользователь использует протокол 'Обмен сообщениями'. Команда /start приходит автоматически при запуске пользователем чата с ботом. При удалении бота из чата или его удаления из групповой беседы отправляется команда /stop. Команды /start и /stop зарезервированы сервером РОСЧАТ и не могут быть использованы разработчиком бота.