Настройка уведомлений через MAX

Планировщик может отправлять уведомления в мессенджер MAX с помощью MAX-бота.

Данный узел или опция доступны, только если они включены в лицензии PolyAnalyst Server.

Чтобы создать оповещение через MAX, выберите Добавить MAX-уведомление в меню Добавить задачу.

В открывшемся окне заполните необходимые поля:

Список полей представлен ниже:

  • Имя – имя задачи;

  • Алиас соединения – алиас соединения MAX API, содержащий секрет бота и, при необходимости, его ID, см. раздел MAX-бот и получатели ниже. Поле обязательно;

  • Тип ID получателя – ID чата или ID пользователя: определяет, как обрабатываются идентификаторы получателей без префикса;

  • Формат текста – Обычный текст, Markdown или HTML;

  • Сообщение – текст уведомления;

  • Получатели (ID чатов или пользователей) – список получателей. Введите идентификатор и добавьте его в список или воспользуйтесь кнопкой Получить ID от бота, см. раздел Как узнать ID получателей ниже.

Обратите внимание, что вы можете использовать макросы при отправке уведомлений. Нажмите кнопку Вставить макрос, чтобы открыть список доступных макросов:

  • Имя сервера (<server>) – позволяет указать имя сервера (IP-адрес);

  • ID проекта (<projectId>) – позволяет указать ID проекта;

  • Имя проекта (<projectName>) – позволяет указать имя проекта;

  • Время выполнения (<time>) – позволяет указать время исполнения задачи;

  • Имя уведомления (<alertName>) – позволяет указать имя уведомления;

  • Триггер (<trigger>) – позволяет указать триггер (заполняется только если выбран тип выполнения по Триггеру);

  • Имя узла (<objName>) – позволяет указать название узла (заполняется только если выбран тип выполнения по Триггеру);

  • Тип узла (<objType>) – позволяет указать тип узла (заполняется только если выбран тип выполнения по Триггеру);

  • Инициатор (<caller>) – позволяет указать инициатора задачи;

  • Файл (<file>) – позволяет указать файл, который необходимо будет послать вместе с сообщением (например, вы можете использовать следующий синтаксис <file("@user@\some_file.png")>, где @user@ – это алиас вашей домашней папки на Диске PolyAnalyst, а some_file.png – пример файла).

Макросы из списка выбираются только по одному. Если вам необходимо использовать несколько макросов, откройте меню Вставить макрос несколько раз.

Длинное сообщение разбивается на несколько сообщений длиной до 4000 символов. Каждый файл отправляется отдельным сообщением после текста. Если сообщение не удалось доставить хотя бы одному получателю или не удалось отправить файл, задача завершается с ошибкой, в тексте которой перечислены получатели и причины.

MAX-бот и получатели

Задача не хранит учетные данные бота. Секрет (токен доступа бота) и необязательный ID бота берутся из алиаса соединения MAX API. Если ID бота указан, задача проверяет, что секрет принадлежит этому боту. Чтобы создать алиас, перейдите в Настройки сервера в Административном клиенте, затем выберите Подключение к данным и API → API-ключи → MAX API и укажите имя алиаса, секрет и при необходимости ID бота. Как создать бота и получить его токен доступа, см. официальную документацию MAX Bot API; ID бота – это значение user_id, которое возвращает метод GET /me MAX Bot API, оно не связано с никнеймом бота.

MAX различает два вида получателей: ID чата определяет диалог, групповой чат или канал (например, -123456789), а ID пользователя – пользователя MAX (например, 123456789; ID пользователя не может быть отрицательным). Префикс в значении имеет приоритет над параметром Тип ID получателя: c: обозначает ID чата (например, c:-123456789), u: – ID пользователя (например, u:123456789).

Бот должен иметь возможность отправлять сообщения получателю: например, бот должен быть добавлен в групповой чат, или пользователь должен начать диалог с ботом.

Как узнать ID получателей

Интерфейс MAX не показывает ID чатов и пользователей, а ссылка на профиль (https://max.ru/u/{id}) не содержит ID пользователя. ID становятся известны боту, когда с ним что-то происходит:

  1. Выберите алиас соединения и нажмите Получить ID от бота.

  2. В течение 30 секунд добавьте бота в групповой чат (для этого нужно быть администратором чата) или, для личных уведомлений, запустите бота или напишите ему из аккаунта пользователя.

  3. Найденные чаты и пользователи будут показаны списком с их ID. Отметьте нужные и нажмите Добавить: ID с префиксом c: (чат) или u: (пользователь) добавятся в список получателей.

Если ничего не найдено, нажмите кнопку еще раз и повторите действие, пока кнопка ожидает.