community.general.telegram – module for sending notifications via telegram¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.telegram
.
Synopsis¶
Send notifications via telegram bot, to a verified group or user.
Also, the user may try to use any other telegram bot API method, if you specify api_method argument.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_args
dictionary
added in 2.0.0 of community.general
|
Any parameters for the method.
For reference to default method,
SendMessage , see https://core.telegram.org/bots/api#sendmessage. |
|
api_method
string
added in 2.0.0 of community.general
|
Default: "SendMessage"
|
Bot API method.
For reference, see https://core.telegram.org/bots/api.
|
chat_id
string
|
(Deprecated) Telegram group or user chat_id.
|
|
msg
string
|
(Deprecated) What message you wish to send.
|
|
msg_format
string
|
|
(Deprecated) Message format. Formatting options
markdown , MarkdownV2 , and html described in Telegram API docs (https://core.telegram.org/bots/api#formatting-options). If option plain set, message will not be formatted. |
token
string
/ required
|
Token identifying your telegram bot.
|
Notes¶
Note
You will require a telegram account and create telegram bot to use this module.
The options msg, msg_format and chat_id have been deprecated and will be removed in community.general 4.0.0. Use the corresponding variables in api_args instead. See the examples for how that works.
Examples¶
- 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Artem Feofanov (@tyouxa)
Nikolai Lomov (@lomserman)