jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-27 19:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for message_thread_id data attribute for telegram notify integration (#37381)

Browse Source 
* Add documentation and examples for message_thread_id data attribute

* Remove trailing colon in headers

* tiny tweak

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Caleb Mah 2025-02-10 14:52:38 +08:00 committed by GitHub
parent 542db64245
commit 2f9c079f41
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_integrations/telegram.markdown
View File

@ -454,6 +454,7 @@ actions:
message_tag: "example_tag"
disable_notification: True
disable_web_page_preview: True
message_thread_id: 123
```
{% configuration %}
@ -468,10 +469,15 @@ disable_notification:
type: boolean
disable_web_page_preview:
description: True/false to display a webpage preview.
required: false
default: false
type: boolean
message_tag:
description: Tag for sent message.
required: false
type: string
message_thread_id:
description: Send the message to a specific topic or thread.
required: false
type: integer
{% endconfiguration %}

15
source/_integrations/telegram_bot.markdown
View File

@ -290,7 +290,7 @@ Remove the bot from the chat group where it was added.
## 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 data attributes `parse_mode`, `disable_notification`, `message_tag` and `disable_web_page_preview` are also supported.
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 data attributes `parse_mode`, `disable_notification`, `message_tag`, `disable_web_page_preview`, and `message_thread_id` are also supported.
The required YAML configuration now reduces to:
@ -598,7 +598,7 @@ actions:
message_tag: "example_tag"
```
## Example: send_message with disabled webpage preview:
## Example: send_message with disabled webpage preview
```yaml
actions:
@ -611,6 +611,17 @@ actions:
disable_web_page_preview: true
```
## Example: send_message to a topic within a group
```yaml
actions:
- action: notify.telegram
data:
message: "Message to a topic"
data:
message_thread_id: 123
```
## Example: automation to send a message and delete after a delay
{% raw %}