2.2 KiB
2.2 KiB
layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category |
---|---|---|---|---|---|---|---|---|---|
component | Telegram | Instructions how to add Telegram notifications to Home Assistant. | 2015-10-09 18:00 | true | false | true | true | telegram.png | Notifications |
The telegram platform uses Telegram to delivery notifications from Home Assistant to your Android device, your Windows phone, or your iOS device.
The requirement are:
- You need a Telegram bot. Please follow those instructions 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.
- The
chat_id
of an user.
An easy way to get your chat ID is described below:
import telegram
bot = telegram.Bot(token='YOUR_API_TOKEN')
chat_id = bot.getUpdates()[-1].message.chat_id
print(chat_id)
Another way to retrieve your chat_id
is visiting https://api.telegram.org/botYOUR_API_TOKEN/getUpdates.
The result set will include your chat ID as id
in the from
section:
{
"ok":true,
"result":[
{
"update_id":254199982,
"message":{
"message_id":201,
"from":{
"id":123456789,
"first_name":"Your first name",
...
To enable Telegram notifications in your installation, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: telegram
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
chat_id: YOUR_CHAT_ID
Configuration variables:
- name (Optional): Setting the optional parameter
name
allows multiple notifiers to be created. The default value isnotify
. The notifier will bind to the servicenotify.NOTIFIER_NAME
. - api_key (Required): The API token of your bot.
- chat_id (Required: The chat ID of your user.
To use notifications, please see the getting started with automation page.