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-10 19:06:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for telegram_bot bearer_token authentication (#16584)

Browse Source
This commit is contained in:
Farzad Noorian 2021-06-29 04:43:47 +10:00 committed by GitHub
parent 4dd1d24ae7
commit fcf58d34bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
source/_integrations/telegram_bot.markdown
View File

@ -43,9 +43,9 @@ Send a photo.
| `url` | no | Remote path to an image. | | `url` | no | Remote path to an image. |
| `file` | no | Local path to an image. | | `file` | no | Local path to an image. |
| `caption` | yes | The title of the image. | | `caption` | yes | The title of the image. |
| `username` | yes | Username for a URL which requires HTTP basic authentication. | | `username` | yes | Username for a URL which requires HTTP authentication. |
| `password` | yes | Password for a URL which requires HTTP basic authentication. | | `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. |
| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token 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. | | `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`. | | `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_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. |
@ -64,9 +64,9 @@ Send a video.
| `url` | no | Remote path to a video. | | `url` | no | Remote path to a video. |
| `file` | no | Local path to a video. | | `file` | no | Local path to a video. |
| `caption` | yes | The title of the video. | | `caption` | yes | The title of the video. |
| `username` | yes | Username for a URL which requires HTTP basic authentication. | | `username` | yes | Username for a URL which requires HTTP authentication. |
| `password` | yes | Password for a URL which requires HTTP basic authentication. | | `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. |
| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token 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. | | `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`. | | `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. | | `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. |
@ -84,9 +84,9 @@ Send an animation.
| `url` | no | Remote path to a GIF or H.264/MPEG-4 AVC video without sound. | | `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. | | `file` | no | Local path to a GIF or H.264/MPEG-4 AVC video without sound. |
| `caption` | yes | The title of the animation. | | `caption` | yes | The title of the animation. |
| `username` | yes | Username for a URL which requires HTTP basic authentication. | | `username` | yes | Username for a URL which requires HTTP authentication. |
| `password` | yes | Password for a URL which requires HTTP basic authentication. | | `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. |
| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token 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. | | `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`. | | `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. | | `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. |
@ -105,9 +105,9 @@ Send a voice message.
| `url` | no | Remote path to a voice message. | | `url` | no | Remote path to a voice message. |
| `file` | no | Local path to a voice message. | | `file` | no | Local path to a voice message. |
| `caption` | yes | The title of the voice message. | | `caption` | yes | The title of the voice message. |
| `username` | yes | Username for a URL which requires HTTP basic authentication. | | `username` | yes | Username for a URL which requires HTTP authentication. |
| `password` | yes | Password for a URL which requires HTTP basic authentication. | | `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. |
| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token 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. | | `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. | | `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. | | `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. |
@ -124,9 +124,9 @@ Send a sticker.
|---------------------------|----------|--------------------------------------------------| |---------------------------|----------|--------------------------------------------------|
| `url` | no | Remote path to a static .webp or animated .tgs sticker. | | `url` | no | Remote path to a static .webp or animated .tgs sticker. |
| `file` | no | Local 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. | | `username` | yes | Username for a URL which requires HTTP authentication. |
| `password` | yes | Password for a URL which requires HTTP basic authentication. | | `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. |
| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token 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. | | `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. | | `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. | | `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. |
@ -144,9 +144,9 @@ Send a document.
| `url` | no | Remote path to a document. | | `url` | no | Remote path to a document. |
| `file` | no | Local path to a document. | | `file` | no | Local path to a document. |
| `caption` | yes | The title of the document. | | `caption` | yes | The title of the document. |
| `username` | yes | Username for a URL which requires HTTP basic authentication. | | `username` | yes | Username for a URL which requires HTTP authentication. |
| `password` | yes | Password for a URL which requires HTTP basic authentication. | | `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. |
| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. | | `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token 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. | | `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`. | | `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_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. |