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

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

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

Для использования в плейбуке укажите: community.general.telegram.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_args словарь добавлен в 2.0.0 community.general		Любые параметры для метода. Для справки по методу по умолчанию, `SendMessage`, см. https://core.telegram.org/bots/api#sendmessage.
api_method строка добавлен в 2.0.0 community.general	По умолчанию: "SendMessage"	Метод API бота. Для справки, см. https://core.telegram.org/bots/api.
chat_id строка		(Устарело) Telegram группа или чат пользователя chat_id.
msg строка		(Устарело) Текст сообщения для отправки.
msg_format строка	Варианты: plain ← markdown MarkdownV2 html	(Устарело) Формат сообщения. Опции форматирования `markdown`, `MarkdownV2`, и `html` описаны в документации Telegram API (https://core.telegram.org/bots/api#formatting-options). Если опция `plain` установлена, сообщение не будет отформатировано.
token строка / обязательно		Токен, идентифицирующий вашего бота Telegram.

Примечания

Примечание

Вам потребуется учетная запись Telegram и созданный бот Telegram, чтобы использовать этот модуль.
Опции msg, msg_format и chat_id устарели и будут удалены в версии community.general 4.0.0. Используйте соответствующие переменные в api_args вместо них. См. примеры, как это работает.

Примеры

- 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 }}'

- name: Send a message to chat in playbook (deprecated old style)
  community.general.telegram:
    token: '9999999:XXXXXXXXXXXXXXXXXXXXXXX'
    chat_id: 000000
    msg: Ansible task finished

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

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

Ключ	Возвращаемое значение	Описание
msg строка	успех	Сообщение, которое вы пытались отправить Пример: Задача Ansible завершена
telegram_error строка	неудача	Сообщение об ошибке, полученное от Telegram API Пример: Ошибка 400: Текст сообщения пуст

Авторы

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

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