From f10bdd004912a78e1361e5eca07552a3071e92d6 Mon Sep 17 00:00:00 2001 From: lead2gold Date: Sun, 4 Mar 2018 11:49:41 -0500 Subject: [PATCH] Updated Notify_telegram (markdown) --- Notify_telegram.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/Notify_telegram.md b/Notify_telegram.md index feca56b..efb20c4 100644 --- a/Notify_telegram.md +++ b/Notify_telegram.md @@ -1,6 +1,6 @@ ## Telegram Notifications * **Source**: https://telegram.org/ -* **Icon Support**: No +* **Icon Support**: Yes * **Message Format**: Text * **Message Limit**: 4096 Characters per message @@ -21,11 +21,23 @@ Valid are as follows: This can also be written like so: * **tgram**://**{chat_id}**@**{bot_token}**/ +If you don't know the chat_id, this script will attempt to detect the one belonging to the bot owner (which is usually you). So this is a valid URL as well: +* **tgram**://**{bot_token}**/ + +**Note:** Please note that there is no guarantee that this script will always be able to determine who the bot owner is (in most cases it will though). When the bot owner is detected, it's **{chat_id}** is presented in the logs. Ideally you should ideally take this and update your URL to explicitly reference this in the future. + + +If you want to see the icon/image associated with the notification, you can have it come through by adding a **?image=yes** to your URL string like so: +* **tgram**://**{bot_token}**/**?image=Yes** +* **tgram**://**{bot_token}**/**{chat_id}**/**?image=Yes** +* **tgram**://**{bot_token}**/**{chat_id1}**/**{chat_id2}**/**{chat_id3}**/**?image=Yes** + ### 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*. If you do not specify a chat_id, the notification script will attempt to detect the bot owner's (you) chat_id and use that. +| chat_id | Yes | Identify the users you want your bot to deliver your notifications to. You must specify at least 1 *chat_id*. If you do not specify a chat_id, the notification script will attempt to detect the bot owner's (you) chat_id and use that. +| image | No | You can optionally append the argument of **?image=Yes** to the end of your URL to have a Telegram message generated before the actual notice which uploads the image associated with it. Due to the services limitations, Telegram doesn't allow you to post an image inline with a text message. But you can send a message that just contains an image. If this flag is set to true, *apprise* will send an image notification followed by the notice itself. Since receiving 2 messages for every 1 notice could be annoying to some, this has been made an option that defaults to being disabled. #### Example Send a telegram notification to lead2gold: