2021-11-16 16:03:43 +01:00
Send notifications via Telegram
===============================
2024-03-06 14:30:18 +01:00
[](https://github.com/eworm-de/routeros-scripts/stargazers)
[](https://github.com/eworm-de/routeros-scripts/network)
[](https://github.com/eworm-de/routeros-scripts/watchers)
2024-03-28 22:43:18 +01:00
[](https://mikrotik.com/download/changelogs/)
2024-03-06 14:30:18 +01:00
[](https://t.me/routeros_scripts)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick& hosted_button_id=A4ZXBD6YS2W8J)
2023-01-10 14:45:27 +01:00
[⬅️ Go back to main README ](../../README.md )
2021-11-16 16:03:43 +01:00
> ℹ ️ ️
> installation. See [main README](../../README.md) for details.
Description
-----------
This module adds support for sending notifications via
[Telegram ](https://telegram.org/ ) via bot api. A queue is used to make sure
notifications are not lost on failure but sent later.
Requirements and installation
-----------------------------
Just install the module:
$ScriptInstallUpdate mod/notification-telegram;
Also install Telegram on at least one of your mobile and/or desktop devices
and create an account.
Configuration
-------------
Open Telegram, then start a chat with [BotFather ](https://t.me/BotFather ) and
create your own bot:
Now open a chat with your bot and start it by clicking the `START` button.
Open just another chat with [GetIDs Bot ](https://t.me/getidsbot ), again start
with the `START` button. It will send you some information, including the
`id` , just below `You` .
Finally edit `global-config-overlay` , add `TelegramTokenId` with the token
from *BotFather* and `TelegramChatId` with your id from *GetIDs Bot* . Then
reload the configuration.
2023-06-07 14:16:19 +02:00
> ℹ ️
> [`global-config`](../../global-config.rsc) (the one without `-overlay`) to
> your local `global-config-overlay` and modify it to your specific needs.
2021-11-16 16:03:43 +01:00
### Notifications to a group
Sending notifications to a group is possible as well. Add your bot and the
*GetIDs Bot* to a group, then use the group's id (which starts with a dash)
for `TelegramChatId` . Then remove *GetIDs Bot* from group.
Usage and invocation
--------------------
There's nothing special to do. Every script or function sending a notification
will now send it to your Telegram account.
2023-05-22 09:52:34 +02:00
But of course you can use the function to send notifications directly. Give
it a try:
2022-06-05 22:50:57 +02:00
2023-11-08 17:31:39 +01:00
$SendTelegram "Subject..." "Body...";
2022-06-05 22:50:57 +02:00
Alternatively this sends a notification with all available and configured
methods:
2023-11-08 17:31:39 +01:00
$SendNotification "Subject..." "Body...";
2022-06-05 22:50:57 +02:00
2023-05-22 09:52:34 +02:00
To use the functions in your own scripts you have to declare them first.
Place this before you call them:
:global SendTelegram;
:global SendNotification;
2023-08-06 16:26:22 +02:00
In case there is a situation when the queue needs to be purged there is a
function available:
$PurgeTelegramQueue;
2023-05-25 10:21:24 +02:00
Tips & Tricks
-------------
### Set a profile photo
You can use a profile photo for your bot to make it recognizable. Open the
chat with [BotFather ](https://t.me/BotFather ) and set it there.
Have a look at my
[RouterOS-Scripts Logo Color Changer ](https://git.eworm.de/cgit/routeros-scripts/plain/contrib/logo-color.html )
to create a colored version of this scripts' logo.
2021-11-16 16:03:25 +01:00
See also
--------
2023-01-30 16:08:00 +01:00
* [Chat with your router and send commands via Telegram bot ](../telegram-chat.md )
2022-09-23 15:07:30 +02:00
* [Send notifications via e-mail ](notification-email.md )
2021-11-16 16:03:25 +01:00
* [Send notifications via Matrix ](notification-matrix.md )
2023-10-11 07:40:55 +02:00
* [Send notifications via Ntfy ](notification-ntfy.md )
2021-11-16 16:03:25 +01:00
2021-11-16 16:03:43 +01:00
---
2023-01-10 14:45:27 +01:00
[⬅️ Go back to main README ](../../README.md )
[⬆️ Go back to top ](#top )
