home-assistant.io/source/_components/telegram_bot.broadcast.markdown
Klaas Schoute 69401057e6 Updated all Telegram component files configuration variable (#6503)
* 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
2018-10-04 15:31:44 +02:00

55 lines
1.5 KiB
Markdown

---
layout: page
title: "Telegram broadcast"
description: "Telegram support to send messages only"
date: 2017-06-24 11:20
sidebar: true
comments: false
sharing: true
footer: true
logo: telegram.png
ha_category: Notifications
ha_release: 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:
```yaml
# Example configuration.yaml entry
telegram_bot:
- platform: broadcast
api_key: <telegram api key>
allowed_chat_ids:
- 12345
- 67890
```
{% configuration %}
allowed_chat_ids:
description: A list of user in the `user_id` Telegram format enabled to interact to webhook
required: true
type: list
api_key:
description: The API token of your bot.
required: true
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
{% endconfiguration %}
To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram/).