home-assistant.io/telegram_bot.webhooks.markdown at 4cde3536d2d4d6a6f40160d904cd25b51a0452a2

mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-07 03:28:58 +00:00

Eugenio Panadero 68a6187242 Telegram Bot doc changes for pull request #7294 : Telegram Bot enhancements with callback queries and more notification options (#2508 )

Telegram Bot doc changes for pull request #7294: some required fixes and an example of an AppDaemon app.

Telegram Bot doc changes for pull request #7294: fix

Telegram Bot doc changes for pull request #7294: minimal clarification about disabling notifications for Telegram web users

Telegram Bot doc changes for pull request #7294: added new notification services (like in the `mediaplayer` component doc); added a description to how operates now the `notify.telegram` platform; changed service calls from `notify/telegram_bot` to `telegram_bot/EXPLICIT_NEW_SERVICE` in some of the yaml examples and in the appdaemon example.

Telegram Bot doc changes for pull request #7294: added `parse_mode` global config variable in webhooks and polling platforms; fixed links to /components/notify.telegram

Telegram Bot doc changes for pull request #7294: removed complex usage of telegram_bot services (moved to the telegram_bot doc); removed api_key from required params; removed multiple target feature (it can be done with the telegram_bot services or simply defining more than one notifier); added keyboard and inline_keyboard config vars to every type of notification.

Telegram Bot doc changes for pull request #7294: change 'hass' to 'Home Assistant'

2017-05-09 22:42:00 -07:00

1.8 KiB

Raw Blame History

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

1.8 KiB Raw Blame History

1.8 KiB

Raw Blame History