community.general.telegram 模块 – 通过 Telegram 发送通知

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 软件包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。

要在剧本中使用它，请指定： community.general.telegram。

概要 

通过 Telegram 机器人向已验证的群组或用户发送通知。
此外，如果您指定 api_method 参数，用户可以尝试使用任何其他 Telegram 机器人 API 方法。

参数 

参数	注释
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` 中更改的内容）的详细信息。

备注 

注意

您需要一个 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)