From 91fe74077fa41e9c6ff76bc93f9d3a6eb95b11d9 Mon Sep 17 00:00:00 2001 From: lead2gold Date: Wed, 29 Nov 2017 20:30:16 -0500 Subject: [PATCH] Created Notify_telegram (markdown) --- Notify_telegram.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 Notify_telegram.md diff --git a/Notify_telegram.md b/Notify_telegram.md new file mode 100644 index 0000000..52ef952 --- /dev/null +++ b/Notify_telegram.md @@ -0,0 +1,33 @@ +## Telegram Notifications +* **Source**: https://telegram.org/ +* **Icon Support**: No +* **Message Format**: Text +* **Message Limit**: 4096 Characters per message + +### Account Setup +Telegram is slightly more complicated then some of the other notification services, so here is quick breakdown of what you need to know and do in order to send Notifications through it using this tool: + +First off, Telegram notifications require you need to first access https://api.telegram.org and create a bot. After creating te bot, you will need to acquire it's Token Identifier (*bot_token*). + +To do this you will be required in a chat with the **[BotFather](https://botsfortelegram.com/project/the-bot-father/)** to type: ```/newbot```. Answer the questions it asks after doing this (which get the name of it, etc). When you've completed this step, you will be provided an *bot_token* that looks something like this: ```123456789:alphanumeric_characters```. + +### Syntax +Valid are as follows: +* **tgram**:://**{bot_token}**/**{chat_id}**/ +* **tgram**:://**{bot_token}**/**{chat_id1}**/**{chat_id2}**/**{chat_id3}**/ + +This can also be written like so: +* **tgram**:://**{chat_id}**@**{bot_token}**/ + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| bot_token | Yes | The token that identifies the bot you created through the *[BotFather](https://botsfortelegram.com/project/the-bot-father/)* +| chat_id | Yes | Identify the users you want your bot to deliver your notifications to. You must specify at least 1 *chat_id*. + +#### Example +Send a telegram notification to lead2gold: +```bash +# Assuming our {bot_token} is 123456789:abcdefg_hijklmnop +notify tgram:///123456789:abcdefg_hijklmnop/lead2gold/ +``` \ No newline at end of file