Модуль community.general.telegram — отправка уведомлений с помощью Telegram

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать коллекцию в плейбуке, укажите: community.general.telegram.

Краткое описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Отправляет уведомления с помощью бота Telegram в подтвержденную группу или пользователю.
Пользователь также может попробовать использовать любой другой метод API ботов Telegram, указав аргумент api_method.

Параметры

Параметр	Комментарии
api_args словарь добавлено в community.general 2.0.0	Любые параметры метода. Сведения о методе, используемом по умолчанию, `SendMessage`, см. на странице https://core.telegram.org/bots/api#sendmessage.
api_method строка добавлено в community.general 2.0.0	Метод Bot API. Подробнее см. на странице https://core.telegram.org/bots/api. По умолчанию: `"SendMessage"`
token строка / обязательный	Токен, идентифицирующий вашего бота Telegram.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния изменений, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, потребуется изменить в `check_mode`).

Примечания

Примечание

Для использования этого модуля вам потребуется аккаунт Telegram и созданный бот Telegram.

Примеры

- name: Send notify to Telegram
  community.general.telegram:
    token: '9999999:XXXXXXXXXXXXXXXXXXXXXXX'
    api_args:
      chat_id: "000000"
      parse_mode: "markdown"
      text: "Your precious application has been deployed: https://example.com"
      disable_web_page_preview: true
      disable_notification: true

- name: Forward message to someone
  community.general.telegram:
    token: '9999999:XXXXXXXXXXXXXXXXXXXXXXX'
    api_method: forwardMessage
    api_args:
      chat_id: "000000"
      from_chat_id: 111111
      disable_notification: true
      message_id: '{{ saved_msg_id }}'

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
msg строка	Сообщение, которое вы попытались отправить. Возвращается: при успехе Пример: `"Ansible task finished"`
telegram_error строка	Сообщение об ошибке, полученное от Telegram API. Возвращается: при ошибке Пример: `"Bad Request: message text is empty"`

Авторы

Artem Feofanov (@tyouxa)
Nikolai Lomov (@lomserman)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/telegram_module.html