Информирование клиентов по событиям с объектов через Telegram

1. Принцип работы

Пульт создает бота в Telegram. Этот бот имеет уникальное имя и работает на сервере Telegram.

В настройках «Приток-Охрана-WEB» (через панель администратора) указывается с каким ботом ему работать. Для одного «Приток-Охрана-WEB» - один бот. Один бот пульта обслуживает всех клиентов, у которых есть логин и пароль (аккаунт) для работы с «Приток-Охрана-WEB» и мобильным приложением «Охрана Приток-А».

«Приток-Охрана-WEB» периодически опрашивает бота, получая сообщения, которые пишет пользователь (команды пользователя).

Уведомления по объектам охраны «Приток-Охрана-WEB» отправляет пользователю в виде сообщений через бота.

Аккаунт пользователя «Приток-Охрана-WEB» привязывается к уникальному идентификатору чата, открытого пользователем с ботом. «Приток-Охрана-WEB» хранит связку «аккаунт-чат» в специальном файле. Путь к директорию с файлом настраивается через панель администратора (см параметр «Путь к хранилищу»). Связка происходит через указание в профиле «Приток-Охрана-WEB» кода авторизации, полученного пользователем при начале работы с ботом.

При возникновении событий на объекте, «Приток-Охрана-WEB» ищет аккаунт для этого объекта. Проверяется настроено ли для этого аккаунта в (профиле пользователя) оповещение через Telegram. Если да, то «Приток-Охрана-WEB» отправляет уведомление (в виде сообщения) пользователю в чат от имени бота (через бота).

На ПЦО должен быть открыт порт для работы с сервером Telegram.

Схема взаимодействия:

[Ядро] - (tcp) - [Приток-Охрана-WEB] - (httpS) - [Telegram]

2. Инструкция по созданию бота Telegram на ПЦО

  1. Установить приложение Telegram на телефон или компьютер.

  2. Начать чат с ботом по имени BotFather.

  3. Нажать кнопку Start в окне чата с ботом.

  4. Выполнить команду /newbot и следовать инструкциям [1].

  5. Подключить бота в настройках «Приток-Охрана-WEB».

Помимо функции создания «Telegram» бота, BotFather также имеет возможность присвоить боту описание и установить иконку. Полное описание доступных команд можно увидеть набрав команду /help в чате с BotFather.

Примеры описания бота:

1 about: Обеспечивает возможность получения уведомлений от Вашей охранной системы.

2 descr: С помощью бота от … Вы сможете получать уведомления от охранной системы и взаимодействовать с ней.

3. Инструкция по подключению бота Telegram к «Приток-Охрана-WEB» на ПЦО

  1. Зайти в админку «Приток-Охрана-WEB» (если заходить в админку с компьютера, на котором установлено приложение, то путь по умолчанию будет http://localhost:8080/grdweb/admin).

  2. В меню слева выбрать пункт «Сервисы оповещения» (или «Внешние сервисы оповещения»).

  3. В группе настроек Telegram Messenger:

    • установить галочку «Включить»;

    • указать наименование бота, выбранное при создании бота (п.2.4);

    • указать API Token, полученный при создании бота (п.2.4);

    • разрешить или запретить выполнение команд через мессенджер;

    • нажать кнопку «Сохранить»;

    • убедиться в отсутствии сообщений об ошибках;

    • проверить состояние сервиса, нажав «состояние» (или кнопку с изображением #).

  4. Сообщить имя бота пользователям (клиентам).

Чтобы отключить бота, нужно отключить оповещение через Telegram.

4. Инструкция для клиента по подключению бота Telegram

  1. Установить приложение Telegram на смартфон (компьютер).

  2. Создать чат с ботом по имени, который сообщил сотрудник ПЦО.

  3. В окне чата с ботом нажать /start.

  4. Получить код авторизации.

  5. Зайти через браузер в веб-интерфейс «Мониторинг» пульта охраны: - нажать «Профиль» в правом верхнем углу; - нажать кнопку + напротив надписи «Внешние сервисы оповещения»; - в появившемся окне «Добавить …» указать имя бота, выбрать Telegram Messenger; - в параметре «Регистрационный код» указать код авторизации, полученный от бота на шаге 3.

  6. Убедиться, что от бота пришло сообщение о регистрации.

Чтобы перестать получать уведомления, нужно удалить связку в профиле.