mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-12 02:03:04 +00:00
Add support of Bot API 4.7. Bump version
This commit is contained in:
parent
4cb9697cb4
commit
33003f2026
167 changed files with 996 additions and 504 deletions
25
docs/api/types/bot_command.md
Normal file
25
docs/api/types/bot_command.md
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
# BotCommand
|
||||
|
||||
## Description
|
||||
|
||||
This object represents a bot command.
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
| Name | Type | Description |
|
||||
| - | - | - |
|
||||
| `command` | `#!python str` | Text of the command, 1-32 characters. Can contain only lowercase English letters, digits and underscores. |
|
||||
| `description` | `#!python str` | Description of the command, 3-256 characters. |
|
||||
|
||||
|
||||
|
||||
## Location
|
||||
|
||||
- `from aiogram.types import BotCommand`
|
||||
- `from aiogram.api.types import BotCommand`
|
||||
- `from aiogram.api.types.bot_command import BotCommand`
|
||||
|
||||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#botcommand)
|
||||
24
docs/api/types/dice.md
Normal file
24
docs/api/types/dice.md
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# Dice
|
||||
|
||||
## Description
|
||||
|
||||
This object represents a dice with random value from 1 to 6. (Yes, we're aware of the 'proper' singular of die. But it's awkward, and we decided to help it change. One dice at a time!)
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
| Name | Type | Description |
|
||||
| - | - | - |
|
||||
| `value` | `#!python int` | Value of the dice, 1-6 |
|
||||
|
||||
|
||||
|
||||
## Location
|
||||
|
||||
- `from aiogram.types import Dice`
|
||||
- `from aiogram.api.types import Dice`
|
||||
- `from aiogram.api.types.dice import Dice`
|
||||
|
||||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#dice)
|
||||
|
|
@ -2,7 +2,6 @@
|
|||
|
||||
Here is list of all available API types:
|
||||
|
||||
|
||||
- Getting updates
|
||||
- [Update](update.md)
|
||||
- [WebhookInfo](webhook_info.md)
|
||||
|
|
@ -24,6 +23,7 @@ Here is list of all available API types:
|
|||
- [PollOption](poll_option.md)
|
||||
- [PollAnswer](poll_answer.md)
|
||||
- [Poll](poll.md)
|
||||
- [Dice](dice.md)
|
||||
- [UserProfilePhotos](user_profile_photos.md)
|
||||
- [File](file.md)
|
||||
- [ReplyKeyboardMarkup](reply_keyboard_markup.md)
|
||||
|
|
@ -38,6 +38,7 @@ Here is list of all available API types:
|
|||
- [ChatPhoto](chat_photo.md)
|
||||
- [ChatMember](chat_member.md)
|
||||
- [ChatPermissions](chat_permissions.md)
|
||||
- [BotCommand](bot_command.md)
|
||||
- [ResponseParameters](response_parameters.md)
|
||||
- [InputMedia](input_media.md)
|
||||
- [InputMediaPhoto](input_media_photo.md)
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ This object represents an incoming inline query. When the user sends an empty qu
|
|||
| - | - | - |
|
||||
| `id` | `#!python str` | Unique identifier for this query |
|
||||
| `from_user` | `#!python User` | Sender |
|
||||
| `query` | `#!python str` | Text of the query (up to 512 characters) |
|
||||
| `query` | `#!python str` | Text of the query (up to 256 characters) |
|
||||
| `offset` | `#!python str` | Offset of the results to be returned, can be controlled by the bot |
|
||||
| `location` | `#!python Optional[Location]` | Optional. Sender location, only for bots that request user location |
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old
|
|||
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
|
||||
| `audio_url` | `#!python str` | A valid URL for the audio file |
|
||||
| `title` | `#!python str` | Title |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `performer` | `#!python Optional[str]` | Optional. Performer |
|
||||
| `audio_duration` | `#!python Optional[int]` | Optional. Audio duration in seconds |
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old
|
|||
| `type` | `#!python str` | Type of the result, must be audio |
|
||||
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
|
||||
| `audio_file_id` | `#!python str` | A valid file identifier for the audio file |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the audio |
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old
|
|||
| `title` | `#!python str` | Title for the result |
|
||||
| `document_file_id` | `#!python str` | A valid file identifier for the file |
|
||||
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the document to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the file |
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Represents a link to an animated GIF file stored on the Telegram servers. By def
|
|||
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
|
||||
| `gif_file_id` | `#!python str` | A valid file identifier for the GIF file |
|
||||
| `title` | `#!python Optional[str]` | Optional. Title for the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the GIF file to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the GIF animation |
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) st
|
|||
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
|
||||
| `mpeg4_file_id` | `#!python str` | A valid file identifier for the MP4 file |
|
||||
| `title` | `#!python Optional[str]` | Optional. Title for the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the video animation |
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Represents a link to a photo stored on the Telegram servers. By default, this ph
|
|||
| `photo_file_id` | `#!python str` | A valid file identifier of the photo |
|
||||
| `title` | `#!python Optional[str]` | Optional. Title for the result |
|
||||
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the photo to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the photo |
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Represents a link to a video file stored on the Telegram servers. By default, th
|
|||
| `video_file_id` | `#!python str` | A valid file identifier for the video file |
|
||||
| `title` | `#!python str` | Title for the result |
|
||||
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the video to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the video |
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old
|
|||
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
|
||||
| `voice_file_id` | `#!python str` | A valid file identifier for the voice message |
|
||||
| `title` | `#!python str` | Voice message title |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the voice message |
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old
|
|||
| `title` | `#!python str` | Title for the result |
|
||||
| `document_url` | `#!python str` | A valid URL for the file |
|
||||
| `mime_type` | `#!python str` | Mime type of the content of the file, either 'application/pdf' or 'application/zip' |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the document to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Represents a link to an animated GIF file. By default, this animated GIF file wi
|
|||
| `gif_height` | `#!python Optional[int]` | Optional. Height of the GIF |
|
||||
| `gif_duration` | `#!python Optional[int]` | Optional. Duration of the GIF |
|
||||
| `title` | `#!python Optional[str]` | Optional. Title for the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the GIF file to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the GIF animation |
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). B
|
|||
| `mpeg4_height` | `#!python Optional[int]` | Optional. Video height |
|
||||
| `mpeg4_duration` | `#!python Optional[int]` | Optional. Video duration |
|
||||
| `title` | `#!python Optional[str]` | Optional. Title for the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the video animation |
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Represents a link to a photo. By default, this photo will be sent by the user wi
|
|||
| `photo_height` | `#!python Optional[int]` | Optional. Height of the photo |
|
||||
| `title` | `#!python Optional[str]` | Optional. Title for the result |
|
||||
| `description` | `#!python Optional[str]` | Optional. Short description of the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the photo to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
| `input_message_content` | `#!python Optional[InputMessageContent]` | Optional. Content of the message to be sent instead of the photo |
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube),
|
|||
| `mime_type` | `#!python str` | Mime type of the content of video url, 'text/html' or 'video/mp4' |
|
||||
| `thumb_url` | `#!python str` | URL of the thumbnail (jpeg only) for the video |
|
||||
| `title` | `#!python str` | Title for the result |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the video to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `video_width` | `#!python Optional[int]` | Optional. Video width |
|
||||
| `video_height` | `#!python Optional[int]` | Optional. Video height |
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Description
|
||||
|
||||
Represents a link to a voice recording in an .ogg container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
|
||||
Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
|
||||
|
||||
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
|
||||
|
||||
|
|
@ -15,7 +15,7 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old
|
|||
| `id` | `#!python str` | Unique identifier for this result, 1-64 bytes |
|
||||
| `voice_url` | `#!python str` | A valid URL for the voice recording |
|
||||
| `title` | `#!python str` | Recording title |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `voice_duration` | `#!python Optional[int]` | Optional. Recording duration in seconds |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message |
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be
|
|||
| `type` | `#!python str` | Type of the result, must be animation |
|
||||
| `media` | `#!python Union[str, InputFile]` | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. |
|
||||
| `thumb` | `#!python Optional[Union[InputFile, str]]` | Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the animation to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `width` | `#!python Optional[int]` | Optional. Animation width |
|
||||
| `height` | `#!python Optional[int]` | Optional. Animation height |
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Represents an audio file to be treated as music to be sent.
|
|||
| `type` | `#!python str` | Type of the result, must be audio |
|
||||
| `media` | `#!python Union[str, InputFile]` | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. |
|
||||
| `thumb` | `#!python Optional[Union[InputFile, str]]` | Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the audio to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `duration` | `#!python Optional[int]` | Optional. Duration of the audio in seconds |
|
||||
| `performer` | `#!python Optional[str]` | Optional. Performer of the audio |
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Represents a general file to be sent.
|
|||
| `type` | `#!python str` | Type of the result, must be document |
|
||||
| `media` | `#!python Union[str, InputFile]` | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. |
|
||||
| `thumb` | `#!python Optional[Union[InputFile, str]]` | Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the document to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Represents a photo to be sent.
|
|||
| - | - | - |
|
||||
| `type` | `#!python str` | Type of the result, must be photo |
|
||||
| `media` | `#!python Union[str, InputFile]` | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the photo to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Represents a video to be sent.
|
|||
| `type` | `#!python str` | Type of the result, must be video |
|
||||
| `media` | `#!python Union[str, InputFile]` | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. |
|
||||
| `thumb` | `#!python Optional[Union[InputFile, str]]` | Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the video to be sent, 0-1024 characters |
|
||||
| `caption` | `#!python Optional[str]` | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing |
|
||||
| `parse_mode` | `#!python Optional[str]` | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. |
|
||||
| `width` | `#!python Optional[int]` | Optional. Video width |
|
||||
| `height` | `#!python Optional[int]` | Optional. Video height |
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@
|
|||
|
||||
This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields request_contact, request_location, and request_poll are mutually exclusive.
|
||||
|
||||
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will receive unsupported message.
|
||||
Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
|
||||
|
||||
Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will receive unsupported message.
|
||||
Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
|
||||
|
||||
|
||||
## Attributes
|
||||
|
|
|
|||
|
|
@ -19,11 +19,11 @@ This object represents a message.
|
|||
| `forward_signature` | `#!python Optional[str]` | Optional. For messages forwarded from channels, signature of the post author if present |
|
||||
| `forward_sender_name` | `#!python Optional[str]` | Optional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages |
|
||||
| `forward_date` | `#!python Optional[int]` | Optional. For forwarded messages, date the original message was sent in Unix time |
|
||||
| `reply_to_message` | `#!python Optional[send_to_message.mdMessReply to message with to_messageage]` | Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply. |
|
||||
| `reply_to_message` | `#!python Optional[Message]` | Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply. |
|
||||
| `edit_date` | `#!python Optional[int]` | Optional. Date the message was last edited in Unix time |
|
||||
| `media_group_id` | `#!python Optional[str]` | Optional. The unique identifier of a media message group this message belongs to |
|
||||
| `author_signature` | `#!python Optional[str]` | Optional. Signature of the post author for messages in channels |
|
||||
| `text` | `#!python Optional[str]` | Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters. |
|
||||
| `text` | `#!python Optional[str]` | Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters |
|
||||
| `entities` | `#!python Optional[List[MessageEntity]]` | Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text |
|
||||
| `caption_entities` | `#!python Optional[List[MessageEntity]]` | Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption |
|
||||
| `audio` | `#!python Optional[Audio]` | Optional. Message is an audio file, information about the file |
|
||||
|
|
@ -40,6 +40,7 @@ This object represents a message.
|
|||
| `location` | `#!python Optional[Location]` | Optional. Message is a shared location, information about the location |
|
||||
| `venue` | `#!python Optional[Venue]` | Optional. Message is a venue, information about the venue |
|
||||
| `poll` | `#!python Optional[Poll]` | Optional. Message is a native poll, information about the poll |
|
||||
| `dice` | `#!python Optional[Dice]` | Optional. Message is a dice with random value from 1 to 6 |
|
||||
| `new_chat_members` | `#!python Optional[List[User]]` | Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) |
|
||||
| `left_chat_member` | `#!python Optional[User]` | Optional. A member was removed from the group, information about them (this member may be the bot itself) |
|
||||
| `new_chat_title` | `#!python Optional[str]` | Optional. A chat title was changed to this value |
|
||||
|
|
@ -55,7 +56,7 @@ This object represents a message.
|
|||
| `successful_payment` | `#!python Optional[SuccessfulPayment]` | Optional. Message is a service message about a successful payment, information about the payment. |
|
||||
| `connected_website` | `#!python Optional[str]` | Optional. The domain name of the website on which the user has logged in. |
|
||||
| `passport_data` | `#!python Optional[PassportData]` | Optional. Telegram Passport data |
|
||||
| `reply_markup` | `#!python Optional[send_markup.mdInliReply to message with markupneKeyboardMarkup]` | Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. |
|
||||
| `reply_markup` | `#!python Optional[InlineKeyboardMarkup]` | Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. |
|
||||
|
||||
|
||||
|
||||
|
|
@ -101,6 +102,7 @@ This methods has the same specification with the API but without `chat_id` and `
|
|||
- [aiogram.types.Audio](../types/audio.md)
|
||||
- [aiogram.types.Chat](../types/chat.md)
|
||||
- [aiogram.types.Contact](../types/contact.md)
|
||||
- [aiogram.types.Dice](../types/dice.md)
|
||||
- [aiogram.types.Document](../types/document.md)
|
||||
- [aiogram.types.Game](../types/game.md)
|
||||
- [aiogram.types.InlineKeyboardMarkup](../types/inline_keyboard_markup.md)
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ This object represents a sticker.
|
|||
| `width` | `#!python int` | Sticker width |
|
||||
| `height` | `#!python int` | Sticker height |
|
||||
| `is_animated` | `#!python bool` | True, if the sticker is animated |
|
||||
| `thumb` | `#!python Optional[PhotoSize]` | Optional. Sticker thumbnail in the .webp or .jpg format |
|
||||
| `thumb` | `#!python Optional[PhotoSize]` | Optional. Sticker thumbnail in the .WEBP or .JPG format |
|
||||
| `emoji` | `#!python Optional[str]` | Optional. Emoji associated with the sticker |
|
||||
| `set_name` | `#!python Optional[str]` | Optional. Name of the sticker set to which the sticker belongs |
|
||||
| `mask_position` | `#!python Optional[MaskPosition]` | Optional. For mask stickers, the position where the mask should be placed |
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@ This object represents a sticker set.
|
|||
| `is_animated` | `#!python bool` | True, if the sticker set contains animated stickers |
|
||||
| `contains_masks` | `#!python bool` | True, if the sticker set contains masks |
|
||||
| `stickers` | `#!python List[Sticker]` | List of all set stickers |
|
||||
| `thumb` | `#!python Optional[PhotoSize]` | Optional. Sticker set thumbnail in the .WEBP or .TGS format |
|
||||
|
||||
|
||||
|
||||
|
|
@ -26,4 +27,5 @@ This object represents a sticker set.
|
|||
## Related pages:
|
||||
|
||||
- [Official documentation](https://core.telegram.org/bots/api#stickerset)
|
||||
- [aiogram.types.PhotoSize](../types/photo_size.md)
|
||||
- [aiogram.types.Sticker](../types/sticker.md)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue