Модуль community.general.telegram – Отправка уведомлений через Telegram

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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	Метод API бота. Для справки см. https://core.telegram.org/bots/api. По умолчанию: `"SendMessage"`
token строка / обязательно	Токен, идентифицирующий вашего бота Telegram.

Атрибуты

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

Примечания

Примечание

Для использования этого модуля вам потребуется учетная запись 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 строка	Сообщение, которое вы пытались отправить Возвращено: success Пример: `"Ansible task finished"`
telegram_error строка	Сообщение об ошибке от API Telegram Возвращено: failure Пример: `"Bad Request: message text is empty"`

Авторы

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

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

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