Messages

Model aiotelebot.messages.AnswerCallbackQueryRequest(data=None, flat=False, *args, **kwargs)[source]

Answer callback query request model.

See also

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

property text: str

StringField field

property callback_query_id: str

StringIdField field

property show_alert: bool
Default value:False

BooleanField field

Model aiotelebot.messages.AnswerInlineQueryRequest(data=None, flat=False, *args, **kwargs)[source]

Answer inline query result request model.

See also

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

property results: List of BaseInlineQueryResult

Array of ModelField field (aiotelebot.messages.BaseInlineQueryResult)

property next_offset: str

StringIdField field

property is_personal: bool
Default value:False

BooleanField field

property inline_query_id: str

StringIdField field

property switch_pm_parameter: str

StringField field

property cache_time: int

IntegerField field

property switch_pm_text: str

StringField field

Model aiotelebot.messages.Audio(data=None, flat=False, *args, **kwargs)[source]

This object represents an audio file to be treated as music by the Telegram clients.

See also

https://core.telegram.org/bots/api#audio

property mime_type: str

StringField field

property performer: str

StringField field

property duration: int

IntegerField field

property file_id: str

StringIdField field

property title: str

StringField field

property file_size: int

IntegerField field

Model aiotelebot.messages.BaseActor(data=None, flat=False, *args, **kwargs)[source]

Base model for telegram actors.

property first_name: str

StringIdField field

property last_name: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property username: str

StringIdField field

Model aiotelebot.messages.BaseAttachment(data=None, flat=False, *args, **kwargs)[source]

Base model for attachments.

property file_id: str

StringIdField field

property file_size: int

IntegerField field

Model aiotelebot.messages.BaseChatMessageRequest(data=None, flat=False, *args, **kwargs)[source]

Base model of message chat request types.

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property reply_to_message_id: int

IntegerField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property disable_notification: bool
Default value:False

BooleanField field

Model aiotelebot.messages.BaseChatRequest(data=None, flat=False, *args, **kwargs)[source]

Base model of chat request types.

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.BaseEditMessageRequest(data=None, flat=False, *args, **kwargs)[source]

Base request model for editing messages.

property message_id: str

StringIdField field

property inline_message_id: str

StringIdField field

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.BaseInlineQueryResult(data=None, flat=False, *args, **kwargs)[source]

Base model for inline query result types.

class Type[source]

An enumeration.

ARTICLE = 'article'
AUDIO = 'audio'
CONTACT = 'contact'
DOCUMENT = 'document'
GIF = 'gif'
LOCATION = 'location'
MPEG4_GIF = 'mpeg4_gif'
PHOTO = 'photo'
STICKER = 'sticker'
VENUE = 'venue'
VIDEO = 'video'
VOICE = 'voice'
property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

Model aiotelebot.messages.BaseInlineQueryResultAudio(data=None, flat=False, *args, **kwargs)[source]

Base model for inline query result audio types.

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property type: str [READ ONLY]
Default value:Type.AUDIO

StringIdField field [READ ONLY]

Model aiotelebot.messages.BaseInlineQueryResultDocument(data=None, flat=False, *args, **kwargs)[source]

Base model for inline query result document types.

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property type: str [READ ONLY]
Default value:Type.DOCUMENT

StringIdField field [READ ONLY]

Model aiotelebot.messages.BaseInlineQueryResultGif(data=None, flat=False, *args, **kwargs)[source]

Base model for inline query result git picture types.

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property type: str [READ ONLY]
Default value:Type.GIF

StringIdField field [READ ONLY]

Model aiotelebot.messages.BaseInlineQueryResultMpeg4Gif(data=None, flat=False, *args, **kwargs)[source]

Base model for inline query result mpeg4 animation types.

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property type: str [READ ONLY]
Default value:Type.MPEG4_GIF

StringIdField field [READ ONLY]

Model aiotelebot.messages.BaseInlineQueryResultPhoto(data=None, flat=False, *args, **kwargs)[source]

Base model for inline query result photo types.

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property type: str [READ ONLY]
Default value:Type.PHOTO

StringIdField field [READ ONLY]

Model aiotelebot.messages.BaseInlineQueryResultVideo(data=None, flat=False, *args, **kwargs)[source]

Base model for inline query result video types.

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property type: str [READ ONLY]
Default value:Type.VIDEO

StringIdField field [READ ONLY]

Model aiotelebot.messages.BaseInlineQueryResultVoice(data=None, flat=False, *args, **kwargs)[source]

Base model for inline query result voice types.

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property type: str [READ ONLY]
Default value:Type.VOICE

StringIdField field [READ ONLY]

Model aiotelebot.messages.BaseInputMessageContent(data=None, flat=False, *args, **kwargs)[source]

Base model for input message content types.

Model aiotelebot.messages.BaseKeyboardMarkup(data=None, flat=False, *args, **kwargs)[source]

Parent model of keyboard markups.

Model aiotelebot.messages.CallbackQuery(data=None, flat=False, *args, **kwargs)[source]

This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be presented. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be presented.

See also

https://core.telegram.org/bots/api#callbackquery

property data: str

StringIdField field

property inline_message_id: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property message: Message

ModelField field (aiotelebot.messages.Message)

property from: User

ModelField field (aiotelebot.messages.User)

Aliases:
  • callback_query_from
Model aiotelebot.messages.CaptionMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin for inline query results with caption.

property caption: str

StringField field

Model aiotelebot.messages.Chat(data=None, flat=False, *args, **kwargs)[source]

This object represents a chat.

See also

https://core.telegram.org/bots/api#chat

class Type[source]

An enumeration.

CHANNEL = 'channel'
GROUP = 'group'
PRIVATE = 'private'
SUPERGROUP = 'supergroup'
property first_name: str

StringIdField field

property last_name: str

StringIdField field

property username: str

StringIdField field

property type: Type

EnumField field (aiotelebot.messages.Type)

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property title: str

StringField field

Model aiotelebot.messages.ChatMember(data=None, flat=False, *args, **kwargs)[source]

This object contains information about one member of the chat.

See also

https://core.telegram.org/bots/api#chatmember

class Status[source]

An enumeration.

ADMINISTRATOR = 'administrator'
CREATOR = 'creator'
KICKED = 'kicked'
LEFT = 'left'
MEMBER = 'member'
property status: Status

EnumField field (aiotelebot.messages.Status)

property user: User

ModelField field (aiotelebot.messages.User)

Model aiotelebot.messages.ChosenInlineResult(data=None, flat=False, *args, **kwargs)[source]

Represents a result of an inline query that was chosen by the user and sent to their chat partner.

See also

https://core.telegram.org/bots/api#choseninlineresult

property query: str

StringIdField field

property inline_message_id: str

StringIdField field

property location: Location

ModelField field (aiotelebot.messages.Location)

property result_id: str

StringIdField field

property from: User

ModelField field (aiotelebot.messages.User)

Aliases:
  • chosen_inline_result_from
Model aiotelebot.messages.Contact(data=None, flat=False, *args, **kwargs)[source]

This object represents a phone contact.

See also

https://core.telegram.org/bots/api#contact

property first_name: str

StringField field

property last_name: str

StringField field

property user_id: int

IntegerField field

property phone_number: str

StringIdField field

Model aiotelebot.messages.DescriptionMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin for inline query results with description.

property description: str

StringField field

Model aiotelebot.messages.Document(data=None, flat=False, *args, **kwargs)[source]

This object represents a general file (as opposed to photos, voice messages and audio files).

See also

https://core.telegram.org/bots/api#document

property file_id: str

StringIdField field

property thumb: PhotoSize

ModelField field (aiotelebot.messages.PhotoSize)

property file_size: int

IntegerField field

Model aiotelebot.messages.EditMessageCaptionRequest(data=None, flat=False, *args, **kwargs)[source]

Edit message caption request model.

See also

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

property message_id: str

StringIdField field

property inline_message_id: str

StringIdField field

property caption: str

StringField field

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.EditMessageReplyMarkupRequest(data=None, flat=False, *args, **kwargs)[source]

Edit message reply markup request model.

See also

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

property message_id: str

StringIdField field

property inline_message_id: str

StringIdField field

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.EditMessageTextRequest(data=None, flat=False, *args, **kwargs)[source]

Edit message text request model.

See also

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

property disable_web_page_preview: bool
Default value:False

BooleanField field

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property text: str

StringField field

property parse_mode: ParseMode
Default value:ParseMode.MODE_MARKDOWN

EnumField field (aiotelebot.messages.ParseMode)

property message_id: str

StringIdField field

property inline_message_id: str

StringIdField field

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.File(data=None, flat=False, *args, **kwargs)[source]

This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. 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 getFile.

Note

Maximum file size to download is 20 MB

See also

https://core.telegram.org/bots/api#file

property file_id: str

StringIdField field

property file_path: str

StringIdField field

property file_size: int

IntegerField field

Model aiotelebot.messages.FileMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin model with common fields for file attachments.

property mime_type: str

StringField field

property title: str

StringField field

Model aiotelebot.messages.FileModel(data=None, flat=False, *args, **kwargs)[source]

File model which contains an stream and some metadata avout stream.

classmethod from_filename(filename)[source]
property stream: None

StreamField field

property name: str

StringIdField field

property mime_type: str

StringIdField field

Model aiotelebot.messages.ForceReply(data=None, flat=False, *args, **kwargs)[source]

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply’). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

See also

https://core.telegram.org/bots/api#forcereply

property force_reply: bool
Default value:True

BooleanField field

property selective: bool
Default value:False

BooleanField field

Model aiotelebot.messages.GetChatAdministratorsRequest(data=None, flat=False, *args, **kwargs)[source]

Get chat administrators request model.

See also

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

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.GetChatCountRequest(data=None, flat=False, *args, **kwargs)[source]

Get chat count request model.

See also

https://core.telegram.org/bots/api#getchatmemberscount

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.GetChatMemberRequest(data=None, flat=False, *args, **kwargs)[source]

Get chat count request model.

See also

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

property user_id: int

IntegerField field

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.GetChatRequest(data=None, flat=False, *args, **kwargs)[source]

Get chat request model.

See also

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

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.GetFileRequest(data=None, flat=False, *args, **kwargs)[source]

Get file request model.

See also

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

property file_id: str

StringIdField field

Model aiotelebot.messages.GetUpdatesRequest(data=None, flat=False, *args, **kwargs)[source]

Get updates request model.

See also

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

property timeout: int

IntegerField field

property limit: int

IntegerField field

property offset: int

IntegerField field

Model aiotelebot.messages.GetUserProfilePhotoRequest(data=None, flat=False, *args, **kwargs)[source]

Get user profile photo request model.

See also

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

property user_id: str

StringIdField field

property limit: int
Default value:100

IntegerField field

property offset: int
Default value:0

IntegerField field

Model aiotelebot.messages.ImageMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin model with common fields for image attachments.

property height: int

IntegerField field

property width: int

IntegerField field

Model aiotelebot.messages.InlineKeyboardButton(data=None, flat=False, *args, **kwargs)[source]

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

See also

https://core.telegram.org/bots/api#inlinekeyboardbutton

property text: str

StringField field

property switch_inline_query: str

StringIdField field

property url: str

StringIdField field

property callback_data: str

StringIdField field

Model aiotelebot.messages.InlineKeyboardMarkup(data=None, flat=False, *args, **kwargs)[source]

This object represents an inline keyboard that appears right next to the message it belongs to.

Warning

Inline keyboards are currently being tested and are not available in channels yet. For now, feel free to use them in one-on-one chats or groups.

See also

https://core.telegram.org/bots/api#inlinekeyboardmarkup

property inline_keyboard: List of List of InlineKeyboardButton
Default value:[]

Array of Array of ModelField field (aiotelebot.messages.InlineKeyboardButton)

Model aiotelebot.messages.InlineQuery(data=None, flat=False, *args, **kwargs)[source]

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

See also

https://core.telegram.org/bots/api#inlinequery

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property location: Location

ModelField field (aiotelebot.messages.Location)

property query: str

StringField field

property offset: int

IntegerField field

property from: User

ModelField field (aiotelebot.messages.User)

Aliases:
  • inline_query_from
Model aiotelebot.messages.InlineQueryResultArticle(data=None, flat=False, *args, **kwargs)[source]

Represents a link to an article or web page.

See also

https://core.telegram.org/bots/api#inlinequeryresultarticle

property thumb_height: int

IntegerField field

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property type: str [READ ONLY]
Default value:Type.ARTICLE

StringIdField field [READ ONLY]

property thumb_url: str

StringIdField field

property url: str

StringIdField field

property description: str

StringField field

property thumb_width: int

IntegerField field

property title: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property hide_url: bool
Default value:False

BooleanField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.InlineQueryResultAudio(data=None, flat=False, *args, **kwargs)[source]

Represents a link to an mp3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

See also

https://core.telegram.org/bots/api#inlinequeryresultaudio

property type: str [READ ONLY]
Default value:Type.AUDIO

StringIdField field [READ ONLY]

property title: str

StringField field

property audio_url: str

StringIdField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property audio_duration: int

IntegerField field

property performer: str

StringIdField field

Model aiotelebot.messages.InlineQueryResultCachedAudio(data=None, flat=False, *args, **kwargs)[source]

Represents a link to an mp3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

See also

https://core.telegram.org/bots/api#inlinequeryresultcachedaudio

property type: str [READ ONLY]
Default value:Type.AUDIO

StringIdField field [READ ONLY]

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property audio_file_id: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property title: str

StringField field

Model aiotelebot.messages.InlineQueryResultCachedDocument(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only pdf-files and zip archives can be sent using this method.

See also

https://core.telegram.org/bots/api#inlinequeryresultcacheddocument

property type: str [READ ONLY]
Default value:Type.DOCUMENT

StringIdField field [READ ONLY]

property caption: str

StringField field

property description: str

StringField field

property title: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property document_file_id: str

StringIdField field

Model aiotelebot.messages.InlineQueryResultCachedGif(data=None, flat=False, *args, **kwargs)[source]

Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.

See also

https://core.telegram.org/bots/api#inlinequeryresultcachedgif

property type: str [READ ONLY]
Default value:Type.GIF

StringIdField field [READ ONLY]

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property gif_file_id: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property caption: str

StringField field

property title: str

StringField field

Model aiotelebot.messages.InlineQueryResultCachedMpeg4Gif(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

See also

https://core.telegram.org/bots/api#inlinequeryresultcachedmpeg4gif

property type: str [READ ONLY]
Default value:Type.MPEG4_GIF

StringIdField field [READ ONLY]

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property mpeg4_file_id: str

StringIdField field

property caption: str

StringField field

property title: str

StringField field

Model aiotelebot.messages.InlineQueryResultCachedPhoto(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

See also

https://core.telegram.org/bots/api#inlinequeryresultcachedphoto

property type: str [READ ONLY]
Default value:Type.PHOTO

StringIdField field [READ ONLY]

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property photo_file_id: str

StringIdField field

property description: str

StringField field

property title: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property caption: str

StringField field

Model aiotelebot.messages.InlineQueryResultCachedSticker(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.

See also

https://core.telegram.org/bots/api#inlinequeryresultcachedsticker

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property sticker_file_id: str

StringIdField field

property type: str [READ ONLY]
Default value:Type.STICKER

StringIdField field [READ ONLY]

Model aiotelebot.messages.InlineQueryResultCachedVideo(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

See also

https://core.telegram.org/bots/api#inlinequeryresultcachedvideo

property description: str

StringField field

property type: str [READ ONLY]
Default value:Type.VIDEO

StringIdField field [READ ONLY]

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property video_file_id: str

StringIdField field

property title: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property caption: str

StringField field

Model aiotelebot.messages.InlineQueryResultCachedVoice(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.

See also

https://core.telegram.org/bots/api#inlinequeryresultcachedvoice

property voice_file_id: str

StringIdField field

property type: str [READ ONLY]
Default value:Type.VOICE

StringIdField field [READ ONLY]

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property title: str

StringField field

Model aiotelebot.messages.InlineQueryResultContact(data=None, flat=False, *args, **kwargs)[source]

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

See also

https://core.telegram.org/bots/api#inlinequeryresultcontact

property last_name: str

StringField field

property thumb_height: int

IntegerField field

property phone_number: str

StringIdField field

property type: str [READ ONLY]
Default value:Type.CONTACT

StringIdField field [READ ONLY]

property thumb_url: str

StringIdField field

property thumb_width: int

IntegerField field

property first_name: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.InlineQueryResultDocument(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

See also

https://core.telegram.org/bots/api#inlinequeryresultdocument

property document_url: str

StringIdField field

property thumb_height: int

IntegerField field

property type: str [READ ONLY]
Default value:Type.DOCUMENT

StringIdField field [READ ONLY]

property thumb_url: str

StringIdField field

property caption: str

StringField field

property description: str

StringField field

property thumb_width: int

IntegerField field

property title: str

StringField field

property mime_type: str

StringIdField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.InlineQueryResultGif(data=None, flat=False, *args, **kwargs)[source]

Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

See also

https://core.telegram.org/bots/api#inlinequeryresultgif

property type: str [READ ONLY]
Default value:Type.GIF

StringIdField field [READ ONLY]

property gif_width: int

IntegerField field

property thumb_url: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property title: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property gif_height: int

IntegerField field

property gif_url: str

StringIdField field

property caption: str

StringField field

Model aiotelebot.messages.InlineQueryResultLocation(data=None, flat=False, *args, **kwargs)[source]

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.

See also

https://core.telegram.org/bots/api#inlinequeryresultlocation

property latitude: float

FloatField field

property thumb_height: int

IntegerField field

property type: str [READ ONLY]
Default value:Type.LOCATION

StringIdField field [READ ONLY]

property thumb_url: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property thumb_width: int

IntegerField field

property title: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property longitude: float

FloatField field

Model aiotelebot.messages.InlineQueryResultMpeg4Gif(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

See also

https://core.telegram.org/bots/api#inlinequeryresultmpeg4gif

property type: str [READ ONLY]
Default value:Type.MPEG4_GIF

StringIdField field [READ ONLY]

property thumb_url: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property mpeg4_width: int

IntegerField field

property title: str

StringField field

property mpeg4_height: int

IntegerField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property mpeg4_url: str

StringIdField field

property caption: str

StringField field

Model aiotelebot.messages.InlineQueryResultPhoto(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

See also

https://core.telegram.org/bots/api#inlinequeryresultphoto

property photo_height: int

IntegerField field

property type: str [READ ONLY]
Default value:Type.PHOTO

StringIdField field [READ ONLY]

property thumb_url: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property photo_width: int

IntegerField field

property description: str

StringField field

property title: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property photo_url: str

StringIdField field

property caption: str

StringField field

Model aiotelebot.messages.InlineQueryResultVenue(data=None, flat=False, *args, **kwargs)[source]

Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.

See also

https://core.telegram.org/bots/api#inlinequeryresultvenue

property latitude: float

FloatField field

property thumb_height: int

IntegerField field

property foursquare_id: str

StringIdField field

property type: str [READ ONLY]
Default value:Type.VENUE

StringIdField field [READ ONLY]

property thumb_url: str

StringIdField field

property longitude: float

FloatField field

property thumb_width: int

IntegerField field

property title: str

StringField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property address: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.InlineQueryResultVideo(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

See also

https://core.telegram.org/bots/api#inlinequeryresultvideo

property video_height: int

IntegerField field

property type: str [READ ONLY]
Default value:Type.VIDEO

StringIdField field [READ ONLY]

property video_url: str

StringIdField field

property thumb_url: str

StringIdField field

property caption: str

StringField field

property video_width: int

IntegerField field

property description: str

StringField field

property title: str

StringField field

property mime_type: str

StringIdField field

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property video_duration: int

IntegerField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.InlineQueryResultVoice(data=None, flat=False, *args, **kwargs)[source]

Represents a link to a voice recording in an .ogg container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.

See also

https://core.telegram.org/bots/api#inlinequeryresultvoice

property type: str [READ ONLY]
Default value:Type.VOICE

StringIdField field [READ ONLY]

property input_message_content: BaseInputMessageContent

ModelField field (aiotelebot.messages.BaseInputMessageContent)

property reply_markup: InlineKeyboardMarkup

ModelField field (aiotelebot.messages.InlineKeyboardMarkup)

property voice_duration: int

IntegerField field

property voice_url: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property title: str

StringField field

Model aiotelebot.messages.InputContactMessageContent(data=None, flat=False, *args, **kwargs)[source]

Represents the content of a contact message to be sent as the result of an inline query.

See also

https://core.telegram.org/bots/api#inputcontactmessagecontent

property first_name: str

StringField field

property last_name: str

StringField field

property phone_number: str

StringIdField field

Model aiotelebot.messages.InputLocationMessageContent(data=None, flat=False, *args, **kwargs)[source]

Represents the content of a location message to be sent as the result of an inline query.

See also

https://core.telegram.org/bots/api#inputlocationmessagecontent

property latitude: float

FloatField field

property longitude: float

FloatField field

Model aiotelebot.messages.InputTextMessageContent(data=None, flat=False, *args, **kwargs)[source]

Represents the content of a text message to be sent as the result of an inline query.

See also

https://core.telegram.org/bots/api#inputtextmessagecontent

property parse_mode: ParseMode
Default value:ParseMode.MODE_MARKDOWN

EnumField field (aiotelebot.messages.ParseMode)

property message_text: str

StringField field

property disable_web_page_preview: bool
Default value:False

BooleanField field

Model aiotelebot.messages.InputVenueMessageContent(data=None, flat=False, *args, **kwargs)[source]

Represents the content of a venue message to be sent as the result of an inline query.

See also

https://core.telegram.org/bots/api#inputvenuemessagecontent

property latitude: float

FloatField field

property longitude: float

FloatField field

property title: str

StringField field

property foursquare_id: str

StringIdField field

property address: str

StringIdField field

Model aiotelebot.messages.KeyboardButton(data=None, flat=False, *args, **kwargs)[source]

This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields are mutually exclusive.

See also

https://core.telegram.org/bots/api#keyboardbutton

property request_location: bool
Default value:False

BooleanField field

property request_contact: bool
Default value:False

BooleanField field

property text: str

StringField field

Model aiotelebot.messages.KickChatMemberRequest(data=None, flat=False, *args, **kwargs)[source]

Kick chat member request model.

See also

https://core.telegram.org/bots/api#kickchatmember

property user_id: str

StringIdField field

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.LeaveChatRequest(data=None, flat=False, *args, **kwargs)[source]

Leave chat request model.

See also

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

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.Location(data=None, flat=False, *args, **kwargs)[source]

This object represents a point on the map.

See also

https://core.telegram.org/bots/api#location

property latitude: float

FloatField field

property longitude: float

FloatField field

Model aiotelebot.messages.Message(data=None, flat=False, *args, **kwargs)[source]

This object represents a message.

See also

https://core.telegram.org/bots/api#message

property audio: Audio

ModelField field (aiotelebot.messages.Audio)

property new_chat_member: User

ModelField field (aiotelebot.messages.User)

property delete_chat_photo: bool

BooleanField field

property forward_from_chat: Chat

ModelField field (aiotelebot.messages.Chat)

property forward_from: User

ModelField field (aiotelebot.messages.User)

property message_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property channel_chat_created: bool

BooleanField field

property location: Location

ModelField field (aiotelebot.messages.Location)

property new_chat_title: str

StringField field

property video: Video

ModelField field (aiotelebot.messages.Video)

property date: datetime
Timezone:UTC+00:00

DateTimeField field

property photo: List of PhotoSize

Array of ModelField field (aiotelebot.messages.PhotoSize)

property group_chat_create: bool

BooleanField field

property sticker: Sticker

ModelField field (aiotelebot.messages.Sticker)

property pinned_message: Message

ModelField field (aiotelebot.messages.Message)

property voice: Voice

ModelField field (aiotelebot.messages.Voice)

property migrate_from_chat_id: int

IntegerField field

property document: Document

ModelField field (aiotelebot.messages.Document)

property text: str

StringField field

property entities: List of MessageEntity

Array of ModelField field (aiotelebot.messages.MessageEntity)

property migrate_to_chat_id: int

IntegerField field

property contact: Contact

ModelField field (aiotelebot.messages.Contact)

property left_chat_member: User

ModelField field (aiotelebot.messages.User)

property reply_to_message: Message

ModelField field (aiotelebot.messages.Message)

property forward_date: datetime
Timezone:UTC+00:00

DateTimeField field

property new_chat_photo: List of PhotoSize

Array of ModelField field (aiotelebot.messages.PhotoSize)

property from: User

ModelField field (aiotelebot.messages.User)

Aliases:
  • message_from
property supergroup_chat_created: bool

BooleanField field

property venue: Venue

ModelField field (aiotelebot.messages.Venue)

property edit_date: datetime
Timezone:UTC+00:00

DateTimeField field

property chat: Chat

ModelField field (aiotelebot.messages.Chat)

property caption: str

StringField field

Model aiotelebot.messages.MessageEntity(data=None, flat=False, *args, **kwargs)[source]

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

See also

https://core.telegram.org/bots/api#messageentity

property length: int

IntegerField field

property url: str

StringIdField field

property type: str

StringIdField field

property offset: int

IntegerField field

property user: User

ModelField field (aiotelebot.messages.User)

Model aiotelebot.messages.ParseModeMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin model with parse mode definition.

class ParseMode[source]

An enumeration.

MODE_HTML = 'HTML'
MODE_MARKDOWN = 'Markdown'
property parse_mode: ParseMode
Default value:ParseMode.MODE_MARKDOWN

EnumField field (aiotelebot.messages.ParseMode)

Model aiotelebot.messages.PersistentModel(data=None, flat=False, *args, **kwargs)[source]

Base model for entities with identifier.

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.PhotoSize(data=None, flat=False, *args, **kwargs)[source]

This object represents one size of a photo or a file / sticker thumbnail.

See also

https://core.telegram.org/bots/api#photosize

property height: int

IntegerField field

property file_id: str

StringIdField field

property width: int

IntegerField field

property file_size: int

IntegerField field

Model aiotelebot.messages.PreviewFileMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin model with common fields for file previews.

property thumb: PhotoSize

ModelField field (aiotelebot.messages.PhotoSize)

Model aiotelebot.messages.ReplyKeyboardHide(data=None, flat=False, *args, **kwargs)[source]

Upon receiving a message with this object, Telegram clients will hide the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).

See also

https://core.telegram.org/bots/api#replykeyboardhide

property selective: bool
Default value:False

BooleanField field

property hide_keyboard: bool
Default value:True

BooleanField field

Model aiotelebot.messages.ReplyKeyboardMarkup(data=None, flat=False, *args, **kwargs)[source]

This object represents a custom keyboard with reply options.

See also

https://core.telegram.org/bots/api#replykeyboardmarkup

property keyboard: List of List of KeyboardButton
Default value:[]

Array of Array of ModelField field (aiotelebot.messages.KeyboardButton)

property selective: bool
Default value:False

BooleanField field

property one_time_keyboard: bool
Default value:False

BooleanField field

property resize_keyboard: bool
Default value:False

BooleanField field

Model aiotelebot.messages.Response(data=None, flat=False, *args, **kwargs)[source]

Response model.

property result: anything

BlobField field

property description: str

StringField field

property error_code: int

IntegerField field

property ok: bool

BooleanField field

Model aiotelebot.messages.SendAudioRequest(data=None, flat=False, *args, **kwargs)[source]

Audio message request model.

See also

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

property audio: str or FileModel

Multiple type values are allowed:

property disable_notification: bool
Default value:False

BooleanField field

property reply_to_message_id: int

IntegerField field

property duration: int

IntegerField field

property title: str

StringField field

property performer: str

StringIdField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.SendChatActionRequest(data=None, flat=False, *args, **kwargs)[source]

Chat action request model.

See also

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

class Action[source]

An enumeration.

FIND_LOCATION = 'find_location'
RECORD_AUDIO = 'record_audio'
RECORD_VIDEO = 'record_video'
TYPING = 'typing'
UPLOAD_AUDIO = 'upload_audio'
UPLOAD_DOCUMENT = 'upload_document'
UPLOAD_PHOTO = 'upload_photo'
UPLOAD_VIDEO = 'upload_video'
property action: Action

EnumField field (aiotelebot.messages.Action)

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.SendContactRequest(data=None, flat=False, *args, **kwargs)[source]

Contact message request model.

See also

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

property first_name: str

StringField field

property last_name: str

StringField field

property reply_to_message_id: int

IntegerField field

property phone_number: str

StringIdField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property disable_notification: bool
Default value:False

BooleanField field

Model aiotelebot.messages.SendDocumentRequest(data=None, flat=False, *args, **kwargs)[source]

Document message request model.

See also

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

property document: str or FileModel

Multiple type values are allowed:

property reply_to_message_id: int

IntegerField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property caption: str

StringField field

property disable_notification: bool
Default value:False

BooleanField field

Model aiotelebot.messages.SendLocationRequest(data=None, flat=False, *args, **kwargs)[source]

Location message request model.

See also

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

property latitude: float

FloatField field

property reply_to_message_id: int

IntegerField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property longitude: float

FloatField field

property disable_notification: bool
Default value:False

BooleanField field

Model aiotelebot.messages.SendMessageRequest(data=None, flat=False, *args, **kwargs)[source]

Text message request model.

See also

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

property disable_web_page_preview: bool
Default value:False

BooleanField field

property reply_to_message_id: int

IntegerField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property text: str

StringField field

property parse_mode: ParseMode
Default value:ParseMode.MODE_MARKDOWN

EnumField field (aiotelebot.messages.ParseMode)

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property disable_notification: bool
Default value:False

BooleanField field

Model aiotelebot.messages.SendPhotoRequest(data=None, flat=False, *args, **kwargs)[source]

Photo message request model.

See also

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

property reply_to_message_id: int

IntegerField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property caption: str

StringField field

property photo: str or FileModel

Multiple type values are allowed:

property disable_notification: bool
Default value:False

BooleanField field

Model aiotelebot.messages.SendStickerRequest(data=None, flat=False, *args, **kwargs)[source]

Sticker message request model.

See also

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

property disable_notification: bool
Default value:False

BooleanField field

property reply_to_message_id: int

IntegerField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property sticker: str or FileModel

Multiple type values are allowed:

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.SendVenueRequest(data=None, flat=False, *args, **kwargs)[source]

Venue message request model.

See also

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

property latitude: float

FloatField field

property disable_notification: bool
Default value:False

BooleanField field

property reply_to_message_id: int

IntegerField field

property foursquare_id: str

StringIdField field

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property title: str

StringField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property address: str

StringIdField field

property longitude: float

FloatField field

Model aiotelebot.messages.SendVideoRequest(data=None, flat=False, *args, **kwargs)[source]

Video message request model.

See also

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

property reply_to_message_id: int

IntegerField field

property width: int

IntegerField field

property duration: int

IntegerField field

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property video: str or FileModel

Multiple type values are allowed:

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property height: int

IntegerField field

property disable_notification: bool
Default value:False

BooleanField field

property caption: str

StringField field

Model aiotelebot.messages.SendVoiceRequest(data=None, flat=False, *args, **kwargs)[source]

Voice message request model.

See also

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

property reply_to_message_id: int

IntegerField field

property reply_markup: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply

Multiple type values are allowed:

property duration: int

IntegerField field

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property voice: str or FileModel

Multiple type values are allowed:

property disable_notification: bool
Default value:False

BooleanField field

Model aiotelebot.messages.SetWebhookRequest(data=None, flat=False, *args, **kwargs)[source]

Set webhook request model.

See also

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

property url: str

StringIdField field

property certificate: FileModel

ModelField field (aiotelebot.messages.FileModel)

Model aiotelebot.messages.Sticker(data=None, flat=False, *args, **kwargs)[source]

This object represents a sticker.

See also

https://core.telegram.org/bots/api#sticker

property width: int

IntegerField field

property height: int

IntegerField field

property file_id: str

StringIdField field

property emoji: str

StringIdField field

property thumb: PhotoSize

ModelField field (aiotelebot.messages.PhotoSize)

property file_size: int

IntegerField field

class aiotelebot.messages.StreamField(name=None, alias=None, getter=None, setter=None, read_only=False, default=None, doc=None)[source]

Field type used to send streams (files) to Telegram.

can_use_value(value)[source]
check_value(value)[source]
convert_value(value)[source]
Model aiotelebot.messages.StreamMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin model with common fields for stream attachments.

property duration: int

IntegerField field

property mime_type: str

StringField field

property title: str

StringField field

Model aiotelebot.messages.ThumbMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin for inline query results with thumbnail image.

property thumb_url: str

StringIdField field

Model aiotelebot.messages.ThumbSizedMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin for inline query results with sized thumbnail image.

property thumb_url: str

StringIdField field

property thumb_height: int

IntegerField field

property thumb_width: int

IntegerField field

Model aiotelebot.messages.TitledMixin(data=None, flat=False, *args, **kwargs)[source]

Mixin for inline query results with title.

property title: str

StringField field

Model aiotelebot.messages.UnbanChatMemberRequest(data=None, flat=False, *args, **kwargs)[source]

Unban chat member request model.

See also

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

property user_id: str

StringIdField field

property chat_id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
Model aiotelebot.messages.Update(data=None, flat=False, *args, **kwargs)[source]

This object represents an incoming update.

Only one of the optional parameters can be present in any given update.

See also

https://core.telegram.org/bots/api#update

property inline_query: InlineQuery

ModelField field (aiotelebot.messages.InlineQuery)

property chose_inline_result: ChosenInlineResult

ModelField field (aiotelebot.messages.ChosenInlineResult)

property edited_message: Message

ModelField field (aiotelebot.messages.Message)

property callback_query: CallbackQuery

ModelField field (aiotelebot.messages.CallbackQuery)

property message: Message

ModelField field (aiotelebot.messages.Message)

property update_id: int

IntegerField field

Model aiotelebot.messages.User(data=None, flat=False, *args, **kwargs)[source]

This object represents a Telegram user or bot.

See also

https://core.telegram.org/bots/api#user

property first_name: str

StringIdField field

property last_name: str

StringIdField field

property id: int or str

Multiple type values are allowed:

  • IntegerField field
  • StringIdField field
property username: str

StringIdField field

Model aiotelebot.messages.UserProfilePhotos(data=None, flat=False, *args, **kwargs)[source]

This object represent a user’s profile pictures.

See also

https://core.telegram.org/bots/api#userprofilephotos

property total_count: int

IntegerField field

property photos: List of List of PhotoSize

Array of Array of ModelField field (aiotelebot.messages.PhotoSize)

Model aiotelebot.messages.Venue(data=None, flat=False, *args, **kwargs)[source]

This object represents a venue.

See also

https://core.telegram.org/bots/api#venue

property location: Location

ModelField field (aiotelebot.messages.Location)

property title: str

StringField field

property foursquare_id: str

StringIdField field

property address: str

StringIdField field

Model aiotelebot.messages.Video(data=None, flat=False, *args, **kwargs)[source]

This object represents a video file.

See also

https://core.telegram.org/bots/api#video

property width: int

IntegerField field

property duration: int

IntegerField field

property file_id: str

StringIdField field

property thumb: PhotoSize

ModelField field (aiotelebot.messages.PhotoSize)

property title: str

StringField field

property mime_type: str

StringField field

property height: int

IntegerField field

property file_size: int

IntegerField field

Model aiotelebot.messages.Voice(data=None, flat=False, *args, **kwargs)[source]

This object represents a voice note.

See also

https://core.telegram.org/bots/api#video

property duration: int

IntegerField field

property file_id: str

StringIdField field

property file_size: int

IntegerField field

property mime_type: str

StringField field

property title: str

StringField field