2024.12.5
Home ▸ Integrations ▸

Telegram broadcast

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 or commands sent to the bot.

Information on how to send a message via the telegram_bot.send_message action can be found here.

Configuration

To integrate this into Home Assistant, add the following section to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:

# Example configuration.yaml entry
telegram_bot:
  - platform: broadcast
    api_key: YOUR_API_KEY
    allowed_chat_ids:
      - 123456789 # example id of a user
      - -987654321  # example id of a group, starts with a -

Configuration Variables

Looking for your configuration file?
allowed_chat_ids list Required

A list of ids representing the users and group chats to which messages can be send. Default the message will be send to the first alllowed chat_id. By using the target action data attribute the message can be send to other chat_ids from the list.

api_key string Required

The API token of your bot.

parse_mode string (Optional, default: markdown)

Default parser for messages if not explicit in message data, either html or markdown.

proxy_url string (Optional)

Proxy URL if working behind one, optionally including username and password. (socks5://username:password@proxy_ip:proxy_port).

To get your chat_id and api_key follow the instructions here.