Update Telegram notication docs (#15124)

Update Telegram notication doc
This commit is contained in:
Gerard 2020-10-09 14:56:08 +02:00 committed by GitHub
parent 290ffe7cc4
commit 55bcbc4a19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -8,7 +8,7 @@ ha_iot_class: Cloud Polling
ha_domain: telegram
---
The `telegram` platform uses [Telegram](https://web.telegram.org) to deliver notifications from Home Assistant to your Android device, your Windows phone, or your iOS device.
The `telegram` platform uses [Telegram](https://www.telegram.org) to deliver notifications from Home Assistant to your Telegram application(s).
## Setup
@ -16,7 +16,7 @@ The requirements are:
- You need a [Telegram bot](https://core.telegram.org/bots). Please follow those [instructions](https://core.telegram.org/bots#6-botfather) to create one and get the token for your bot. Keep in mind that bots are not allowed to contact users. You need to make the first contact with your user. Meaning that you need to send a message to the bot from your user.
- You need to configure a [Telegram bot in Home Assistant](/integrations/telegram_bot) and define there your API key and the allowed chat ids to interact with.
- The `chat_id` of an allowed user.
- The `chat_id` of an allowed user or group to which the bot is added.
**Method 1:** You can get your `chat_id` by sending any message to the [GetIDs bot](https://t.me/getidsbot).
@ -76,14 +76,20 @@ telegram_bot:
- platform: polling
api_key: YOUR_API_KEY
allowed_chat_ids:
- CHAT_ID_1
- CHAT_ID_2
- CHAT_ID_1 # example: 123456789 for the chat_id of a user
- CHAT_ID_2 # example: -987654321 for the chat_id of a group
- CHAT_ID_3
# Example configuration.yaml entry for the notifier
notify:
- name: NOTIFIER_NAME
platform: telegram
- platform: telegram
name: NOTIFIER_NAME
chat_id: CHAT_ID_1
# It is possible to add multiple notifiers by using another chat_id
# the example belows shows an additional notifier which sends messages to the bot which is added to a group
- platform: telegram
name: NOTIFIER_NAME_OF_GROUP
chat_id: CHAT_ID_2
```
@ -98,7 +104,7 @@ name:
default: notify
type: string
chat_id:
description: The chat ID of your user.
description: The chat ID of the users or group
required: true
type: integer
{% endconfiguration %}
@ -152,7 +158,7 @@ action:
photo:
- url: http://192.168.1.28/camera.jpg
username: admin
password: secrete
password: secret
- file: /tmp/picture.jpg
caption: Picture Title xy
- url: http://somebla.ie/video.png
@ -228,7 +234,7 @@ action:
video:
- url: http://192.168.1.28/camera.mp4
username: admin
password: secrete
password: secret
- file: /tmp/video.mp4
caption: Video Title xy
- url: http://somebla.ie/video.mp4