ansible.builtin.telegram (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Send notifications via telegram bot, to a verified group or user

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: send a message to chat in playbook
  telegram:
    token: '9999999:XXXXXXXXXXXXXXXXXXXXXXX'
    chat_id: 000000
    msg: Ansible task finished

Inputs

    
msg:
    description:
    - What message you wish to send.
    required: true

token:
    description:
    - Token identifying your telegram bot.
    required: true

chat_id:
    description:
    - Telegram group or user chat_id
    required: true

msg_format:
    choices:
    - plain
    - markdown
    - html
    default: plain
    description:
    - Message format. Formatting options `markdown` and `html` described in Telegram API
      docs (https://core.telegram.org/bots/api#formatting-options). If option `plain`
      set, message will not be formatted.
    version_added: '2.4'
    version_added_collection: ansible.builtin

Outputs

msg:
  description: The message you attempted to send
  returned: success
  sample: Ansible task finished
  type: str
telegram_error:
  description: Error message gotten from Telegram API
  returned: failure
  sample: 'Bad Request: message text is empty'
  type: str