Bot#

Bot instance can be created from aiogram.Bot (from aiogram import Bot) and you can’t use methods without instance of bot with configured token.

This class has aliases for all methods and named in lower_camel_case.

For example sendMessage named send_message and has the same specification with all class-based methods.

class aiogram.client.bot.Bot(token: str, session: Optional[aiogram.client.session.base.BaseSession] = None, parse_mode: Optional[str] = None)[source]#

Bases: aiogram.utils.mixins.ContextInstanceMixin[Bot]

__init__(token: str, session: Optional[aiogram.client.session.base.BaseSession] = None, parse_mode: Optional[str] = None) None[source]#

Bot class

Parameters
  • token – Telegram Bot token Obtained from @BotFather

  • session – HTTP Client session (For example AiohttpSession). If not specified it will be automatically created.

  • parse_mode – Default parse mode. If specified it will be propagated into the API methods at runtime.

Raises

TokenValidationError – When token has invalid format this exception will be raised

property token: str#
property id: int#

Get bot ID from token

Returns

context(auto_close: bool = True) AsyncIterator[aiogram.client.bot.Bot][source]#

Generate bot context

Parameters

auto_close

Returns

async me() aiogram.types.user.User[source]#
async download_file(file_path: str, destination: Optional[Union[BinaryIO, pathlib.Path, str]] = None, timeout: int = 30, chunk_size: int = 65536, seek: bool = True) Optional[BinaryIO][source]#

Download file by file_path to destination.

If you want to automatically create destination (io.BytesIO) use default value of destination and handle result of this method.

Parameters
  • file_path – File path on Telegram server (You can get it from aiogram.types.File)

  • destination – Filename, file path or instance of io.IOBase. For e.g. io.BytesIO, defaults to None

  • timeout – Total timeout in seconds, defaults to 30

  • chunk_size – File chunks size, defaults to 64 kb

  • seek – Go to start of file when downloading is finished. Used only for destination with typing.BinaryIO type, defaults to True

async download(file: Union[str, aiogram.types.downloadable.Downloadable], destination: Optional[Union[BinaryIO, pathlib.Path, str]] = None, timeout: int = 30, chunk_size: int = 65536, seek: bool = True) Optional[BinaryIO][source]#

Download file by file_id or Downloadable object to destination.

If you want to automatically create destination (io.BytesIO) use default value of destination and handle result of this method.

Parameters
  • file – file_id or Downloadable object

  • destination – Filename, file path or instance of io.IOBase. For e.g. io.BytesIO, defaults to None

  • timeout – Total timeout in seconds, defaults to 30

  • chunk_size – File chunks size, defaults to 64 kb

  • seek – Go to start of file when downloading is finished. Used only for destination with typing.BinaryIO type, defaults to True

async get_updates(offset: Optional[int] = None, limit: Optional[int] = None, timeout: Optional[int] = None, allowed_updates: Optional[List[str]] = None, request_timeout: Optional[int] = None) List[aiogram.types.update.Update][source]#

Use this method to receive incoming updates using long polling (wiki). An Array of aiogram.types.update.Update objects is returned.

Notes

1. This method will not work if an outgoing webhook is set up.

2. In order to avoid getting duplicate updates, recalculate offset after each server response.

Source: https://core.telegram.org/bots/api#getupdates

Parameters
  • offset – Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as aiogram.methods.get_updates.GetUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.

  • limit – Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.

  • timeout – Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.

  • allowed_updates – A JSON-serialized list of the update types you want your bot to receive. For example, specify [‘message’, ‘edited_channel_post’, ‘callback_query’] to only receive updates of these types. See aiogram.types.update.Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.

  • request_timeout – Request timeout

Returns

An Array of Update objects is returned.

async set_webhook(url: str, certificate: Optional[aiogram.types.input_file.InputFile] = None, ip_address: Optional[str] = None, max_connections: Optional[int] = None, allowed_updates: Optional[List[str]] = None, drop_pending_updates: Optional[bool] = None, secret_token: Optional[str] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized aiogram.types.update.Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success. If you’d like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header ‘X-Telegram-Bot-Api-Secret-Token’ with the secret token as content.

Notes

1. You will not be able to receive updates using aiogram.methods.get_updates.GetUpdates for as long as an outgoing webhook is set up.

2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.

3. Ports currently supported for webhooks: 443, 80, 88, 8443. If you’re having any trouble setting up webhooks, please check out this amazing guide to webhooks.

Source: https://core.telegram.org/bots/api#setwebhook

Parameters
  • url – HTTPS URL to send updates to. Use an empty string to remove webhook integration

  • certificate – Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.

  • ip_address – The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS

  • max_connections – The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot’s server, and higher values to increase your bot’s throughput.

  • allowed_updates – A JSON-serialized list of the update types you want your bot to receive. For example, specify [‘message’, ‘edited_channel_post’, ‘callback_query’] to only receive updates of these types. See aiogram.types.update.Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.

  • drop_pending_updates – Pass True to drop all pending updates

  • secret_token – A secret token to be sent in a header ‘X-Telegram-Bot-Api-Secret-Token’ in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.

  • request_timeout – Request timeout

Returns

Returns True on success.

async delete_webhook(drop_pending_updates: Optional[bool] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to remove webhook integration if you decide to switch back to aiogram.methods.get_updates.GetUpdates. Returns True on success.

Source: https://core.telegram.org/bots/api#deletewebhook

Parameters
  • drop_pending_updates – Pass True to drop all pending updates

  • request_timeout – Request timeout

Returns

Returns True on success.

async get_webhook_info(request_timeout: Optional[int] = None) aiogram.types.webhook_info.WebhookInfo[source]#

Use this method to get current webhook status. Requires no parameters. On success, returns a aiogram.types.webhook_info.WebhookInfo object. If the bot is using aiogram.methods.get_updates.GetUpdates, will return an object with the url field empty.

Source: https://core.telegram.org/bots/api#getwebhookinfo

Parameters

request_timeout – Request timeout

Returns

On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

async get_me(request_timeout: Optional[int] = None) aiogram.types.user.User[source]#

A simple method for testing your bot’s authentication token. Requires no parameters. Returns basic information about the bot in form of a aiogram.types.user.User object.

Source: https://core.telegram.org/bots/api#getme

Parameters

request_timeout – Request timeout

Returns

Returns basic information about the bot in form of a User object.

async log_out(request_timeout: Optional[int] = None) bool[source]#

Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Source: https://core.telegram.org/bots/api#logout

Parameters

request_timeout – Request timeout

Returns

Returns True on success.

async close(request_timeout: Optional[int] = None) bool[source]#

Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn’t launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Source: https://core.telegram.org/bots/api#close

Parameters

request_timeout – Request timeout

Returns

The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success.

async send_message(chat_id: Union[int, str], text: str, parse_mode: Optional[str] = sentinel.UNSET, entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, disable_web_page_preview: Optional[bool] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send text messages. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendmessage

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • text – Text of the message to be sent, 1-4096 characters after entities parsing

  • parse_mode – Mode for parsing entities in the message text. See formatting options for more details.

  • entities – A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode

  • disable_web_page_preview – Disables link previews for links in this message

  • disable_notification – Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup – Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async forward_message(chat_id: Union[int, str], from_chat_id: Union[int, str], message_id: int, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to forward messages of any kind. Service messages can’t be forwarded. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#forwardmessage

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • from_chat_id – Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)

  • message_id – Message identifier in the chat specified in from_chat_id

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the forwarded message from forwarding and saving

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async copy_message(chat_id: Union[int, str], from_chat_id: Union[int, str], message_id: int, caption: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, caption_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message_id.MessageId[source]#

Use this method to copy messages of any kind. Service messages and invoice messages can’t be copied. The method is analogous to the method aiogram.methods.forward_message.ForwardMessage, but the copied message doesn’t have a link to the original message. Returns the aiogram.types.message_id.MessageId of the sent message on success.

Source: https://core.telegram.org/bots/api#copymessage

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • from_chat_id – Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)

  • message_id – Message identifier in the chat specified in from_chat_id

  • caption – New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept

  • parse_mode

    Mode for parsing entities in the new caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

Returns the MessageId of the sent message on success.

async send_photo(chat_id: Union[int, str], photo: Union[aiogram.types.input_file.InputFile, str], caption: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, caption_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send photos. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendphoto

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • photo – Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo’s width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »

  • caption – Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing

  • parse_mode

    Mode for parsing entities in the photo caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_audio(chat_id: Union[int, str], audio: Union[aiogram.types.input_file.InputFile, str], caption: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, caption_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, duration: Optional[int] = None, performer: Optional[str] = None, title: Optional[str] = None, thumb: Optional[Union[aiogram.types.input_file.InputFile, str]] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent aiogram.types.message.Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the aiogram.methods.send_voice.SendVoice method instead.

Source: https://core.telegram.org/bots/api#sendaudio

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • audio – Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »

  • caption – Audio caption, 0-1024 characters after entities parsing

  • parse_mode

    Mode for parsing entities in the audio caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • duration – Duration of the audio in seconds

  • performer – Performer

  • title – Track name

  • thumb – 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>. More information on Sending Files »

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_document(chat_id: Union[int, str], document: Union[aiogram.types.input_file.InputFile, str], thumb: Optional[Union[aiogram.types.input_file.InputFile, str]] = None, caption: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, caption_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, disable_content_type_detection: Optional[bool] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send general files. On success, the sent aiogram.types.message.Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Source: https://core.telegram.org/bots/api#senddocument

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • document – File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »

  • thumb – 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>. More information on Sending Files »

  • caption – Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing

  • parse_mode

    Mode for parsing entities in the document caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • disable_content_type_detection – Disables automatic server-side content type detection for files uploaded using multipart/form-data

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_video(chat_id: Union[int, str], video: Union[aiogram.types.input_file.InputFile, str], duration: Optional[int] = None, width: Optional[int] = None, height: Optional[int] = None, thumb: Optional[Union[aiogram.types.input_file.InputFile, str]] = None, caption: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, caption_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, supports_streaming: Optional[bool] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as aiogram.types.document.Document). On success, the sent aiogram.types.message.Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Source: https://core.telegram.org/bots/api#sendvideo

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • video – Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »

  • duration – Duration of sent video in seconds

  • width – Video width

  • height – Video height

  • thumb – 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>. More information on Sending Files »

  • caption – Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing

  • parse_mode

    Mode for parsing entities in the video caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • supports_streaming – Pass True, if the uploaded video is suitable for streaming

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_animation(chat_id: Union[int, str], animation: Union[aiogram.types.input_file.InputFile, str], duration: Optional[int] = None, width: Optional[int] = None, height: Optional[int] = None, thumb: Optional[Union[aiogram.types.input_file.InputFile, str]] = None, caption: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, caption_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent aiogram.types.message.Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

Source: https://core.telegram.org/bots/api#sendanimation

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • animation – Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »

  • duration – Duration of sent animation in seconds

  • width – Animation width

  • height – Animation height

  • thumb – 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>. More information on Sending Files »

  • caption – Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing

  • parse_mode

    Mode for parsing entities in the animation caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_voice(chat_id: Union[int, str], voice: Union[aiogram.types.input_file.InputFile, str], caption: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, caption_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, duration: Optional[int] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as aiogram.types.audio.Audio or aiogram.types.document.Document). On success, the sent aiogram.types.message.Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Source: https://core.telegram.org/bots/api#sendvoice

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • voice – Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »

  • caption – Voice message caption, 0-1024 characters after entities parsing

  • parse_mode

    Mode for parsing entities in the voice message caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • duration – Duration of the voice message in seconds

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_video_note(chat_id: Union[int, str], video_note: Union[aiogram.types.input_file.InputFile, str], duration: Optional[int] = None, length: Optional[int] = None, thumb: Optional[Union[aiogram.types.input_file.InputFile, str]] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendvideonote

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • video_note – Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported

  • duration – Duration of sent video in seconds

  • length – Video width and height, i.e. diameter of the video message

  • thumb – 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>. More information on Sending Files »

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_media_group(chat_id: Union[int, str], media: List[Union[aiogram.types.input_media_audio.InputMediaAudio, aiogram.types.input_media_document.InputMediaDocument, aiogram.types.input_media_photo.InputMediaPhoto, aiogram.types.input_media_video.InputMediaVideo]], disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, request_timeout: Optional[int] = None) List[aiogram.types.message.Message][source]#

Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

Source: https://core.telegram.org/bots/api#sendmediagroup

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • media – A JSON-serialized array describing messages to be sent, must include 2-10 items

  • disable_notification

    Sends messages silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent messages from forwarding and saving

  • reply_to_message_id – If the messages are a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • request_timeout – Request timeout

Returns

On success, an array of Messages that were sent is returned.

async send_location(chat_id: Union[int, str], latitude: float, longitude: float, horizontal_accuracy: Optional[float] = None, live_period: Optional[int] = None, heading: Optional[int] = None, proximity_alert_radius: Optional[int] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send point on the map. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendlocation

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • latitude – Latitude of the location

  • longitude – Longitude of the location

  • horizontal_accuracy – The radius of uncertainty for the location, measured in meters; 0-1500

  • live_period – Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.

  • heading – For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

  • proximity_alert_radius – For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async edit_message_live_location(latitude: float, longitude: float, chat_id: Optional[Union[int, str]] = None, message_id: Optional[int] = None, inline_message_id: Optional[str] = None, horizontal_accuracy: Optional[float] = None, heading: Optional[int] = None, proximity_alert_radius: Optional[int] = None, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) Union[aiogram.types.message.Message, bool][source]#

Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to aiogram.methods.stop_message_live_location.StopMessageLiveLocation. On success, if the edited message is not an inline message, the edited aiogram.types.message.Message is returned, otherwise True is returned.

Source: https://core.telegram.org/bots/api#editmessagelivelocation

Parameters
  • latitude – Latitude of new location

  • longitude – Longitude of new location

  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Required if inline_message_id is not specified. Identifier of the message to edit

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message

  • horizontal_accuracy – The radius of uncertainty for the location, measured in meters; 0-1500

  • heading – Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

  • proximity_alert_radius – The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

  • reply_markup

    A JSON-serialized object for a new inline keyboard.

  • request_timeout – Request timeout

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

async stop_message_live_location(chat_id: Optional[Union[int, str]] = None, message_id: Optional[int] = None, inline_message_id: Optional[str] = None, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) Union[aiogram.types.message.Message, bool][source]#

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited aiogram.types.message.Message is returned, otherwise True is returned.

Source: https://core.telegram.org/bots/api#stopmessagelivelocation

Parameters
  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Required if inline_message_id is not specified. Identifier of the message with live location to stop

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message

  • reply_markup

    A JSON-serialized object for a new inline keyboard.

  • request_timeout – Request timeout

Returns

On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

async send_venue(chat_id: Union[int, str], latitude: float, longitude: float, title: str, address: str, foursquare_id: Optional[str] = None, foursquare_type: Optional[str] = None, google_place_id: Optional[str] = None, google_place_type: Optional[str] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send information about a venue. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendvenue

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • latitude – Latitude of the venue

  • longitude – Longitude of the venue

  • title – Name of the venue

  • address – Address of the venue

  • foursquare_id – Foursquare identifier of the venue

  • foursquare_type – Foursquare type of the venue, if known. (For example, ‘arts_entertainment/default’, ‘arts_entertainment/aquarium’ or ‘food/icecream’.)

  • google_place_id – Google Places identifier of the venue

  • google_place_type – Google Places type of the venue. (See supported types.)

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_contact(chat_id: Union[int, str], phone_number: str, first_name: str, last_name: Optional[str] = None, vcard: Optional[str] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send phone contacts. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendcontact

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • phone_number – Contact’s phone number

  • first_name – Contact’s first name

  • last_name – Contact’s last name

  • vcard – Additional data about the contact in the form of a vCard, 0-2048 bytes

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_poll(chat_id: Union[int, str], question: str, options: List[str], is_anonymous: Optional[bool] = None, type: Optional[str] = None, allows_multiple_answers: Optional[bool] = None, correct_option_id: Optional[int] = None, explanation: Optional[str] = None, explanation_parse_mode: Optional[str] = sentinel.UNSET, explanation_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, open_period: Optional[int] = None, close_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None, is_closed: Optional[bool] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send a native poll. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendpoll

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • question – Poll question, 1-300 characters

  • options – A JSON-serialized list of answer options, 2-10 strings 1-100 characters each

  • is_anonymousTrue, if the poll needs to be anonymous, defaults to True

  • type – Poll type, ‘quiz’ or ‘regular’, defaults to ‘regular’

  • allows_multiple_answersTrue, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False

  • correct_option_id – 0-based identifier of the correct answer option, required for polls in quiz mode

  • explanation – Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing

  • explanation_parse_mode

    Mode for parsing entities in the explanation. See formatting options for more details.

  • explanation_entities – A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode

  • open_period – Amount of time in seconds the poll will be active after creation, 5-600. Can’t be used together with close_date.

  • close_date – Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can’t be used together with open_period.

  • is_closed – Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_dice(chat_id: Union[int, str], emoji: Optional[str] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send an animated emoji that will display a random value. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#senddice

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • emoji – Emoji on which the dice throw animation is based. Currently, must be one of ‘🎲’, ‘🎯’, ‘🏀’, ‘⚽’, ‘🎳’, or ‘🎰’. Dice can have values 1-6 for ‘🎲’, ‘🎯’ and ‘🎳’, values 1-5 for ‘🏀’ and ‘⚽’, and values 1-64 for ‘🎰’. Defaults to ‘🎲’

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async send_chat_action(chat_id: Union[int, str], action: str, request_timeout: Optional[int] = None) bool[source]#

Use this method when you need to tell the user that something is happening on the bot’s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.

Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of ‘Retrieving image, please wait…’, the bot may use aiogram.methods.send_chat_action.SendChatAction with action = upload_photo. The user will see a ‘sending photo’ status for the bot.

We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

Source: https://core.telegram.org/bots/api#sendchataction

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • action – Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.

  • request_timeout – Request timeout

Returns

Returns True on success.

async get_user_profile_photos(user_id: int, offset: Optional[int] = None, limit: Optional[int] = None, request_timeout: Optional[int] = None) aiogram.types.user_profile_photos.UserProfilePhotos[source]#

Use this method to get a list of profile pictures for a user. Returns a aiogram.types.user_profile_photos.UserProfilePhotos object.

Source: https://core.telegram.org/bots/api#getuserprofilephotos

Parameters
  • user_id – Unique identifier of the target user

  • offset – Sequential number of the first photo to be returned. By default, all photos are returned.

  • limit – Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.

  • request_timeout – Request timeout

Returns

Returns a UserProfilePhotos object.

async get_file(file_id: str, request_timeout: Optional[int] = None) aiogram.types.file.File[source]#

Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a aiogram.types.file.File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling aiogram.methods.get_file.GetFile again. Note: This function may not preserve the original file name and MIME type. You should save the file’s MIME type and name (if available) when the File object is received.

Source: https://core.telegram.org/bots/api#getfile

Parameters
  • file_id – File identifier to get information about

  • request_timeout – Request timeout

Returns

On success, a File object is returned.

async ban_chat_member(chat_id: Union[int, str], user_id: int, until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None, revoke_messages: Optional[bool] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#banchatmember

Parameters
  • chat_id – Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)

  • user_id – Unique identifier of the target user

  • until_date – Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.

  • revoke_messages – Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

  • request_timeout – Request timeout

Returns

In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc. Returns True on success.

async kick_chat_member(chat_id: Union[int, str], user_id: int, until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None, revoke_messages: Optional[bool] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#banchatmember

Parameters
  • chat_id – Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)

  • user_id – Unique identifier of the target user

  • until_date – Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.

  • revoke_messages – Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

  • request_timeout – Request timeout

Returns

In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc. Returns True on success.

async unban_chat_member(chat_id: Union[int, str], user_id: int, only_if_banned: Optional[bool] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don’t want this, use the parameter only_if_banned. Returns True on success.

Source: https://core.telegram.org/bots/api#unbanchatmember

Parameters
  • chat_id – Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)

  • user_id – Unique identifier of the target user

  • only_if_banned – Do nothing if the user is not banned

  • request_timeout – Request timeout

Returns

The user will not return to the group or channel automatically, but will be able to join via link, etc. Returns True on success.

async restrict_chat_member(chat_id: Union[int, str], user_id: int, permissions: aiogram.types.chat_permissions.ChatPermissions, until_date: Optional[Union[datetime.datetime, datetime.timedelta, int]] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Source: https://core.telegram.org/bots/api#restrictchatmember

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

  • user_id – Unique identifier of the target user

  • permissions – A JSON-serialized object for new user permissions

  • until_date – Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever

  • request_timeout – Request timeout

Returns

Returns True on success.

async promote_chat_member(chat_id: Union[int, str], user_id: int, is_anonymous: Optional[bool] = None, can_manage_chat: Optional[bool] = None, can_post_messages: Optional[bool] = None, can_edit_messages: Optional[bool] = None, can_delete_messages: Optional[bool] = None, can_manage_video_chats: Optional[bool] = None, can_restrict_members: Optional[bool] = None, can_promote_members: Optional[bool] = None, can_change_info: Optional[bool] = None, can_invite_users: Optional[bool] = None, can_pin_messages: Optional[bool] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Source: https://core.telegram.org/bots/api#promotechatmember

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • user_id – Unique identifier of the target user

  • is_anonymous – Pass True, if the administrator’s presence in the chat is hidden

  • can_manage_chat – Pass True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege

  • can_post_messages – Pass True, if the administrator can create channel posts, channels only

  • can_edit_messages – Pass True, if the administrator can edit messages of other users and can pin messages, channels only

  • can_delete_messages – Pass True, if the administrator can delete messages of other users

  • can_manage_video_chats – Pass True, if the administrator can manage video chats

  • can_restrict_members – Pass True, if the administrator can restrict, ban or unban chat members

  • can_promote_members – Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)

  • can_change_info – Pass True, if the administrator can change chat title, photo and other settings

  • can_invite_users – Pass True, if the administrator can invite new users to the chat

  • can_pin_messages – Pass True, if the administrator can pin messages, supergroups only

  • request_timeout – Request timeout

Returns

Returns True on success.

async set_chat_administrator_custom_title(chat_id: Union[int, str], user_id: int, custom_title: str, request_timeout: Optional[int] = None) bool[source]#

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Source: https://core.telegram.org/bots/api#setchatadministratorcustomtitle

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

  • user_id – Unique identifier of the target user

  • custom_title – New custom title for the administrator; 0-16 characters, emoji are not allowed

  • request_timeout – Request timeout

Returns

Returns True on success.

async ban_chat_sender_chat(chat_id: Union[int, str], sender_chat_id: int, request_timeout: Optional[int] = None) bool[source]#

Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won’t be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#banchatsenderchat

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • sender_chat_id – Unique identifier of the target sender chat

  • request_timeout – Request timeout

Returns

Returns True on success.

async unban_chat_sender_chat(chat_id: Union[int, str], sender_chat_id: int, request_timeout: Optional[int] = None) bool[source]#

Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#unbanchatsenderchat

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • sender_chat_id – Unique identifier of the target sender chat

  • request_timeout – Request timeout

Returns

Returns True on success.

async set_chat_permissions(chat_id: Union[int, str], permissions: aiogram.types.chat_permissions.ChatPermissions, request_timeout: Optional[int] = None) bool[source]#

Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#setchatpermissions

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

  • permissions – A JSON-serialized object for new default chat permissions

  • request_timeout – Request timeout

Returns

Returns True on success.

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

Note: Each administrator in a chat generates their own invite links. Bots can’t use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using aiogram.methods.export_chat_invite_link.ExportChatInviteLink or by calling the aiogram.methods.get_chat.GetChat method. If your bot needs to generate a new primary invite link replacing its previous one, use aiogram.methods.export_chat_invite_link.ExportChatInviteLink again.

Source: https://core.telegram.org/bots/api#exportchatinvitelink

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • request_timeout – Request timeout

Returns

Returns the new invite link as String on success.

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method aiogram.methods.revoke_chat_invite_link.RevokeChatInviteLink. Returns the new invite link as aiogram.types.chat_invite_link.ChatInviteLink object.

Source: https://core.telegram.org/bots/api#createchatinvitelink

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • name – Invite link name; 0-32 characters

  • expire_date – Point in time (Unix timestamp) when the link will expire

  • member_limit – The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

  • creates_join_requestTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified

  • request_timeout – Request timeout

Returns

Returns the new invite link as ChatInviteLink object.

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a aiogram.types.chat_invite_link.ChatInviteLink object.

Source: https://core.telegram.org/bots/api#editchatinvitelink

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • invite_link – The invite link to edit

  • name – Invite link name; 0-32 characters

  • expire_date – Point in time (Unix timestamp) when the link will expire

  • member_limit – The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

  • creates_join_requestTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified

  • request_timeout – Request timeout

Returns

Returns the edited invite link as a ChatInviteLink object.

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as aiogram.types.chat_invite_link.ChatInviteLink object.

Source: https://core.telegram.org/bots/api#revokechatinvitelink

Parameters
  • chat_id – Unique identifier of the target chat or username of the target channel (in the format @channelusername)

  • invite_link – The invite link to revoke

  • request_timeout – Request timeout

Returns

Returns the revoked invite link as ChatInviteLink object.

async approve_chat_join_request(chat_id: Union[int, str], user_id: int, request_timeout: Optional[int] = None) bool[source]#

Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Source: https://core.telegram.org/bots/api#approvechatjoinrequest

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • user_id – Unique identifier of the target user

  • request_timeout – Request timeout

Returns

Returns True on success.

async decline_chat_join_request(chat_id: Union[int, str], user_id: int, request_timeout: Optional[int] = None) bool[source]#

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Source: https://core.telegram.org/bots/api#declinechatjoinrequest

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • user_id – Unique identifier of the target user

  • request_timeout – Request timeout

Returns

Returns True on success.

async set_chat_photo(chat_id: Union[int, str], photo: aiogram.types.input_file.InputFile, request_timeout: Optional[int] = None) bool[source]#

Use this method to set a new profile photo for the chat. Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#setchatphoto

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • photo – New chat photo, uploaded using multipart/form-data

  • request_timeout – Request timeout

Returns

Returns True on success.

async delete_chat_photo(chat_id: Union[int, str], request_timeout: Optional[int] = None) bool[source]#

Use this method to delete a chat photo. Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#deletechatphoto

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • request_timeout – Request timeout

Returns

Returns True on success.

async set_chat_title(chat_id: Union[int, str], title: str, request_timeout: Optional[int] = None) bool[source]#

Use this method to change the title of a chat. Titles can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#setchattitle

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • title – New chat title, 1-255 characters

  • request_timeout – Request timeout

Returns

Returns True on success.

async set_chat_description(chat_id: Union[int, str], description: Optional[str] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Source: https://core.telegram.org/bots/api#setchatdescription

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • description – New chat description, 0-255 characters

  • request_timeout – Request timeout

Returns

Returns True on success.

async pin_chat_message(chat_id: Union[int, str], message_id: int, disable_notification: Optional[bool] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Source: https://core.telegram.org/bots/api#pinchatmessage

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Identifier of a message to pin

  • disable_notification – Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.

  • request_timeout – Request timeout

Returns

Returns True on success.

async unpin_chat_message(chat_id: Union[int, str], message_id: Optional[int] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Source: https://core.telegram.org/bots/api#unpinchatmessage

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.

  • request_timeout – Request timeout

Returns

Returns True on success.

async unpin_all_chat_messages(chat_id: Union[int, str], request_timeout: Optional[int] = None) bool[source]#

Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Source: https://core.telegram.org/bots/api#unpinallchatmessages

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • request_timeout – Request timeout

Returns

Returns True on success.

async leave_chat(chat_id: Union[int, str], request_timeout: Optional[int] = None) bool[source]#

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Source: https://core.telegram.org/bots/api#leavechat

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

  • request_timeout – Request timeout

Returns

Returns True on success.

async get_chat(chat_id: Union[int, str], request_timeout: Optional[int] = None) aiogram.types.chat.Chat[source]#

Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a aiogram.types.chat.Chat object on success.

Source: https://core.telegram.org/bots/api#getchat

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

  • request_timeout – Request timeout

Returns

Returns a Chat object on success.

async get_chat_administrators(chat_id: Union[int, str], request_timeout: Optional[int] = None) List[Union[aiogram.types.chat_member_owner.ChatMemberOwner, aiogram.types.chat_member_administrator.ChatMemberAdministrator, aiogram.types.chat_member_member.ChatMemberMember, aiogram.types.chat_member_restricted.ChatMemberRestricted, aiogram.types.chat_member_left.ChatMemberLeft, aiogram.types.chat_member_banned.ChatMemberBanned]][source]#

Use this method to get a list of administrators in a chat. On success, returns an Array of aiogram.types.chat_member.ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

Source: https://core.telegram.org/bots/api#getchatadministrators

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

  • request_timeout – Request timeout

Returns

On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

async get_chat_member_count(chat_id: Union[int, str], request_timeout: Optional[int] = None) int[source]#

Use this method to get the number of members in a chat. Returns Int on success.

Source: https://core.telegram.org/bots/api#getchatmembercount

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

  • request_timeout – Request timeout

Returns

Returns Int on success.

async get_chat_members_count(chat_id: Union[int, str], request_timeout: Optional[int] = None) int[source]#

Use this method to get the number of members in a chat. Returns Int on success.

Source: https://core.telegram.org/bots/api#getchatmembercount

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

  • request_timeout – Request timeout

Returns

Returns Int on success.

async get_chat_member(chat_id: Union[int, str], user_id: int, request_timeout: Optional[int] = None) Union[aiogram.types.chat_member_owner.ChatMemberOwner, aiogram.types.chat_member_administrator.ChatMemberAdministrator, aiogram.types.chat_member_member.ChatMemberMember, aiogram.types.chat_member_restricted.ChatMemberRestricted, aiogram.types.chat_member_left.ChatMemberLeft, aiogram.types.chat_member_banned.ChatMemberBanned][source]#

Use this method to get information about a member of a chat. Returns a aiogram.types.chat_member.ChatMember object on success.

Source: https://core.telegram.org/bots/api#getchatmember

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)

  • user_id – Unique identifier of the target user

  • request_timeout – Request timeout

Returns

Returns a ChatMember object on success.

async set_chat_sticker_set(chat_id: Union[int, str], sticker_set_name: str, request_timeout: Optional[int] = None) bool[source]#

Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in aiogram.methods.get_chat.GetChat requests to check if the bot can use this method. Returns True on success.

Source: https://core.telegram.org/bots/api#setchatstickerset

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

  • sticker_set_name – Name of the sticker set to be set as the group sticker set

  • request_timeout – Request timeout

Returns

Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

async delete_chat_sticker_set(chat_id: Union[int, str], request_timeout: Optional[int] = None) bool[source]#

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in aiogram.methods.get_chat.GetChat requests to check if the bot can use this method. Returns True on success.

Source: https://core.telegram.org/bots/api#deletechatstickerset

Parameters
  • chat_id – Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

  • request_timeout – Request timeout

Returns

Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

async answer_callback_query(callback_query_id: str, text: Optional[str] = None, show_alert: Optional[bool] = None, url: Optional[str] = None, cache_time: Optional[int] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

Source: https://core.telegram.org/bots/api#answercallbackquery

Parameters
  • callback_query_id – Unique identifier for the query to be answered

  • text – Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters

  • show_alert – If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.

  • url

    URL that will be opened by the user’s client. If you have created a aiogram.types.game.Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a https://core.telegram.org/bots/api#inlinekeyboardbutton callback_game button.

  • cache_time – The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

  • request_timeout – Request timeout

Returns

On success, True is returned.

async set_my_commands(commands: List[aiogram.types.bot_command.BotCommand], scope: Optional[aiogram.types.bot_command_scope.BotCommandScope] = None, language_code: Optional[str] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to change the list of the bot’s commands. See https://core.telegram.org/bots#commands <https://core.telegram.org/bots#commands>`_`https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.

Source: https://core.telegram.org/bots/api#setmycommands

Parameters
  • commands – A JSON-serialized list of bot commands to be set as the list of the bot’s commands. At most 100 commands can be specified.

  • scope – A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to aiogram.types.bot_command_scope_default.BotCommandScopeDefault.

  • language_code – A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

  • request_timeout – Request timeout

Returns

Returns True on success.

async delete_my_commands(scope: Optional[aiogram.types.bot_command_scope.BotCommandScope] = None, language_code: Optional[str] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to delete the list of the bot’s commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Source: https://core.telegram.org/bots/api#deletemycommands

Parameters
  • scope – A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to aiogram.types.bot_command_scope_default.BotCommandScopeDefault.

  • language_code – A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

  • request_timeout – Request timeout

Returns

Returns True on success.

async get_my_commands(scope: Optional[aiogram.types.bot_command_scope.BotCommandScope] = None, language_code: Optional[str] = None, request_timeout: Optional[int] = None) List[aiogram.types.bot_command.BotCommand][source]#

Use this method to get the current list of the bot’s commands for the given scope and user language. Returns Array of aiogram.types.bot_command.BotCommand on success. If commands aren’t set, an empty list is returned.

Source: https://core.telegram.org/bots/api#getmycommands

Parameters
Returns

Returns Array of BotCommand on success. If commands aren’t set, an empty list is returned.

async set_chat_menu_button(chat_id: Optional[int] = None, menu_button: Optional[aiogram.types.menu_button.MenuButton] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to change the bot’s menu button in a private chat, or the default menu button. Returns True on success.

Source: https://core.telegram.org/bots/api#setchatmenubutton

Parameters
  • chat_id – Unique identifier for the target private chat. If not specified, default bot’s menu button will be changed

  • menu_button – A JSON-serialized object for the bot’s new menu button. Defaults to aiogram.types.menu_button_default.MenuButtonDefault

  • request_timeout – Request timeout

Returns

Returns True on success.

async get_chat_menu_button(chat_id: Optional[int] = None, request_timeout: Optional[int] = None) aiogram.types.menu_button.MenuButton[source]#

Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button. Returns aiogram.types.menu_button.MenuButton on success.

Source: https://core.telegram.org/bots/api#getchatmenubutton

Parameters
  • chat_id – Unique identifier for the target private chat. If not specified, default bot’s menu button will be returned

  • request_timeout – Request timeout

Returns

Returns MenuButton on success.

async set_my_default_administrator_rights(rights: Optional[aiogram.types.chat_administrator_rights.ChatAdministratorRights] = None, for_channels: Optional[bool] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to change the default administrator rights requested by the bot when it’s added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.

Source: https://core.telegram.org/bots/api#setmydefaultadministratorrights

Parameters
  • rights – A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.

  • for_channels – Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.

  • request_timeout – Request timeout

Returns

Returns True on success.

async get_my_default_administrator_rights(for_channels: Optional[bool] = None, request_timeout: Optional[int] = None) aiogram.types.chat_administrator_rights.ChatAdministratorRights[source]#

Use this method to get the current default administrator rights of the bot. Returns aiogram.types.chat_administrator_rights.ChatAdministratorRights on success.

Source: https://core.telegram.org/bots/api#getmydefaultadministratorrights

Parameters
  • for_channels – Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.

  • request_timeout – Request timeout

Returns

Returns ChatAdministratorRights on success.

async edit_message_text(text: str, chat_id: Optional[Union[int, str]] = None, message_id: Optional[int] = None, inline_message_id: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, disable_web_page_preview: Optional[bool] = None, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) Union[aiogram.types.message.Message, bool][source]#

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited aiogram.types.message.Message is returned, otherwise True is returned.

Source: https://core.telegram.org/bots/api#editmessagetext

Parameters
  • text – New text of the message, 1-4096 characters after entities parsing

  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Required if inline_message_id is not specified. Identifier of the message to edit

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message

  • parse_mode

    Mode for parsing entities in the message text. See formatting options for more details.

  • entities – A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode

  • disable_web_page_preview – Disables link previews for links in this message

  • reply_markup

    A JSON-serialized object for an inline keyboard.

  • request_timeout – Request timeout

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

async edit_message_caption(chat_id: Optional[Union[int, str]] = None, message_id: Optional[int] = None, inline_message_id: Optional[str] = None, caption: Optional[str] = None, parse_mode: Optional[str] = sentinel.UNSET, caption_entities: Optional[List[aiogram.types.message_entity.MessageEntity]] = None, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) Union[aiogram.types.message.Message, bool][source]#

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited aiogram.types.message.Message is returned, otherwise True is returned.

Source: https://core.telegram.org/bots/api#editmessagecaption

Parameters
  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Required if inline_message_id is not specified. Identifier of the message to edit

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message

  • caption – New caption of the message, 0-1024 characters after entities parsing

  • parse_mode

    Mode for parsing entities in the message caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • reply_markup

    A JSON-serialized object for an inline keyboard.

  • request_timeout – Request timeout

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

async edit_message_media(media: aiogram.types.input_media.InputMedia, chat_id: Optional[Union[int, str]] = None, message_id: Optional[int] = None, inline_message_id: Optional[str] = None, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) Union[aiogram.types.message.Message, bool][source]#

Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can’t be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited aiogram.types.message.Message is returned, otherwise True is returned.

Source: https://core.telegram.org/bots/api#editmessagemedia

Parameters
  • media – A JSON-serialized object for a new media content of the message

  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Required if inline_message_id is not specified. Identifier of the message to edit

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message

  • reply_markup

    A JSON-serialized object for a new inline keyboard.

  • request_timeout – Request timeout

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

async edit_message_reply_markup(chat_id: Optional[Union[int, str]] = None, message_id: Optional[int] = None, inline_message_id: Optional[str] = None, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) Union[aiogram.types.message.Message, bool][source]#

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited aiogram.types.message.Message is returned, otherwise True is returned.

Source: https://core.telegram.org/bots/api#editmessagereplymarkup

Parameters
  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Required if inline_message_id is not specified. Identifier of the message to edit

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message

  • reply_markup

    A JSON-serialized object for an inline keyboard.

  • request_timeout – Request timeout

Returns

On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

async stop_poll(chat_id: Union[int, str], message_id: int, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) aiogram.types.poll.Poll[source]#

Use this method to stop a poll which was sent by the bot. On success, the stopped aiogram.types.poll.Poll is returned.

Source: https://core.telegram.org/bots/api#stoppoll

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Identifier of the original message with the poll

  • reply_markup

    A JSON-serialized object for a new message inline keyboard.

  • request_timeout – Request timeout

Returns

On success, the stopped Poll is returned.

async delete_message(chat_id: Union[int, str], message_id: int, request_timeout: Optional[int] = None) bool[source]#

Use this method to delete a message, including service messages, with the following limitations:

  • A message can only be deleted if it was sent less than 48 hours ago.

  • A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.

  • Bots can delete outgoing messages in private chats, groups, and supergroups.

  • Bots can delete incoming messages in private chats.

  • Bots granted can_post_messages permissions can delete outgoing messages in channels.

  • If the bot is an administrator of a group, it can delete any message there.

  • If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.

Returns True on success.

Source: https://core.telegram.org/bots/api#deletemessage

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id – Identifier of the message to delete

  • request_timeout – Request timeout

Returns

Returns True on success.

async send_sticker(chat_id: Union[int, str], sticker: Union[aiogram.types.input_file.InputFile, str], disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup, aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup, aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove, aiogram.types.force_reply.ForceReply]] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendsticker

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • sticker – Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async get_sticker_set(name: str, request_timeout: Optional[int] = None) aiogram.types.sticker_set.StickerSet[source]#

Use this method to get a sticker set. On success, a aiogram.types.sticker_set.StickerSet object is returned.

Source: https://core.telegram.org/bots/api#getstickerset

Parameters
  • name – Name of the sticker set

  • request_timeout – Request timeout

Returns

On success, a StickerSet object is returned.

async upload_sticker_file(user_id: int, png_sticker: aiogram.types.input_file.InputFile, request_timeout: Optional[int] = None) aiogram.types.file.File[source]#

Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded aiogram.types.file.File on success.

Source: https://core.telegram.org/bots/api#uploadstickerfile

Parameters
  • user_id – User identifier of sticker file owner

  • png_stickerPNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More information on Sending Files »

  • request_timeout – Request timeout

Returns

Returns the uploaded File on success.

async create_new_sticker_set(user_id: int, name: str, title: str, emojis: str, png_sticker: Optional[Union[aiogram.types.input_file.InputFile, str]] = None, tgs_sticker: Optional[aiogram.types.input_file.InputFile] = None, webm_sticker: Optional[aiogram.types.input_file.InputFile] = None, contains_masks: Optional[bool] = None, mask_position: Optional[aiogram.types.mask_position.MaskPosition] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success.

Source: https://core.telegram.org/bots/api#createnewstickerset

Parameters
Returns

Returns True on success.

async add_sticker_to_set(user_id: int, name: str, emojis: str, png_sticker: Optional[Union[aiogram.types.input_file.InputFile, str]] = None, tgs_sticker: Optional[aiogram.types.input_file.InputFile] = None, webm_sticker: Optional[aiogram.types.input_file.InputFile] = None, mask_position: Optional[aiogram.types.mask_position.MaskPosition] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

Source: https://core.telegram.org/bots/api#addstickertoset

Parameters
Returns

Returns True on success.

async set_sticker_position_in_set(sticker: str, position: int, request_timeout: Optional[int] = None) bool[source]#

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

Source: https://core.telegram.org/bots/api#setstickerpositioninset

Parameters
  • sticker – File identifier of the sticker

  • position – New sticker position in the set, zero-based

  • request_timeout – Request timeout

Returns

Returns True on success.

async delete_sticker_from_set(sticker: str, request_timeout: Optional[int] = None) bool[source]#

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Source: https://core.telegram.org/bots/api#deletestickerfromset

Parameters
  • sticker – File identifier of the sticker

  • request_timeout – Request timeout

Returns

Returns True on success.

async set_sticker_set_thumb(name: str, user_id: int, thumb: Optional[Union[aiogram.types.input_file.InputFile, str]] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.

Source: https://core.telegram.org/bots/api#setstickersetthumb

Parameters
Returns

Returns True on success.

async answer_inline_query(inline_query_id: str, results: List[aiogram.types.inline_query_result.InlineQueryResult], cache_time: Optional[int] = None, is_personal: Optional[bool] = None, next_offset: Optional[str] = None, switch_pm_text: Optional[str] = None, switch_pm_parameter: Optional[str] = None, request_timeout: Optional[int] = None) bool[source]#

Use this method to send answers to an inline query. On success, True is returned.

No more than 50 results per query are allowed.

Source: https://core.telegram.org/bots/api#answerinlinequery

Parameters
  • inline_query_id – Unique identifier for the answered query

  • results – A JSON-serialized array of results for the inline query

  • cache_time – The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.

  • is_personal – Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query

  • next_offset – Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed 64 bytes.

  • switch_pm_text – If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter

  • switch_pm_parameterDeep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.

  • request_timeout – Request timeout

Returns

On success, True is returned.

async answer_web_app_query(web_app_query_id: str, result: aiogram.types.inline_query_result.InlineQueryResult, request_timeout: Optional[int] = None) aiogram.types.sent_web_app_message.SentWebAppMessage[source]#

Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a aiogram.types.sent_web_app_message.SentWebAppMessage object is returned.

Source: https://core.telegram.org/bots/api#answerwebappquery

Parameters
  • web_app_query_id – Unique identifier for the query to be answered

  • result – A JSON-serialized object describing the message to be sent

  • request_timeout – Request timeout

Returns

On success, a SentWebAppMessage object is returned.

async send_invoice(chat_id: Union[int, str], title: str, description: str, payload: str, provider_token: str, currency: str, prices: List[aiogram.types.labeled_price.LabeledPrice], max_tip_amount: Optional[int] = None, suggested_tip_amounts: Optional[List[int]] = None, start_parameter: Optional[str] = None, provider_data: Optional[str] = None, photo_url: Optional[str] = None, photo_size: Optional[int] = None, photo_width: Optional[int] = None, photo_height: Optional[int] = None, need_name: Optional[bool] = None, need_phone_number: Optional[bool] = None, need_email: Optional[bool] = None, need_shipping_address: Optional[bool] = None, send_phone_number_to_provider: Optional[bool] = None, send_email_to_provider: Optional[bool] = None, is_flexible: Optional[bool] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send invoices. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendinvoice

Parameters
  • chat_id – Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • title – Product name, 1-32 characters

  • description – Product description, 1-255 characters

  • payload – Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

  • provider_token

    Payment provider token, obtained via @BotFather

  • currency – Three-letter ISO 4217 currency code, see more on currencies

  • prices – Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)

  • max_tip_amount – The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0

  • suggested_tip_amounts – A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.

  • start_parameter – Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter

  • provider_data – JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

  • photo_url – URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.

  • photo_size – Photo size in bytes

  • photo_width – Photo width

  • photo_height – Photo height

  • need_name – Pass True, if you require the user’s full name to complete the order

  • need_phone_number – Pass True, if you require the user’s phone number to complete the order

  • need_email – Pass True, if you require the user’s email address to complete the order

  • need_shipping_address – Pass True, if you require the user’s shipping address to complete the order

  • send_phone_number_to_provider – Pass True, if the user’s phone number should be sent to provider

  • send_email_to_provider – Pass True, if the user’s email address should be sent to provider

  • is_flexible – Pass True, if the final price depends on the shipping method

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    A JSON-serialized object for an inline keyboard. If empty, one ‘Pay total price’ button will be shown. If not empty, the first button must be a Pay button.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Source: https://core.telegram.org/bots/api#createinvoicelink

Parameters
  • title – Product name, 1-32 characters

  • description – Product description, 1-255 characters

  • payload – Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

  • provider_token – Payment provider token, obtained via BotFather

  • currency

    Three-letter ISO 4217 currency code, see more on currencies

  • prices – Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)

  • max_tip_amount

    The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0

  • suggested_tip_amounts – A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.

  • provider_data – JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.

  • photo_url – URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

  • photo_size – Photo size in bytes

  • photo_width – Photo width

  • photo_height – Photo height

  • need_name – Pass True, if you require the user’s full name to complete the order

  • need_phone_number – Pass True, if you require the user’s phone number to complete the order

  • need_email – Pass True, if you require the user’s email address to complete the order

  • need_shipping_address – Pass True, if you require the user’s shipping address to complete the order

  • send_phone_number_to_provider – Pass True, if the user’s phone number should be sent to the provider

  • send_email_to_provider – Pass True, if the user’s email address should be sent to the provider

  • is_flexible – Pass True, if the final price depends on the shipping method

  • request_timeout – Request timeout

Returns

Returns the created invoice link as String on success.

async answer_shipping_query(shipping_query_id: str, ok: bool, shipping_options: Optional[List[aiogram.types.shipping_option.ShippingOption]] = None, error_message: Optional[str] = None, request_timeout: Optional[int] = None) bool[source]#

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an aiogram.types.update.Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Source: https://core.telegram.org/bots/api#answershippingquery

Parameters
  • shipping_query_id – Unique identifier for the query to be answered

  • ok – Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)

  • shipping_options – Required if ok is True. A JSON-serialized array of available shipping options.

  • error_message – Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable’). Telegram will display this message to the user.

  • request_timeout – Request timeout

Returns

On success, True is returned.

async answer_pre_checkout_query(pre_checkout_query_id: str, ok: bool, error_message: Optional[str] = None, request_timeout: Optional[int] = None) bool[source]#

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an aiogram.types.update.Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Source: https://core.telegram.org/bots/api#answerprecheckoutquery

Parameters
  • pre_checkout_query_id – Unique identifier for the query to be answered

  • ok – Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

  • error_message – Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. “Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!”). Telegram will display this message to the user.

  • request_timeout – Request timeout

Returns

On success, True is returned.

async set_passport_data_errors(user_id: int, errors: List[aiogram.types.passport_element_error.PassportElementError], request_timeout: Optional[int] = None) bool[source]#

Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn’t satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

Source: https://core.telegram.org/bots/api#setpassportdataerrors

Parameters
  • user_id – User identifier

  • errors – A JSON-serialized array describing the errors

  • request_timeout – Request timeout

Returns

The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.

async send_game(chat_id: int, game_short_name: str, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup] = None, request_timeout: Optional[int] = None) aiogram.types.message.Message[source]#

Use this method to send a game. On success, the sent aiogram.types.message.Message is returned.

Source: https://core.telegram.org/bots/api#sendgame

Parameters
  • chat_id – Unique identifier for the target chat

  • game_short_name

    Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.

  • disable_notification

    Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_to_message_id – If the message is a reply, ID of the original message

  • allow_sending_without_reply – Pass True, if the message should be sent even if the specified replied-to message is not found

  • reply_markup

    A JSON-serialized object for an inline keyboard. If empty, one ‘Play game_title’ button will be shown. If not empty, the first button must launch the game.

  • request_timeout – Request timeout

Returns

On success, the sent Message is returned.

async set_game_score(user_id: int, score: int, force: Optional[bool] = None, disable_edit_message: Optional[bool] = None, chat_id: Optional[int] = None, message_id: Optional[int] = None, inline_message_id: Optional[str] = None, request_timeout: Optional[int] = None) Union[aiogram.types.message.Message, bool][source]#

Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the aiogram.types.message.Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user’s current score in the chat and force is False.

Source: https://core.telegram.org/bots/api#setgamescore

Parameters
  • user_id – User identifier

  • score – New score, must be non-negative

  • force – Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters

  • disable_edit_message – Pass True, if the game message should not be automatically edited to include the current scoreboard

  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat

  • message_id – Required if inline_message_id is not specified. Identifier of the sent message

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message

  • request_timeout – Request timeout

Returns

On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user’s current score in the chat and force is False.

async get_game_high_scores(user_id: int, chat_id: Optional[int] = None, message_id: Optional[int] = None, inline_message_id: Optional[str] = None, request_timeout: Optional[int] = None) List[aiogram.types.game_high_score.GameHighScore][source]#

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of aiogram.types.game_high_score.GameHighScore objects.

This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.

Source: https://core.telegram.org/bots/api#getgamehighscores

Parameters
  • user_id – Target user id

  • chat_id – Required if inline_message_id is not specified. Unique identifier for the target chat

  • message_id – Required if inline_message_id is not specified. Identifier of the sent message

  • inline_message_id – Required if chat_id and message_id are not specified. Identifier of the inline message

  • request_timeout – Request timeout

Returns

Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects. This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them.