mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-06 11:08:59 +00:00
69401057e6
* Updated all Telegram component files configuration variable Updated style of all Telegram documentation to follow new configuration variables description. Related to #6385. * Update telegram_bot.broadcast.markdown Add "" on a string * Update telegram_bot.polling.markdown Add "" on a string * Update telegram_bot.webhooks.markdown Add "" on a string
93 lines
3.0 KiB
Markdown
93 lines
3.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Telegram webhooks"
|
|
description: "Telegram webhooks support"
|
|
date: 2017-04-05 18:50
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: telegram.png
|
|
ha_category: Notifications
|
|
ha_release: 0.42
|
|
---
|
|
|
|
Telegram chatbot webhooks implementation as described in the Telegram [documentation](https://core.telegram.org/bots/webhooks).
|
|
|
|
Using Telegrams `setWebhook` method your bot's webhook URL should be set to `https://<public_url>:<port>/api/telegram_webhooks`.
|
|
|
|
This is one of two bot implementations supported by Telegram. Described by Telegram as the preferred implementation but requires your Home Assistant instance to be exposed to the internet.
|
|
|
|
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
http:
|
|
base_url: <public_url> # the Home Assistant https url which is exposed to the internet.
|
|
|
|
telegram_bot:
|
|
- platform: webhooks
|
|
api_key: telegram api key
|
|
parse_mode: html
|
|
allowed_chat_ids:
|
|
- 12345
|
|
- 67890
|
|
```
|
|
|
|
{% configuration %}
|
|
allowed_chat_ids:
|
|
description: A list of ids representing the users and group chats that are authorized to interact with the webhook.
|
|
required: true
|
|
type: list
|
|
api_key:
|
|
description: The API token of your bot.
|
|
required: true
|
|
type: string
|
|
trusted_networks:
|
|
description: Telegram server access ACL as list.
|
|
required: false
|
|
default: 149.154.167.197-233
|
|
type: string
|
|
parse_mode:
|
|
description: "Default parser for messages if not explicit in message data: 'html' or 'markdown'."
|
|
required: false
|
|
default: markdown
|
|
type: string
|
|
proxy_url:
|
|
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`)
|
|
required: false
|
|
type: string
|
|
proxy_params:
|
|
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.)
|
|
required: false
|
|
type: string
|
|
url:
|
|
description: Allow to overwrite the `base_url` from the [`http`](/components/http/) component for different configurations (`https://<public_url>:<port>`).
|
|
required: false
|
|
type: string
|
|
{% endconfiguration %}
|
|
|
|
To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram). As well as authorizing the chat, if you have added your bot to a group you will also need to authorize any user that will be interacting with the webhook. When an unauthorized user tries to interact with the webhook Home Assistant will raise an error ("Incoming message is not allowed"), you can easily obtain the users id by looking in the "from" section of this error message.
|
|
|
|
Full configuration sample:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
http:
|
|
base_url: <public_url>
|
|
|
|
telegram_bot:
|
|
- platform: webhooks
|
|
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
|
trusted_networks:
|
|
- 149.154.167.197/32
|
|
- 149.154.167.198/31
|
|
- 149.154.167.200/29
|
|
- 149.154.167.208/28
|
|
- 149.154.167.224/29
|
|
- 149.154.167.232/31
|
|
allowed_chat_ids:
|
|
- 12345
|
|
- 67890
|
|
```
|