home-assistant.io/source/_components/telegram_bot.broadcast.markdown
2017-12-16 00:18:52 -08:00

1.3 KiB

layout title description date sidebar comments sharing footer logo ha_category ha_release
page Telegram broadcast Telegram support to send messages only 2017-06-24 11:20 true false true true telegram.png Notifications 0.48

Telegram implementation to support sending messages only. Your Home Assistant instance does not have to be exposed to the Internet and there is no polling to receive messages sent to the bot.

To integrate this into Home Assistant, add the following section to your configuration.yaml file:

# Example configuration.yaml entry

telegram_bot:
  - platform: broadcast
    api_key: <telegram api key>
    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.
  • parse_mode (Optional): Default parser for messages if not explicit in message data: 'html' or 'markdown'. Default is 'markdown'.
  • proxy_url (Optional): Proxy url if working behind one (socks5://proxy_ip:proxy_port)
  • proxy_params (Optional): Proxy configuration parameters, as dict, if working behind a proxy (username, password, etc.)

To get your chat_id and api_key follow the instructions here.