home-assistant.io/source/_components/telegram_bot.webhooks.markdown
Gergely Peidl 7d9e13dc10 Fixing Telegram docs (#2637)
* Missing yaml formatter added for Telegram.

* Fixing the url of notify.telegram
2017-05-16 08:14:31 +02:00

1.8 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_release
page Telegram webhooks Telegram webhooks support 2017-04-05 18:50 true false true true telegram.png Telegram chatbot 0.42

Telegram chatbot webhooks implementation as described in the Telegram documentation.

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:

# 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 variables:

  • allowed_chat_ids (Required): A list of user in the user_id Telegram format enabled to interact to webhook
  • api_key (Required): The API token of your bot.
  • trusted_networks (Optional): Telegram server access ACL as list. Defaults to 149.154.167.197-233.
  • parse_mode (Optional): Default parser for messages if not explicit in message data: 'html' or 'markdown'. Default is 'markdown'.

To get your chat_id and api_key follow the instructions here .

Full configuration sample:

# 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