Перейти к основному контенту

Документация по Notifier

Модуль Notifier предназначен для отправки уведомлений в Telegram-чаты, например, о событиях, ошибках или статусах работы системы. Используется для оперативного информирования администраторов и команд.


Конфигурация

  • chat_ids — объект с идентификаторами чатов, берётся из атрибута plg_notifier_chat_ids:
    • Пример: { "default": -123456789, "admins": -987654321 }

Методы

sendToTelegramChat(message, jsonParams, groupCode, type)

Отправляет сообщение в указанный Telegram-чат.

Параметры

Имя Тип Описание
message String Текст сообщения (обязательно)
jsonParams Object Дополнительные параметры, выводятся как JSON-блок (опционально)
groupCode String Код группы чата, например "default", "admins" (по умолчанию "default")
type String Тип сообщения: "info", "success", "warning", "error", "debug" (по умолчанию "info")

Возвращает
Boolean — true если успешно, false если ошибка.

Пример:

Notifier.sendToTelegramChat(
  "Выполнена операция", 
  { user: "admin", status: "ok" }, 
  "admins", 
  "success"
)

Формат сообщения

  • В начале сообщения добавляется иконка по типу:
    • info: ℹ️
    • success: ✅
    • warning: ⚠️
    • error: ❌
    • debug: 🔧
  • Если переданы параметры, они выводятся в виде форматированного JSON-блока.
  • Используется Markdown для форматирования.

Обработка ошибок

  • Если сообщение пустое или не строка — возвращает false и пишет ошибку в лог.
  • Если группа чата не найдена — возвращает false и пишет ошибку в лог.
  • Если ошибка при отправке — возвращает false и пишет ошибку в лог.

Быстрый старт

  1. Настройте атрибут plg_notifier_chat_ids с нужными чатами.
  2. Все уведомления из плагинов LLM уже приходят в ваш чат.
  3. Или вручную используйте Notifier.sendToTelegramChat() для отправки уведомлений.