--- title: Telegram bot description: Telegram bot support ha_category: - Hub ha_release: 0.42 ha_iot_class: Cloud Push ha_domain: telegram_bot --- Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant. This integration creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/integrations/telegram_polling) platform or with the [webhooks](/integrations/telegram_webhooks) one, and trigger events when receiving messages. If you don't need to receive messages, you can use the [broadcast](/integrations/telegram_broadcast) platform instead. ## Notification services Available services: `send_message`, `send_photo`, `send_video`, `send_animation`, `send_voice`, `send_sticker`, `send_document`, `send_location`, `edit_message`, `edit_caption`, `edit_replymarkup`, `answer_callback_query`, `delete_message` and `leave_chat`. ### Service `telegram_bot.send_message` Send a notification. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `message` | no | Message body of the notification. | | `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | | `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | | `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | | `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` | ### Service `telegram_bot.send_photo` Send a photo. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `url` | no | Remote path to an image. | | `file` | no | Local path to an image. | | `caption` | yes | The title of the image. | | `username` | yes | Username for a URL which requires HTTP basic authentication. | | `password` | yes | Password for a URL which requires HTTP basic authentication. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | | `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | | `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | | `timeout` | yes | Timeout for sending photo in seconds. Will help with timeout errors (poor internet connection, etc) | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | | `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` | ### Service `telegram_bot.send_video` Send a video. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `url` | no | Remote path to a video. | | `file` | no | Local path to a video. | | `caption` | yes | The title of the video. | | `username` | yes | Username for a URL which requires HTTP basic authentication. | | `password` | yes | Password for a URL which requires HTTP basic authentication. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | | `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | | `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | | `timeout` | yes | Timeout for sending video in seconds. Will help with timeout errors (poor internet connection, etc) | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | ### Service `telegram_bot.send_animation` Send an animation. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `url` | no | Remote path to a GIF or H.264/MPEG-4 AVC video without sound. | | `file` | no | Local path to a GIF or H.264/MPEG-4 AVC video without sound. | | `caption` | yes | The title of the animation. | | `username` | yes | Username for a URL which requires HTTP basic authentication. | | `password` | yes | Password for a URL which requires HTTP basic authentication. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | | `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | | `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | | `timeout` | yes | Timeout for sending video in seconds. Will help with timeout errors (poor internet connection, etc) | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | | `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` | ### Service `telegram_bot.send_voice` Send a voice message. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `url` | no | Remote path to a voice message. | | `file` | no | Local path to a voice message. | | `caption` | yes | The title of the voice message. | | `username` | yes | Username for a URL which requires HTTP basic authentication. | | `password` | yes | Password for a URL which requires HTTP basic authentication. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | | `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | | `timeout` | yes | Timeout for sending voice in seconds. Will help with timeout errors (poor internet connection, etc) | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | | `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` | ### Service `telegram_bot.send_sticker` Send a sticker. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `url` | no | Remote path to a static .webp or animated .tgs sticker. | | `file` | no | Local path to a static .webp or animated .tgs sticker. | | `username` | yes | Username for a URL which requires HTTP basic authentication. | | `password` | yes | Password for a URL which requires HTTP basic authentication. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | | `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | | `timeout` | yes | Timeout for sending photo in seconds. Will help with timeout errors (poor internet connection, etc) | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | | `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` | ### Service `telegram_bot.send_document` Send a document. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `url` | no | Remote path to a document. | | `file` | no | Local path to a document. | | `caption` | yes | The title of the document. | | `username` | yes | Username for a URL which requires HTTP basic authentication. | | `password` | yes | Password for a URL which requires HTTP basic authentication. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | | `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | | `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | | `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | | `timeout` | yes | Timeout for sending document in seconds. Will help with timeout errors (poor internet connection, etc) | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | | `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` | ### Service `telegram_bot.send_location` Send a location. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `latitude` | no | The latitude to send. | | `longitude` | no | The longitude to send. | | `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed `chat_id`. | | `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | | `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | | `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` | ### Service `telegram_bot.edit_message` Edit a previously sent message in a conversation. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | | `chat_id` | no | The chat_id where to edit the message. | | `message` | no | Message body of the notification. | | `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. | | `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | | `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | ### Service `telegram_bot.edit_caption` Edit the caption of a previously sent message. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | | `chat_id` | no | The chat_id where to edit the caption. | | `caption` | no | Message body of the notification. | | `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | ### Service `telegram_bot.edit_replymarkup` Edit the inline keyboard of a previously sent message. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | | `chat_id` | no | The chat_id where to edit the reply_markup. | | `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | ### Service `telegram_bot.answer_callback_query` Respond to a callback query originated by clicking on an online keyboard button. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `message` | no | Unformatted text message body of the notification. | | `callback_query_id` | no | Unique id of the callback response. In the `telegram_callback` event data: {% raw %}`{{ trigger.event.data.id }}`{% endraw %} | | `show_alert` | yes | True/false for show a permanent notification. Defaults to False. | ### Service `telegram_bot.delete_message` Delete a previously sent message in a conversation. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `message_id` | no | Id of the message to delete. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | | `chat_id` | no | The chat_id where to delete the message. | ### Service `telegram_bot.leave_chat` Remove the bot from the chat group where it was added. | Service data attribute | Optional | Description | |---------------------------|----------|--------------------------------------------------| | `chat_id` | no | The chat_id from where to remove the bot. | ## Telegram notification platform The [`telegram` notification platform](/integrations/telegram) requires the `telegram_bot` integration to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The required YAML configuration now reduces to: ```yaml notify: - platform: telegram name: NOTIFIER_NAME chat_id: USER_CHAT_ID ``` ## Event triggering A command looks like `/thecommand` or `/othercommand with some args`. When received by Home Assistant it will fire a `telegram_command` event on the event bus with the following `event_data`: ```yaml command: "/thecommand" args: "" from_first: "" from_last: "" user_id: "" chat_id: "" chat: "" ``` Any other message not starting with `/` will be processed as simple text, firing a `telegram_text` event on the event bus with the following `event_data`: ```yaml text: "some text received" from_first: "" from_last: "" user_id: "" chat_id: "" chat: "" ``` If the message is sent from a [press from an inline button](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), for example, a callback query is received, and Home Assistant will fire a `telegram_callback` event with: ```yaml data: "" message: from_first: "" from_last: "" user_id: "" id: "" chat_instance: "" chat_id: "" ``` ### Configuration samples Simple ping pong example. ```yaml alias: 'Telegram bot that reply pong to ping' trigger: platform: event event_type: telegram_command event_data: command: "/ping" action: - service: notify.notify data: message: "pong" ``` An example that shows keyboard interaction with `notify.telegram` ```yaml trigger: platform: event event_type: telegram_command event_data: command: "/start" action: - service: notify.telegram data: message: "commands" data: keyboard: - '/ping, /alarm' - '/siren' ``` and an automation to trigger a related command "/siren". ```yaml trigger: platform: event event_type: telegram_command event_data: command: "/siren" action: - service: homeassistant.turn_on target: entity_id: switch.vision_zm1601eu5_battery_operated_siren_switch_9_0 - delay: seconds: 10 - service: homeassistant.turn_off target: entity_id: switch.vision_zm1601eu5_battery_operated_siren_switch_9_0 ``` An example to show the use of event_data in action: {% raw %} ```yaml - alias: 'Kitchen Telegram Speak' trigger: platform: event event_type: telegram_command event_data: command: "/speak" action: - service: notify.kitchen_echo data: message: > Message from {{ trigger.event.data["from_first"] }}. {% for state in trigger.event.data["args"] %} {{ state }} {% endfor %} ``` {% endraw %} ### Sample automations with callback queries and inline keyboards A quick example to show some of the callback capabilities of inline keyboards with a dumb automation consisting in a simple repeater of normal text that presents an inline keyboard with 3 buttons: 'EDIT', 'NO' and 'REMOVE BUTTON': - Pressing 'EDIT' changes the sent message. - Pressing 'NO' only shows a brief notification (answering the callback query). - Pressing 'REMOVE BUTTON' changes the inline keyboard removing that button. Text repeater: {% raw %} ```yaml - alias: 'Telegram bot that repeats text' trigger: platform: event event_type: telegram_text action: - service: telegram_bot.send_message data: title: "*Dumb automation*" target: "{{ trigger.event.data.user_id }}" message: "You said: {{ trigger.event.data.text }}" disable_notification: true inline_keyboard: - "Edit message:/edit_msg, Don't:/do_nothing" - "Remove this button:/remove_button" ``` {% endraw %} Message editor: {% raw %} ```yaml - alias: 'Telegram bot that edits the last sent message' trigger: platform: event event_type: telegram_callback event_data: command: "/edit_msg" action: - service: telegram_bot.answer_callback_query data: callback_query_id: "{{ trigger.event.data.id }}" message: "Editing the message!" show_alert: true - service: telegram_bot.edit_message data: message_id: "{{ trigger.event.data.message.message_id }}" chat_id: "{{ trigger.event.data.chat_id }}" title: "*Message edit*" inline_keyboard: - "Edit message:/edit_msg, Don't:/do_nothing" - "Remove this button:/remove_button" message: > Callback received from {{ trigger.event.data.from_first }}. Message id: {{ trigger.event.data.message.message_id }}. Data: {{ trigger.event.data.data|replace("_", "\_") }} ``` {% endraw %} Keyboard editor: {% raw %} ```yaml - alias: 'Telegram bot that edits the keyboard' trigger: platform: event event_type: telegram_callback event_data: command: "/remove_button" action: - service: telegram_bot.answer_callback_query data: callback_query_id: "{{ trigger.event.data.id }}" message: "Callback received for editing the inline keyboard!" - service: telegram_bot.edit_replymarkup data: message_id: "last" chat_id: "{{ trigger.event.data.chat_id }}" inline_keyboard: - "Edit message:/edit_msg, Don't:/do_nothing" ``` {% endraw %} Only acknowledges the 'NO' answer: {% raw %} ```yaml - alias: 'Telegram bot that simply acknowledges' trigger: platform: event event_type: telegram_callback event_data: command: "/do_nothing" action: - service: telegram_bot.answer_callback_query data: callback_query_id: "{{ trigger.event.data.id }}" message: "OK, you said no!" ``` {% endraw %} Telegram callbacks also support arguments and commands the same way as normal messages. {% raw %} ```yaml - alias: 'Telegram bot repeats arguments on callback query' trigger: platform: event event_type: telegram_callback event_data: command: "/repeat" action: - service: telegram_bot.answer_callback_query data: show_alert: true callback_query_id: "{{ trigger.event.data.id }}" message: "I repeat: {{trigger.event.data['args']}}" ``` {% endraw %} In this case, having a callback with `/repeat 1 2 3` will pop a notification saying `I repeat: [1, 2, 3]` Receiving `chat_id` and `message_id` identifiers of sent messages by the `telegram_bot`. {% raw %} ```yaml - alias: 'Notifications about messages sent by Telegram bot' trigger: platform: event event_type: telegram_sent event_data: message_tag: "msg_start" action: - service: input_number.set_value data_template: entity_id: input_number.chat_id value: "{{ trigger.event.data.chat_id }}" - service: input_number.set_value data_template: entity_id: input_number.message_id value: "{{ trigger.event.data.message_id }}" ``` {% endraw %}