mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 14:56:53 +00:00
Update Notify Telegram configuration variable (#6497)
* Update Notify Telegram configuration variable Update style of notify telegram documentation to follow new configuration variables description. Related to #6385. * Update notify.telegram.markdown ✏️ Tweak soms types and add defaults * Update notify.telegram.markdown Added extra default * Update notify.telegram.markdown - Using `float` for latitude and longitude. - URL or File? I have make it URL. * Update notify.telegram.markdown Added some changes abount using URL or FILE path * ✏️ Added suggestion
This commit is contained in:
parent
e45cc36589
commit
55f745069f
@ -84,10 +84,17 @@ notify:
|
|||||||
chat_id: CHAT_ID_2
|
chat_id: CHAT_ID_2
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
name:
|
||||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||||
- **chat_id** (*Required*): The chat ID of your user.
|
required: false
|
||||||
|
default: notify
|
||||||
|
type: string
|
||||||
|
chat_id:
|
||||||
|
description: The chat ID of your user.
|
||||||
|
required: true
|
||||||
|
type: integer
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||||
|
|
||||||
@ -106,12 +113,24 @@ action:
|
|||||||
- 'Task 3:/command3, Task 4:/command4'
|
- 'Task 3:/command3, Task 4:/command4'
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
title:
|
||||||
- **message** (*Required*): Message text.
|
description: Will be composed as '%title\n%message'.
|
||||||
- **title** (*Optional*): Will be composed as '%title\n%message'.
|
required: false
|
||||||
- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard.
|
type: string
|
||||||
- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
message:
|
||||||
|
description: Message text.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom keyboard.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
inline_keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
### {% linkable_title Photo support %}
|
### {% linkable_title Photo support %}
|
||||||
|
|
||||||
@ -133,15 +152,41 @@ action:
|
|||||||
caption: I.e. for a Title
|
caption: I.e. for a Title
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
url:
|
||||||
- **url** or **file** (*Required*): For local or remote path to an image.
|
description: A remote path to an image. Either this or the `file` configuration option is required.
|
||||||
- **caption** (*Optional*): The title of the image.
|
required: true
|
||||||
- **username** (*Optional*): Username for a URL which require HTTP authentication.
|
type: string
|
||||||
- **password** (*Optional*): Username for a URL which require HTTP authentication.
|
file:
|
||||||
- **authentication** (*Optional*): Set to 'digest' to use HTTP digest authentication, defaults to 'basic'.
|
description: A local path to an image. Either this or the `url` configuration option is required.
|
||||||
- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard.
|
required: true
|
||||||
- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
type: string
|
||||||
|
caption:
|
||||||
|
description: The title of the image.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
username:
|
||||||
|
description: Username for a URL which require HTTP authentication.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
password:
|
||||||
|
description: Password for a URL which require HTTP authentication.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
authentication:
|
||||||
|
description: Set to 'digest' to use HTTP digest authentication.
|
||||||
|
required: false
|
||||||
|
default: basic
|
||||||
|
type: string
|
||||||
|
keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom keyboard.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
inline_keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
<p class='note'>
|
<p class='note'>
|
||||||
Since Home Assistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification.
|
Since Home Assistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification.
|
||||||
@ -176,15 +221,41 @@ action:
|
|||||||
caption: I.e. for a Title
|
caption: I.e. for a Title
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
url:
|
||||||
- **url** or **file** (*Required*): For local or remote path to a video.
|
description: A remote path to an video. Either this or the `file` configuration option is required.
|
||||||
- **caption** (*Optional*): The title of the video.
|
required: true
|
||||||
- **username** (*Optional*): Username for a URL which require HTTP authentication.
|
type: string
|
||||||
- **password** (*Optional*): Username for a URL which require HTTP authentication.
|
file:
|
||||||
- **authentication** (*Optional*): Set to 'digest' to use HTTP digest authentication, defaults to 'basic'.
|
description: A local path to an video. Either this or the `url` configuration option is required.
|
||||||
- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard.
|
required: true
|
||||||
- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
type: string
|
||||||
|
caption:
|
||||||
|
description: The title of the video.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
username:
|
||||||
|
description: Username for a URL which require HTTP authentication.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
password:
|
||||||
|
description: Password for a URL which require HTTP authentication.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
authentication:
|
||||||
|
description: Set to 'digest' to use HTTP digest authentication.
|
||||||
|
required: false
|
||||||
|
default: basic
|
||||||
|
type: string
|
||||||
|
keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom keyboard.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
inline_keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
### {% linkable_title Document support %}
|
### {% linkable_title Document support %}
|
||||||
|
|
||||||
@ -204,15 +275,41 @@ action:
|
|||||||
- '/command3, /command4'
|
- '/command3, /command4'
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
url:
|
||||||
- **url** or **file** (*Required*): For local or remote path to a document.
|
description: A remote path to an document. Either this or the `file` configuration option is required.
|
||||||
- **caption** (*Optional*): The title of the document.
|
required: true
|
||||||
- **username** (*Optional*): Username for a URL which require HTTP authentication.
|
type: string
|
||||||
- **password** (*Optional*): Username for a URL which require HTTP authentication.
|
file:
|
||||||
- **authentication** (*Optional*): Set to 'digest' to use HTTP digest authentication, defaults to 'basic'.
|
description: A local path to an document. Either this or the `url` configuration option is required.
|
||||||
- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard.
|
required: true
|
||||||
- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
type: string
|
||||||
|
caption:
|
||||||
|
description: The title of the document.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
username:
|
||||||
|
description: Username for a URL which require HTTP authentication.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
password:
|
||||||
|
description: Password for a URL which require HTTP authentication.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
authentication:
|
||||||
|
description: Set to 'digest' to use HTTP digest authentication.
|
||||||
|
required: false
|
||||||
|
default: basic
|
||||||
|
type: string
|
||||||
|
keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom keyboard.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
inline_keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
### {% linkable_title Location support %}
|
### {% linkable_title Location support %}
|
||||||
|
|
||||||
@ -230,9 +327,21 @@ action:
|
|||||||
longitude: 117.22743
|
longitude: 117.22743
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
latitude:
|
||||||
- **latitude** (*Required*): The latitude to send.
|
description: The latitude to send.
|
||||||
- **longitude** (*Required*): The longitude to send.
|
required: true
|
||||||
- **keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom keyboard.
|
type: float
|
||||||
- **inline_keyboard** (*Optional*): List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
longitude:
|
||||||
|
description: The longitude to send.
|
||||||
|
required: true
|
||||||
|
type: float
|
||||||
|
keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom keyboard.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
inline_keyboard:
|
||||||
|
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user