Types of API

class telebot.types.Animation(file_id, file_unique_id, width=None, height=None, duration=None, thumbnail=None, file_name=None, mime_type=None, file_size=None, **kwargs)

Bases: JsonDeserializable

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

Telegram Documentation: https://core.telegram.org/bots/api#animation

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• width (int) – Video width as defined by sender

• height (int) – Video height as defined by sender

• duration (int) – Duration of the video in seconds as defined by sender

• thumbnail (telebot.types.PhotoSize) – Optional. Animation thumbnail as defined by sender

• file_name (str) – Optional. Original animation filename as defined by sender

• mime_type (str) – Optional. MIME type of the file as defined by sender

• file_size (int) – Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

Returns:

Instance of the class

Return type:

telebot.types.Animation

property thumb

class telebot.types.Audio(file_id, file_unique_id, duration, performer=None, title=None, file_name=None, mime_type=None, file_size=None, thumbnail=None, **kwargs)

Bases: JsonDeserializable

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

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

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• duration (int) – Duration of the audio in seconds as defined by sender

• performer (str) – Optional. Performer of the audio as defined by sender or by audio tags

• title (str) – Optional. Title of the audio as defined by sender or by audio tags

• file_name (str) – Optional. Original filename as defined by sender

• mime_type (str) – Optional. MIME type of the file as defined by sender

• file_size (int) – Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

• thumbnail (telebot.types.PhotoSize) – Optional. Thumbnail of the album cover to which the music file belongs

Returns:

Instance of the class

Return type:

telebot.types.Audio

property thumb

class telebot.types.Birthdate(day, month, year=None, **kwargs)

Bases: JsonDeserializable

This object represents a user’s birthdate.

Telegram documentation: https://core.telegram.org/bots/api#birthdate

Parameters:

• day (int) – Day of the user’s birth; 1-31

• month (int) – Month of the user’s birth; 1-12

• year (int) – Optional. Year of the user’s birth

Returns:

Instance of the class

Return type:

Birthdate

class telebot.types.BotCommand(command, description, **kwargs)

Bases: JsonSerializable, JsonDeserializable, Dictionaryable

This object represents a bot command.

Telegram Documentation: https://core.telegram.org/bots/api#botcommand

Parameters:

• command (str) – Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.

• description (str) – Description of the command; 1-256 characters.

Returns:

Instance of the class

Return type:

telebot.types.BotCommand

class telebot.types.BotCommandScope(type='default', chat_id=None, user_id=None)

Bases: ABC, JsonSerializable

This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:

• BotCommandScopeDefault

• BotCommandScopeAllPrivateChats

• BotCommandScopeAllGroupChats

• BotCommandScopeAllChatAdministrators

• BotCommandScopeChat

• BotCommandScopeChatAdministrators

• BotCommandScopeChatMember

Determining list of commands The following algorithm is used to determine the list of commands for a particular user viewing the bot menu. The first list of commands which is set is returned:

Commands in the chat with the bot:

• BotCommandScopeChat + language_code

• BotCommandScopeChat

• BotCommandScopeAllPrivateChats + language_code

• BotCommandScopeAllPrivateChats

• BotCommandScopeDefault + language_code

• BotCommandScopeDefault

Commands in group and supergroup chats:

• BotCommandScopeChatMember + language_code

• BotCommandScopeChatMember

• BotCommandScopeChatAdministrators + language_code (administrators only)

• BotCommandScopeChatAdministrators (administrators only)

• BotCommandScopeChat + language_code

• BotCommandScopeChat

• BotCommandScopeAllChatAdministrators + language_code (administrators only)

• BotCommandScopeAllChatAdministrators (administrators only)

• BotCommandScopeAllGroupChats + language_code

• BotCommandScopeAllGroupChats

• BotCommandScopeDefault + language_code

• BotCommandScopeDefault

Returns:

Instance of the class

Return type:

telebot.types.BotCommandScope

class telebot.types.BotCommandScopeAllChatAdministrators

Bases: BotCommandScope

Represents the scope of bot commands, covering all group and supergroup chat administrators.

Telegram Documentation: https://core.telegram.org/bots/api#botcommandscopeallchatadministrators

Parameters:

type (str) – Scope type, must be all_chat_administrators

Returns:

Instance of the class

Return type:

telebot.types.BotCommandScopeAllChatAdministrators

class telebot.types.BotCommandScopeAllGroupChats

Bases: BotCommandScope

Represents the scope of bot commands, covering all group and supergroup chats.

Telegram Documentation: https://core.telegram.org/bots/api#botcommandscopeallgroupchats

Parameters:

type (str) – Scope type, must be all_group_chats

Returns:

Instance of the class

Return type:

telebot.types.BotCommandScopeAllGroupChats

class telebot.types.BotCommandScopeAllPrivateChats

Bases: BotCommandScope

Represents the scope of bot commands, covering all private chats.

Telegram Documentation: https://core.telegram.org/bots/api#botcommandscopeallprivatechats

Parameters:

type (str) – Scope type, must be all_private_chats

Returns:

Instance of the class

Return type:

telebot.types.BotCommandScopeAllPrivateChats

class telebot.types.BotCommandScopeChat(chat_id=None)

Bases: BotCommandScope

Represents the scope of bot commands, covering a specific chat.

Telegram Documentation: https://core.telegram.org/bots/api#botcommandscopechat

Parameters:

• type (str) – Scope type, must be chat

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

Returns:

Instance of the class

Return type:

telebot.types.BotCommandScopeChat

class telebot.types.BotCommandScopeChatAdministrators(chat_id=None)

Bases: BotCommandScope

Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.

Telegram Documentation: https://core.telegram.org/bots/api#botcommandscopechatadministrators

Parameters:

• type (str) – Scope type, must be chat_administrators

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

Returns:

Instance of the class

Return type:

telebot.types.BotCommandScopeChatAdministrators

class telebot.types.BotCommandScopeChatMember(chat_id=None, user_id=None)

Bases: BotCommandScope

Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

Telegram Documentation: https://core.telegram.org/bots/api#botcommandscopechatmember

Parameters:

• type (str) – Scope type, must be chat_member

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

• user_id (int) – Unique identifier of the target user

Returns:

Instance of the class

Return type:

telebot.types.BotCommandScopeChatMember

class telebot.types.BotCommandScopeDefault

Bases: BotCommandScope

Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.

Telegram Documentation: https://core.telegram.org/bots/api#botcommandscopedefault

Parameters:

type (str) – Scope type, must be default

Returns:

Instance of the class

Return type:

telebot.types.BotCommandScopeDefault

class telebot.types.BotDescription(description: str, **kwargs)

Bases: JsonDeserializable

This object represents a bot description.

Telegram documentation: https://core.telegram.org/bots/api#botdescription

Parameters:

description (str) – Bot description

Returns:

Instance of the class

Return type:

telebot.types.BotDescription

class telebot.types.BotName(name: str, **kwargs)

Bases: JsonDeserializable

This object represents a bot name.

Telegram Documentation: https://core.telegram.org/bots/api#botname

Parameters:

name (str) – The bot name

Returns:

Instance of the class

Return type:

BotName

class telebot.types.BotShortDescription(short_description: str, **kwargs)

Bases: JsonDeserializable

This object represents a bot short description.

Telegram documentation: https://core.telegram.org/bots/api#botshortdescription

Parameters:

short_description (str) – Bot short description

Returns:

Instance of the class

Return type:

telebot.types.BotShortDescription

class telebot.types.BusinessConnection(id, user, user_chat_id, date, can_reply, is_enabled, **kwargs)

Bases: JsonDeserializable

This object describes the connection of the bot with a business account.

Telegram documentation: https://core.telegram.org/bots/api#businessconnection

Parameters:

• id (str) – Unique identifier of the business connection

• user (User) – Business account user that created the business connection

• user_chat_id (int) – Identifier of a private chat with the user who created the business connection

• date (int) – Date the connection was established in Unix time

• can_reply (bool) – True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours

• is_enabled (bool) – True, if the connection is active

Returns:

Instance of the class

Return type:

BusinessConnection

class telebot.types.BusinessIntro(title=None, message=None, sticker=None, **kwargs)

Bases: JsonDeserializable

This object represents a business intro.

Telegram documentation: https://core.telegram.org/bots/api#businessintro

Parameters:

• title (str) – Optional. Title text of the business intro

• message (str) – Optional. Message text of the business intro

• sticker (Sticker) – Optional. Sticker of the business intro

Returns:

Instance of the class

Return type:

BusinessIntro

class telebot.types.BusinessLocation(address, location=None, **kwargs)

Bases: JsonDeserializable

This object represents a business location.

Telegram documentation: https://core.telegram.org/bots/api#businesslocation

Parameters:

• address (str) – Address of the business

• location (Location) – Optional. Location of the business

Returns:

Instance of the class

Return type:

BusinessLocation

class telebot.types.BusinessMessagesDeleted(business_connection_id, chat, message_ids, **kwargs)

Bases: JsonDeserializable

This object is received when messages are deleted from a connected business account.

Telegram documentation: https://core.telegram.org/bots/api#businessmessagesdeleted

Parameters:

• business_connection_id (str) – Unique identifier of the business connection

• chat (Chat) – Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.

• message_ids (list of int) – A JSON-serialized list of identifiers of deleted messages in the chat of the business account

Returns:

Instance of the class

Return type:

BusinessMessagesDeleted

class telebot.types.BusinessOpeningHours(time_zone_name, opening_hours, **kwargs)

Bases: JsonDeserializable

This object represents business opening hours.

Telegram documentation: https://core.telegram.org/bots/api#businessopeninghours

Parameters:

• time_zone_name (str) – Unique name of the time zone for which the opening hours are defined

• opening_hours (list of BusinessOpeningHoursInterval) – List of time intervals describing business opening hours

Returns:

Instance of the class

Return type:

BusinessOpeningHours

class telebot.types.BusinessOpeningHoursInterval(opening_minute, closing_minute, **kwargs)

Bases: JsonDeserializable

This object represents a business opening hours interval.

Telegram documentation: https://core.telegram.org/bots/api#businessopeninghoursinterval

Parameters:

• opening_minute (int) – The minute’s sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 24 60

• closing_minute (int) – The minute’s sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 24 60

Returns:

Instance of the class

Return type:

BusinessOpeningHoursInterval

class telebot.types.CallbackQuery(id, from_user, data, chat_instance, json_string, message=None, inline_message_id=None, game_short_name=None, **kwargs)

Bases: JsonDeserializable

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 present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

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

Parameters:

• id (str) – Unique identifier for this query

• from_user (telebot.types.User) – Sender

• message (telebot.types.Message or telebot.types.InaccessibleMessage) – Optional. Message sent by the bot with the callback button that originated the query

• inline_message_id (str) – Optional. Identifier of the message sent via the bot in inline mode, that originated the query.

• chat_instance (str) – Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.

• data (str) – Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.

• game_short_name (str) – Optional. Short name of a Game to be returned, serves as the unique identifier for the game

Returns:

Instance of the class

Return type:

telebot.types.CallbackQuery

class telebot.types.Chat(id, type, title=None, username=None, first_name=None, last_name=None, photo=None, bio=None, has_private_forwards=None, description=None, invite_link=None, pinned_message=None, permissions=None, slow_mode_delay=None, message_auto_delete_time=None, has_protected_content=None, sticker_set_name=None, can_set_sticker_set=None, linked_chat_id=None, location=None, join_to_send_messages=None, join_by_request=None, has_restricted_voice_and_video_messages=None, is_forum=None, active_usernames=None, emoji_status_custom_emoji_id=None, has_hidden_members=None, has_aggressive_anti_spam_enabled=None, emoji_status_expiration_date=None, available_reactions=None, accent_color_id=None, background_custom_emoji_id=None, profile_accent_color_id=None, profile_background_custom_emoji_id=None, has_visible_history=None, unrestrict_boost_count=None, custom_emoji_sticker_set_name=None, business_intro=None, business_location=None, business_opening_hours=None, personal_chat=None, birthdate=None, **kwargs)

Bases: JsonDeserializable

This object represents a chat.

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

Parameters:

• id (int) – Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

• type (str) – Type of chat, can be either “private”, “group”, “supergroup” or “channel”

• title (str) – Optional. Title, for supergroups, channels and group chats

• username (str) – Optional. Username, for private chats, supergroups and channels if available

• first_name (str) – Optional. First name of the other party in a private chat

• last_name (str) – Optional. Last name of the other party in a private chat

• is_forum (bool) – Optional. True, if the supergroup chat is a forum (has topics enabled)

• photo (telebot.types.ChatPhoto) – Optional. Chat photo. Returned only in getChat.

• active_usernames (list of str) – Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.

• birthdate (str) – Optional. Birthdate of the other party in a private chat. Returned only in getChat.

• business_intro (telebot.types.BusinessIntro) – Optional. Business intro for the chat. Returned only in getChat.

• business_location (telebot.types.BusinessLocation) – Optional. Business location for the chat. Returned only in getChat.

:param business_opening_hours : Optional. Business opening hours for the chat. Returned only in getChat. :type business_opening_hours: telebot.types.BusinessHours

Parameters:

• personal_chat (telebot.types.Chat) – Optional. For private chats, the personal channel of the user. Returned only in getChat.

• available_reactions (list of telebot.types.ReactionType) – Optional. List of available chat reactions; for private chats, supergroups and channels. Returned only in getChat.

• accent_color_id (int) – Optional. Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.

• background_custom_emoji_id (str) – Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat.

• profile_accent_color_id (int) – Optional. Identifier of the accent color for the chat’s profile background. See profile accent colors for more details. Returned only in getChat.

• profile_background_custom_emoji_id (str) – Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat.

• emoji_status_custom_emoji_id (str) – Optional. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.

• emoji_status_expiration_date (int) – Optional. Expiration date of the emoji status of the other party in a private chat, if any. Returned only in getChat.

• bio (str) – Optional. Bio of the other party in a private chat. Returned only in getChat.

• has_private_forwards (bool) – Optional. bool, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.

• has_restricted_voice_and_video_messages – Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.

:type bool

Parameters:

• join_to_send_messages (bool) – Optional. bool, if users need to join the supergroup before they can send messages. Returned only in getChat.

• join_by_request (bool) – Optional. bool, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.

• description (str) – Optional. Description, for groups, supergroups and channel chats. Returned only in getChat.

• invite_link (str) – Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.

• pinned_message (telebot.types.Message) – Optional. The most recent pinned message (by sending date). Returned only in getChat.

• permissions (telebot.types.ChatPermissions) – Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.

• slow_mode_delay (int) – Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.

• unrestrict_boost_count (int) – Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat.

• message_auto_delete_time (int) – Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.

• has_aggressive_anti_spam_enabled (bool) – Optional. bool, if the chat has enabled aggressive anti-spam protection. Returned only in getChat.

• has_hidden_members (bool) – Optional. bool, if the chat has enabled hidden members. Returned only in getChat.

• has_protected_content (bool) – Optional. bool, if messages from the chat can’t be forwarded to other chats. Returned only in getChat.

• has_visible_history (bool) – Optional. True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.

• sticker_set_name (str) – Optional. For supergroups, name of group sticker set. Returned only in getChat.

• can_set_sticker_set (bool) – Optional. bool, if the bot can change the group sticker set. Returned only in getChat.

• custom_emoji_sticker_set_name – Optional. For supergroups, the name of the group’s custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in getChat.

• custom_emoji_sticker_set_name – str

• linked_chat_id (int) – Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.

• location (telebot.types.ChatLocation) – Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.

Returns:

Instance of the class

Return type:

telebot.types.Chat

class telebot.types.ChatAdministratorRights(is_anonymous: bool, can_manage_chat: bool, can_delete_messages: bool, can_manage_video_chats: bool, can_restrict_members: bool, can_promote_members: bool, can_change_info: bool, can_invite_users: bool, can_post_messages: bool = None, can_edit_messages: bool = None, can_pin_messages: bool = None, can_manage_topics: bool = None, can_post_stories: bool = None, can_edit_stories: bool = None, can_delete_stories: bool = None, **kwargs)

Bases: JsonDeserializable, JsonSerializable, Dictionaryable

Represents the rights of an administrator in a chat.

Telegram Documentation: https://core.telegram.org/bots/api#chatadministratorrights

Parameters:

• is_anonymous (bool) – True, if the user’s presence in the chat is hidden

• can_manage_chat (bool) – 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_delete_messages (bool) – True, if the administrator can delete messages of other users

• can_manage_video_chats (bool) – True, if the administrator can manage video chats

• can_restrict_members (bool) – True, if the administrator can restrict, ban or unban chat members

• can_promote_members (bool) – 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 the user)

• can_change_info (bool) – True, if the user is allowed to change the chat title, photo and other settings

• can_invite_users (bool) – True, if the user is allowed to invite new users to the chat

• can_post_messages (bool) – Optional. True, if the administrator can post in the channel; channels only

• can_edit_messages (bool) – Optional. True, if the administrator can edit messages of other users and can pin messages; channels only

• can_pin_messages (bool) – Optional. True, if the user is allowed to pin messages; groups and supergroups only

• can_manage_topics (bool) – Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only

• can_post_stories (bool) – Optional. True, if the administrator can post channel stories

• can_edit_stories (bool) – Optional. True, if the administrator can edit stories

• can_delete_stories (bool) – Optional. True, if the administrator can delete stories of other users

Returns:

Instance of the class

Return type:

telebot.types.ChatAdministratorRights

class telebot.types.ChatBoost(boost_id, add_date, expiration_date, source, **kwargs)

Bases: JsonDeserializable

This object contains information about a chat boost.

Telegram documentation: https://core.telegram.org/bots/api#chatboost

Parameters:

• boost_id (str) – Unique identifier of the boost

• add_date (int) – Point in time (Unix timestamp) when the chat was boosted

• expiration_date (int) – Point in time (Unix timestamp) when the boost will automatically expire, unless the booster’s Telegram Premium subscription is prolonged

• source (ChatBoostSource) – Optional. Source of the added boost (made Optional for now due to API error)

Returns:

Instance of the class

Return type:

ChatBoost

class telebot.types.ChatBoostAdded(boost_count, **kwargs)

Bases: JsonDeserializable

This object represents a service message about a user boosting a chat.

Telegram documentation: https://core.telegram.org/bots/api#chatboostadded

Parameters:

boost_count (int) – Number of boosts added by the user

Returns:

Instance of the class

Return type:

ChatBoostAdded

class telebot.types.ChatBoostRemoved(chat, boost_id, remove_date, source, **kwargs)

Bases: JsonDeserializable

This object represents a boost removed from a chat.

Telegram documentation: https://core.telegram.org/bots/api#chatboostremoved

Parameters:

• chat (Chat) – Chat which was boosted

• boost_id (str) – Unique identifier of the boost

• remove_date (int) – Point in time (Unix timestamp) when the boost was removed

• source (ChatBoostSource) – Source of the removed boost

Returns:

Instance of the class

Return type:

ChatBoostRemoved

class telebot.types.ChatBoostSource

Bases: ABC, JsonDeserializable

This object describes the source of a chat boost. It can be one of

ChatBoostSourcePremium ChatBoostSourceGiftCode ChatBoostSourceGiveaway

Telegram documentation: https://core.telegram.org/bots/api#chatboostsource

Returns:

Instance of the class

Return type:

ChatBoostSourcePremium or ChatBoostSourceGiftCode or ChatBoostSourceGiveaway

class telebot.types.ChatBoostSourceGiftCode(source, user, **kwargs)

Bases: ChatBoostSource

The boost was obtained by the creation of Telegram Premium gift codes to boost a chat.

Telegram documentation: https://core.telegram.org/bots/api#chatboostsourcegiftcode

Parameters:

• source (str) – Source of the boost, always “gift_code”

• user (User) – User for which the gift code was created

Returns:

Instance of the class

Return type:

ChatBoostSourceGiftCode

class telebot.types.ChatBoostSourceGiveaway(source, giveaway_message_id, user=None, is_unclaimed=None, **kwargs)

Bases: ChatBoostSource

The boost was obtained by the creation of a Telegram Premium giveaway.

Telegram documentation: https://core.telegram.org/bots/api#chatboostsourcegiveaway

Parameters:

• source (str) – Source of the boost, always “giveaway”

• giveaway_message_id (int) – Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn’t sent yet.

• user (User) – User that won the prize in the giveaway if any

• is_unclaimed (bool) – True, if the giveaway was completed, but there was no user to win the prize

Returns:

Instance of the class

Return type:

ChatBoostSourceGiveaway

class telebot.types.ChatBoostSourcePremium(source, user, **kwargs)

Bases: ChatBoostSource

The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

Telegram documentation: https://core.telegram.org/bots/api#chatboostsourcepremium

Parameters:

• source (str) – Source of the boost, always “premium”

• user (User) – User that boosted the chat

Returns:

Instance of the class

Return type:

ChatBoostSourcePremium

class telebot.types.ChatBoostUpdated(chat, boost, **kwargs)

Bases: JsonDeserializable

This object represents a boost added to a chat or changed.

Telegram documentation: https://core.telegram.org/bots/api#chatboostupdated

Parameters:

• chat (Chat) – Chat which was boosted

• boost (ChatBoost) – Infomation about the chat boost

Returns:

Instance of the class

Return type:

ChatBoostUpdated

class telebot.types.ChatInviteLink(invite_link, creator, creates_join_request, is_primary, is_revoked, name=None, expire_date=None, member_limit=None, pending_join_request_count=None, **kwargs)

Bases: JsonSerializable, JsonDeserializable, Dictionaryable

Represents an invite link for a chat.

Telegram Documentation: https://core.telegram.org/bots/api#chatinvitelink

Parameters:

• invite_link (str) – The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.

• creator (telebot.types.User) – Creator of the link

• creates_join_request (bool) – True, if users joining the chat via the link need to be approved by chat administrators

• is_primary (bool) – True, if the link is primary

• is_revoked (bool) – True, if the link is revoked

• name (str) – Optional. Invite link name

• expire_date (int) – Optional. Point in time (Unix timestamp) when the link will expire or has been expired

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

• pending_join_request_count (int) – Optional. Number of pending join requests created using this link

Returns:

Instance of the class

Return type:

telebot.types.ChatInviteLink

class telebot.types.ChatJoinRequest(chat, from_user, user_chat_id, date, bio=None, invite_link=None, **kwargs)

Bases: JsonDeserializable

Represents a join request sent to a chat.

Telegram Documentation: https://core.telegram.org/bots/api#chatjoinrequest

Parameters:

• chat (telebot.types.Chat) – Chat to which the request was sent

• from_user (telebot.types.User) – User that sent the join request

• user_chat_id (int) – Optional. Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.

• date (int) – Date the request was sent in Unix time

• bio (str) – Optional. Bio of the user.

• invite_link (telebot.types.ChatInviteLink) – Optional. Chat invite link that was used by the user to send the join request

Returns:

Instance of the class

Return type:

telebot.types.ChatJoinRequest

class telebot.types.ChatLocation(location, address, **kwargs)

Bases: JsonSerializable, JsonDeserializable, Dictionaryable

Represents a location to which a chat is connected.

Telegram Documentation: https://core.telegram.org/bots/api#chatlocation

Parameters:

• location (telebot.types.Location) – The location to which the supergroup is connected. Can’t be a live location.

• address (str) – Location address; 1-64 characters, as defined by the chat owner

Returns:

Instance of the class

Return type:

telebot.types.ChatLocation

class telebot.types.ChatMember(user, status, custom_title=None, is_anonymous=None, can_be_edited=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_restrict_members=None, can_promote_members=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, is_member=None, can_send_messages=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_manage_chat=None, can_manage_video_chats=None, until_date=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, **kwargs)

Bases: JsonDeserializable

This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:

• telebot.types.ChatMemberOwner

• telebot.types.ChatMemberAdministrator

• telebot.types.ChatMemberMember

• telebot.types.ChatMemberRestricted

• telebot.types.ChatMemberLeft

• telebot.types.ChatMemberBanned

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

property can_manage_voice_chats

class telebot.types.ChatMemberAdministrator(user, status, custom_title=None, is_anonymous=None, can_be_edited=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_restrict_members=None, can_promote_members=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, is_member=None, can_send_messages=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_manage_chat=None, can_manage_video_chats=None, until_date=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, **kwargs)

Bases: ChatMember

Represents a chat member that has some additional privileges.

Telegram Documentation: https://core.telegram.org/bots/api#chatmemberadministrator

Parameters:

• status (str) – The member’s status in the chat, always “administrator”

• user (telebot.types.User) – Information about the user

• can_be_edited (bool) – True, if the bot is allowed to edit administrator privileges of that user

• is_anonymous (bool) – True, if the user’s presence in the chat is hidden

• can_manage_chat (bool) – 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_delete_messages (bool) – True, if the administrator can delete messages of other users

• can_manage_video_chats (bool) – True, if the administrator can manage video chats

• can_restrict_members (bool) – True, if the administrator can restrict, ban or unban chat members

• can_promote_members (bool) – 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 the user)

• can_change_info (bool) – True, if the user is allowed to change the chat title, photo and other settings

• can_invite_users (bool) – True, if the user is allowed to invite new users to the chat

• can_post_messages (bool) – Optional. True, if the administrator can post in the channel; channels only

• can_edit_messages (bool) – Optional. True, if the administrator can edit messages of other users and can pin messages; channels only

• can_pin_messages (bool) – Optional. True, if the user is allowed to pin messages; groups and supergroups only

• can_manage_topics (bool) – Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only

• custom_title (str) – Optional. Custom title for this user

• can_post_stories (bool) – Optional. True, if the administrator can post channel stories

• can_edit_stories (bool) – Optional. True, if the administrator can edit stories

• can_delete_stories (bool) – Optional. True, if the administrator can delete stories of other users

Returns:

Instance of the class

Return type:

telebot.types.ChatMemberAdministrator

class telebot.types.ChatMemberBanned(user, status, custom_title=None, is_anonymous=None, can_be_edited=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_restrict_members=None, can_promote_members=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, is_member=None, can_send_messages=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_manage_chat=None, can_manage_video_chats=None, until_date=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, **kwargs)

Bases: ChatMember

Represents a chat member that was banned in the chat and can’t return to the chat or view chat messages.

Telegram Documentation: https://core.telegram.org/bots/api#chatmemberbanned

Parameters:

• status (str) – The member’s status in the chat, always “kicked”

• user (telebot.types.User) – Information about the user

• until_date (int) – Date when restrictions will be lifted for this user; unix time. If 0, then the user is banned forever

Returns:

Instance of the class

Return type:

telebot.types.ChatMemberBanned

class telebot.types.ChatMemberLeft(user, status, custom_title=None, is_anonymous=None, can_be_edited=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_restrict_members=None, can_promote_members=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, is_member=None, can_send_messages=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_manage_chat=None, can_manage_video_chats=None, until_date=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, **kwargs)

Bases: ChatMember

Represents a chat member that isn’t currently a member of the chat, but may join it themselves.

Telegram Documentation: https://core.telegram.org/bots/api#chatmemberleft

Parameters:

• status (str) – The member’s status in the chat, always “left”

• user (telebot.types.User) – Information about the user

Returns:

Instance of the class

Return type:

telebot.types.ChatMemberLeft

class telebot.types.ChatMemberMember(user, status, custom_title=None, is_anonymous=None, can_be_edited=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_restrict_members=None, can_promote_members=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, is_member=None, can_send_messages=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_manage_chat=None, can_manage_video_chats=None, until_date=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, **kwargs)

Bases: ChatMember

Represents a chat member that has no additional privileges or restrictions.

Telegram Documentation: https://core.telegram.org/bots/api#chatmembermember

Parameters:

• status (str) – The member’s status in the chat, always “member”

• user (telebot.types.User) – Information about the user

Returns:

Instance of the class

Return type:

telebot.types.ChatMemberMember

class telebot.types.ChatMemberOwner(user, status, custom_title=None, is_anonymous=None, can_be_edited=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_restrict_members=None, can_promote_members=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, is_member=None, can_send_messages=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_manage_chat=None, can_manage_video_chats=None, until_date=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, **kwargs)

Bases: ChatMember

Represents a chat member that owns the chat and has all administrator privileges.

Telegram Documentation: https://core.telegram.org/bots/api#chatmemberowner

Parameters:

• status (str) – The member’s status in the chat, always “creator”

• user (telebot.types.User) – Information about the user

• is_anonymous (bool) – True, if the user’s presence in the chat is hidden

• custom_title (str) – Optional. Custom title for this user

Returns:

Instance of the class

Return type:

telebot.types.ChatMemberOwner

class telebot.types.ChatMemberRestricted(user, status, custom_title=None, is_anonymous=None, can_be_edited=None, can_post_messages=None, can_edit_messages=None, can_delete_messages=None, can_restrict_members=None, can_promote_members=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, is_member=None, can_send_messages=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_manage_chat=None, can_manage_video_chats=None, until_date=None, can_manage_topics=None, can_post_stories=None, can_edit_stories=None, can_delete_stories=None, **kwargs)

Bases: ChatMember

Represents a chat member that is under certain restrictions in the chat. Supergroups only.

Telegram Documentation: https://core.telegram.org/bots/api#chatmemberrestricted

Parameters:

• status (str) – The member’s status in the chat, always “restricted”

• user (telebot.types.User) – Information about the user

• is_member (bool) – True, if the user is a member of the chat at the moment of the request

• can_change_info (bool) – True, if the user is allowed to change the chat title, photo and other settings

• can_invite_users (bool) – True, if the user is allowed to invite new users to the chat

• can_pin_messages (bool) – True, if the user is allowed to pin messages

• can_manage_topics (bool) – True, if the user is allowed to create forum topics

• can_send_messages (bool) – True, if the user is allowed to send text messages, contacts, locations and venues

• can_send_audios (bool) – True, if the user is allowed to send audios

• can_send_documents (bool) – True, if the user is allowed to send documents

• can_send_photos (bool) – True, if the user is allowed to send photos

• can_send_videos (bool) – True, if the user is allowed to send videos

• can_send_video_notes (bool) – True, if the user is allowed to send video notes

• can_send_voice_notes (bool) – True, if the user is allowed to send voice notes

• can_send_polls (bool) – True, if the user is allowed to send polls

• can_send_other_messages (bool) – True, if the user is allowed to send animations, games, stickers and use inline bots

• can_add_web_page_previews (bool) – True, if the user is allowed to add web page previews to their messages

• until_date (int) – Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever

Returns:

Instance of the class

Return type:

telebot.types.ChatMemberRestricted

class telebot.types.ChatMemberUpdated(chat, from_user, date, old_chat_member, new_chat_member, invite_link=None, via_chat_folder_invite_link=None, **kwargs)

Bases: JsonDeserializable

This object represents changes in the status of a chat member.

Telegram Documentation: https://core.telegram.org/bots/api#chatmemberupdated

Parameters:

• chat (telebot.types.Chat) – Chat the user belongs to

• from_user (telebot.types.User) – Performer of the action, which resulted in the change

• date (int) – Date the change was done in Unix time

• old_chat_member (telebot.types.ChatMember) – Previous information about the chat member

• new_chat_member (telebot.types.ChatMember) – New information about the chat member

• invite_link (telebot.types.ChatInviteLink) – Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.

• via_chat_folder_invite_link (bool) – Optional. True, if the user joined the chat via a chat folder invite link

Returns:

Instance of the class

Return type:

telebot.types.ChatMemberUpdated

property difference: Dict[str, List]

Get the difference between old_chat_member and new_chat_member as a dict in the following format {‘parameter’: [old_value, new_value]} E.g {‘status’: [‘member’, ‘kicked’], ‘until_date’: [None, 1625055092]}

Returns:

Dict of differences

Return type:

Dict[str, List]

class telebot.types.ChatPermissions(can_send_messages=None, can_send_media_messages=None, can_send_audios=None, can_send_documents=None, can_send_photos=None, can_send_videos=None, can_send_video_notes=None, can_send_voice_notes=None, can_send_polls=None, can_send_other_messages=None, can_add_web_page_previews=None, can_change_info=None, can_invite_users=None, can_pin_messages=None, can_manage_topics=None, **kwargs)

Bases: JsonDeserializable, JsonSerializable, Dictionaryable

Describes actions that a non-administrator user is allowed to take in a chat.

Telegram Documentation: https://core.telegram.org/bots/api#chatpermissions

Parameters:

• can_send_messages (bool) – Optional. True, if the user is allowed to send text messages, contacts, locations and venues

• can_send_audios (bool) – Optional. True, if the user is allowed to send audios

• can_send_documents (bool) – Optional. True, if the user is allowed to send documents

• can_send_photos (bool) – Optional. True, if the user is allowed to send photos

• can_send_videos (bool) – Optional. True, if the user is allowed to send videos

• can_send_video_notes (bool) – Optional. True, if the user is allowed to send video notes

• can_send_voice_notes (bool) – Optional. True, if the user is allowed to send voice notes

• can_send_polls (bool) – Optional. True, if the user is allowed to send polls, implies can_send_messages

• can_send_other_messages (bool) – Optional. True, if the user is allowed to send animations, games, stickers and use inline bots

• can_add_web_page_previews (bool) – Optional. True, if the user is allowed to add web page previews to their messages

• can_change_info (bool) – Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups

• can_invite_users (bool) – Optional. True, if the user is allowed to invite new users to the chat

• can_pin_messages (bool) – Optional. True, if the user is allowed to pin messages. Ignored in public supergroups

• can_manage_topics (bool) – Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages

• can_send_media_messages (bool) – deprecated.

Returns:

Instance of the class

Return type:

telebot.types.ChatPermissions

class telebot.types.ChatPhoto(small_file_id, small_file_unique_id, big_file_id, big_file_unique_id, **kwargs)

Bases: JsonDeserializable

This object represents a chat photo.

Telegram Documentation: https://core.telegram.org/bots/api#chatphoto

Parameters:

• small_file_id (str) – File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.

• small_file_unique_id (str) – Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• big_file_id (str) – File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.

• big_file_unique_id (str) – Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

Returns:

Instance of the class

Return type:

telebot.types.ChatPhoto

class telebot.types.ChatShared(request_id: int, chat_id: int, title: str | None = None, photo: List[PhotoSize] | None = None, username: str | None = None, **kwargs)

Bases: JsonDeserializable

This object contains information about the chat whose identifier was shared with the bot using a telebot.types.KeyboardButtonRequestChat button.

Telegram documentation: https://core.telegram.org/bots/api#Chatshared

Parameters:

• request_id (int) – identifier of the request

• chat_id (int) – Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.

• title (str) – Optional. Title of the shared chat

• photo (list of telebot.types.PhotoSize) – Optional. Array of Photosize

• username (str) – Optional. Username of the shared chat

Returns:

Instance of the class

Return type:

telebot.types.ChatShared

class telebot.types.ChosenInlineResult(result_id, from_user, query, location=None, inline_message_id=None, **kwargs)

Bases: JsonDeserializable

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

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

Parameters:

• result_id (str) – The unique identifier for the result that was chosen

• from (telebot.types.User) – The user that chose the result

• location (telebot.types.Location) – Optional. Sender location, only for bots that require user location

• inline_message_id (str) – Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.

• query (str) – The query that was used to obtain the result

Returns:

Instance of the class

Return type:

telebot.types.ChosenInlineResult

class telebot.types.Contact(phone_number, first_name, last_name=None, user_id=None, vcard=None, **kwargs)

Bases: JsonDeserializable

This object represents a phone contact.

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

Parameters:

• phone_number (str) – Contact’s phone number

• first_name (str) – Contact’s first name

• last_name (str) – Optional. Contact’s last name

• user_id (int) – Optional. Contact’s user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

• vcard (str) – Optional. Additional data about the contact in the form of a vCard

Returns:

Instance of the class

Return type:

telebot.types.Contact

class telebot.types.Dice(value, emoji, **kwargs)

Bases: JsonSerializable, Dictionaryable, JsonDeserializable

This object represents an animated emoji that displays a random value.

Telegram Documentation: https://core.telegram.org/bots/api#dice

Parameters:

• emoji (str) – Emoji on which the dice throw animation is based

• value (int) – Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji

Returns:

Instance of the class

Return type:

telebot.types.Dice

class telebot.types.Dictionaryable

Bases: object

Subclasses of this class are guaranteed to be able to be converted to dictionary. All subclasses of this class must override to_dict.

class telebot.types.Document(file_id, file_unique_id, thumbnail=None, file_name=None, mime_type=None, file_size=None, **kwargs)

Bases: JsonDeserializable

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

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

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• thumbnail (telebot.types.PhotoSize) – Optional. Document thumbnail as defined by sender

• file_name (str) – Optional. Original filename as defined by sender

• mime_type (str) – Optional. MIME type of the file as defined by sender

• file_size (int) – Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

Returns:

Instance of the class

Return type:

telebot.types.Document

property thumb

class telebot.types.ExternalReplyInfo(origin: MessageOrigin, chat: Chat | None = None, message_id: int | None = None, link_preview_options: LinkPreviewOptions | None = None, animation: Animation | None = None, audio: Audio | None = None, document: Document | None = None, photo: List[PhotoSize] | None = None, sticker: Sticker | None = None, story: Story | None = None, video: Video | None = None, video_note: VideoNote | None = None, voice: Voice | None = None, has_media_spoiler: bool | None = None, contact: Contact | None = None, dice: Dice | None = None, game: Game | None = None, giveaway: Giveaway | None = None, giveaway_winners: GiveawayWinners | None = None, invoice: Invoice | None = None, location: Location | None = None, poll: Poll | None = None, venue: Venue | None = None, **kwargs)

Bases: JsonDeserializable

This object contains information about a message that is being replied to, which may come from another chat or forum topic.

Telegram documentation: https://core.telegram.org/bots/api#externalreplyinfo

Parameters:

• origin (MessageOrigin) – Origin of the message replied to by the given message

• chat (Chat) – Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel.

• message_id (int) – Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.

• link_preview_options (LinkPreviewOptions) – Optional. Options used for link preview generation for the original message, if it is a text message

• animation (Animation) – Optional. Message is an animation, information about the animation

• audio (Audio) – Optional. Message is an audio file, information about the file

• document (Document) – Optional. Message is a general file, information about the file

• photo (list of PhotoSize) – Optional. Message is a photo, available sizes of the photo

• sticker (Sticker) – Optional. Message is a sticker, information about the sticker

• story (Story) – Optional. Message is a forwarded story

• video (Video) – Optional. Message is a video, information about the video

• video_note (VideoNote) – Optional. Message is a video note, information about the video message

• voice (Voice) – Optional. Message is a voice message, information about the file

• has_media_spoiler (bool) – Optional. True, if the message media is covered by a spoiler animation

• contact (Contact) – Optional. Message is a shared contact, information about the contact

• dice (Dice) – Optional. Message is a dice with random value

• game (Game) – Optional. Message is a game, information about the game. More about games »

• giveaway (Giveaway) – Optional. Message is a scheduled giveaway, information about the giveaway

• giveaway_winners (GiveawayWinners) – Optional. A giveaway with public winners was completed

• invoice (Invoice) – Optional. Message is an invoice for a payment, information about the invoice. More about payments »

• location (Location) – Optional. Message is a shared location, information about the location

• poll (Poll) – Optional. Message is a native poll, information about the poll

• venue (Venue) – Optional. Message is a venue, information about the venue

Returns:

Instance of the class

Return type:

ExternalReplyInfo

class telebot.types.File(file_id, file_unique_id, file_size=None, file_path=None, **kwargs)

Bases: JsonDeserializable

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.

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

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• file_size (int) – Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

• file_path (str) – Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.

Returns:

Instance of the class

Return type:

telebot.types.File

class telebot.types.ForceReply(selective: bool | None = None, input_field_placeholder: str | None = None)

Bases: JsonSerializable

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.

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

Parameters:

• force_reply (bool) – Shows reply interface to the user, as if they manually selected the bot’s message and tapped ‘Reply’

• input_field_placeholder (str) – Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters

• selective (bool) – Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply to a message in the same chat and forum topic, sender of the original message.

Returns:

Instance of the class

Return type:

telebot.types.ForceReply

class telebot.types.ForumTopic(message_thread_id: int, name: str, icon_color: int, icon_custom_emoji_id: str | None = None, **kwargs)

Bases: JsonDeserializable

This object represents a forum topic.

Telegram documentation: https://core.telegram.org/bots/api#forumtopic

Parameters:

• message_thread_id (int) – Unique identifier of the forum topic

• name (str) – Name of the topic

• icon_color (int) – Color of the topic icon in RGB format

• icon_custom_emoji_id (str) – Optional. Unique identifier of the custom emoji shown as the topic icon

Returns:

Instance of the class

Return type:

telebot.types.ForumTopic

class telebot.types.ForumTopicClosed

Bases: JsonDeserializable

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

Telegram documentation: https://core.telegram.org/bots/api#forumtopicclosed

class telebot.types.ForumTopicCreated(name: str, icon_color: int, icon_custom_emoji_id: str | None = None, **kwargs)

Bases: JsonDeserializable

This object represents a service message about a new forum topic created in the chat.

Telegram documentation: https://core.telegram.org/bots/api#forumtopiccreated

Parameters:

• name (str) – Name of the topic

• icon_color (int) – Color of the topic icon in RGB format

• icon_custom_emoji_id (str) – Optional. Unique identifier of the custom emoji shown as the topic icon

Returns:

Instance of the class

Return type:

telebot.types.ForumTopicCreated

class telebot.types.ForumTopicEdited(name: str | None = None, icon_custom_emoji_id: str | None = None, **kwargs)

Bases: JsonDeserializable

This object represents a service message about an edited forum topic.

Telegram documentation: https://core.telegram.org/bots/api#forumtopicedited

Parameters:

• name (str) – Optional, Name of the topic(if updated)

• icon_custom_emoji_id (str) – Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed

class telebot.types.ForumTopicReopened

Bases: JsonDeserializable

This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

Telegram documentation: https://core.telegram.org/bots/api#forumtopicreopened

class telebot.types.Game(title, description, photo, text=None, text_entities=None, animation=None, **kwargs)

Bases: JsonDeserializable

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

Telegram Documentation: https://core.telegram.org/bots/api#game

Parameters:

• title (str) – Title of the game

• description (str) – Description of the game

• photo (list of telebot.types.PhotoSize) – Photo that will be displayed in the game message in chats.

• text (str) – Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.

• text_entities (list of telebot.types.MessageEntity) – Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.

• animation (telebot.types.Animation) – Optional. Animation that will be displayed in the game message in chats. Upload via BotFather

Returns:

Instance of the class

Return type:

telebot.types.Game

classmethod parse_entities(message_entity_array)

Parse the message entity array into a list of MessageEntity objects

classmethod parse_photo(photo_size_array)

Parse the photo array into a list of PhotoSize objects

class telebot.types.GameHighScore(position, user, score, **kwargs)

Bases: JsonDeserializable

This object represents one row of the high scores table for a game.

Telegram Documentation: https://core.telegram.org/bots/api#gamehighscore

Parameters:

• position (int) – Position in high score table for the game

• user (telebot.types.User) – User

• score (int) – Score

Returns:

Instance of the class

Return type:

telebot.types.GameHighScore

class telebot.types.GeneralForumTopicHidden

Bases: JsonDeserializable

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

Telegram documentation: https://core.telegram.org/bots/api#generalforumtopichidden

class telebot.types.GeneralForumTopicUnhidden

Bases: JsonDeserializable

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

Telegram documentation: https://core.telegram.org/bots/api#generalforumtopicunhidden

class telebot.types.Giveaway(chats: List[Chat], winners_selection_date: int, winner_count: int, only_new_members: bool | None = None, has_public_winners: bool | None = None, prize_description: str | None = None, country_codes: List[str] | None = None, premium_subscription_month_count: int | None = None, **kwargs)

Bases: JsonDeserializable

This object represents a message about a scheduled giveaway.

Telegram documentation: https://core.telegram.org/bots/api#giveaway

Parameters:

• chats (list of Chat) – The list of chats which the user must join to participate in the giveaway

• winners_selection_date (int) – Point in time (Unix timestamp) when winners of the giveaway will be selected

• winner_count (int) – The number of users which are supposed to be selected as winners of the giveaway

• only_new_members (bool) – Optional. True, if only users who join the chats after the giveaway started should be eligible to win

• has_public_winners (bool) – Optional. True, if the list of giveaway winners will be visible to everyone

• prize_description (str) – Optional. Description of additional giveaway prize

• country_codes (list of str) – Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway.

• premium_subscription_month_count (int) – Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for

Returns:

Instance of the class

Return type:

Giveaway

class telebot.types.GiveawayCompleted(winner_count: int, unclaimed_prize_count: int | None = None, giveaway_message: Message | None = None, **kwargs)

Bases: JsonDeserializable

This object represents a service message about the completion of a giveaway without public winners.

Telegram documentation: https://core.telegram.org/bots/api#giveawaycompleted

Parameters:

• winner_count (int) – Number of winners in the giveaway

• unclaimed_prize_count (int) – Optional. Number of undistributed prizes

• giveaway_message (Message) – Optional. Message with the giveaway that was completed, if it wasn’t deleted

Returns:

Instance of the class

Return type:

GiveawayCompleted

class telebot.types.GiveawayCreated(**kwargs)

Bases: JsonDeserializable

This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.

class telebot.types.GiveawayWinners(chat: Chat, giveaway_message_id: int, winners_selection_date: int, winner_count: int, winners: List[User], additional_chat_count: int | None = None, premium_subscription_month_count: int | None = None, unclaimed_prize_count: int | None = None, only_new_members: bool | None = None, was_refunded: bool | None = None, prize_description: str | None = None, **kwargs)

Bases: JsonDeserializable

This object represents a message about the completion of a giveaway with public winners.

Telegram documentation: https://core.telegram.org/bots/api#giveawaywinners

Parameters:

• chat (Chat) – The chat that created the giveaway

• giveaway_message_id (int) – Identifier of the messsage with the giveaway in the chat

• winners_selection_date (int) – Point in time (Unix timestamp) when winners of the giveaway were selected

• winner_count (int) – Total number of winners in the giveaway

• winners (list of User) – List of up to 100 winners of the giveaway

• additional_chat_count (int) – Optional. The number of other chats the user had to join in order to be eligible for the giveaway

• premium_subscription_month_count (int) – Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for

• unclaimed_prize_count (int) – Optional. Number of undistributed prizes

• only_new_members (bool) – Optional. True, if only users who had joined the chats after the giveaway started were eligible to win

• was_refunded (bool) – Optional. True, if the giveaway was canceled because the payment for it was refunded

• prize_description (str) – Optional. Description of additional giveaway prize

Returns:

Instance of the class

Return type:

GiveawayWinners

class telebot.types.InaccessibleMessage(chat, message_id, date, **kwargs)

Bases: JsonDeserializable

This object describes a message that was deleted or is otherwise inaccessible to the bot.

Telegram documentation: https://core.telegram.org/bots/api#inaccessiblemessage

Parameters:

• chat (Chat) – Chat the message belonged to

• message_id (int) – Unique message identifier inside the chat

• date (int) – Always 0. The field can be used to differentiate regular and inaccessible messages.

Returns:

Instance of the class

Return type:

InaccessibleMessage

class telebot.types.InlineKeyboardButton(text, url=None, callback_data=None, web_app=None, switch_inline_query=None, switch_inline_query_current_chat=None, switch_inline_query_chosen_chat=None, callback_game=None, pay=None, login_url=None, **kwargs)

Bases: Dictionaryable, JsonSerializable, JsonDeserializable

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

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

Parameters:

• text (str) – Label text on the button

• url (str) – Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.

• callback_data (str) – Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes

• web_app (telebot.types.WebAppInfo) – Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.

• login_url (telebot.types.LoginUrl) – Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.

• switch_inline_query (str) – Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot’s username and the specified inline query in the input field. May be empty, in which case just the bot’s username will be inserted.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.

• switch_inline_query_current_chat (str) – Optional. If set, pressing the button will insert the bot’s username and the specified inline query in the current chat’s input field. May be empty, in which case only the bot’s username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.

• switch_inline_query_chosen_chat (telebot.types.SwitchInlineQueryChosenChat) – Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot’s username and the specified inline query in the input field

• callback_game (telebot.types.CallbackGame) – Optional. Description of the game that will be launched when the user presses the button. NOTE: This type of button must always be the first button in the first row.

• pay (bool) – Optional. Specify True, to send a Pay button. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.

Returns:

Instance of the class

Return type:

telebot.types.InlineKeyboardButton

class telebot.types.InlineKeyboardMarkup(keyboard=None, row_width=3)

Bases: Dictionaryable, JsonSerializable, JsonDeserializable

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

Note

It is recommended to use telebot.util.quick_markup() instead.

Example of a custom keyboard with buttons.

from telebot.util import quick_markup

markup = quick_markup({
    'Twitter': {'url': 'https://twitter.com'},
    'Facebook': {'url': 'https://facebook.com'},
    'Back': {'callback_data': 'whatever'}
}, row_width=2)
# returns an InlineKeyboardMarkup with two buttons in a row, one leading to Twitter, the other to facebook
# and a back button below

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

Parameters:

• keyboard (list of list of telebot.types.InlineKeyboardButton) – list of button rows, each represented by an list of telebot.types.InlineKeyboardButton objects

• row_width (int) – number of telebot.types.InlineKeyboardButton objects on each row

Returns:

Instance of the class

Return type:

telebot.types.InlineKeyboardMarkup

add(*args, row_width=None)

This method adds buttons to the keyboard without exceeding row_width.

E.g. InlineKeyboardMarkup.add(“A”, “B”, “C”) yields the json result: {keyboard: [[“A”], [“B”], [“C”]]} when row_width is set to 1. When row_width is set to 2, the result: {keyboard: [[“A”, “B”], [“C”]]} See https://core.telegram.org/bots/api#inlinekeyboardmarkup

Parameters:

• args (list of telebot.types.InlineKeyboardButton) – Array of InlineKeyboardButton to append to the keyboard

• row_width (int) – width of row

Returns:

self, to allow function chaining.

Return type:

telebot.types.InlineKeyboardMarkup

max_row_keys = 8

row(*args)

Adds a list of InlineKeyboardButton to the keyboard. This method does not consider row_width.

InlineKeyboardMarkup.row(“A”).row(“B”, “C”).to_json() outputs: ‘{keyboard: [[“A”], [“B”, “C”]]}’ See https://core.telegram.org/bots/api#inlinekeyboardmarkup

Parameters:

args (list of telebot.types.InlineKeyboardButton) – Array of InlineKeyboardButton to append to the keyboard

Returns:

self, to allow function chaining.

Return type:

telebot.types.InlineKeyboardMarkup

class telebot.types.InlineQuery(id, from_user, query, offset, chat_type=None, location=None, **kwargs)

Bases: JsonDeserializable

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

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

Parameters:

• id (str) – Unique identifier for this query

• from_user (telebot.types.User) – Sender

• query (str) – Text of the query (up to 256 characters)

• offset (str) – Offset of the results to be returned, can be controlled by the bot

• chat_type (str) – Optional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat

• location (telebot.types.Location) – Optional. Sender location, only for bots that request user location

Returns:

Instance of the class

Return type:

telebot.types.InlineQuery

class telebot.types.InlineQueryResultArticle(id, title, input_message_content, reply_markup=None, url=None, hide_url=None, description=None, thumbnail_url=None, thumbnail_width=None, thumbnail_height=None)

Bases: InlineQueryResultBase

Represents a link to an article or web page.

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

Parameters:

• type (str) – Type of the result, must be article

• id (str) – Unique identifier for this result, 1-64 Bytes

• title (str) – Title of the result

• input_message_content (telebot.types.InputMessageContent) – Content of the message to be sent

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• url (str) – Optional. URL of the result

• hide_url (bool) – Optional. Pass True, if you don’t want the URL to be shown in the message

• description (str) – Optional. Short description of the result

• thumbnail_url (str) – Optional. Url of the thumbnail for the result

• thumbnail_width (int) – Optional. Thumbnail width

• thumbnail_height (int) – Optional. Thumbnail height

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultArticle

property thumb_height

property thumb_url

property thumb_width

class telebot.types.InlineQueryResultAudio(id, audio_url, title, caption=None, caption_entities=None, parse_mode=None, performer=None, audio_duration=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be audio

• id (str) – Unique identifier for this result, 1-64 bytes

• audio_url (str) – A valid URL for the audio file

• title (str) – Title

• caption (str) – Optional. Caption, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• performer (str) – Optional. Performer

• audio_duration (int) – Optional. Audio duration in seconds

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the audio

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultAudio

class telebot.types.InlineQueryResultBase(type, id, title=None, caption=None, input_message_content=None, reply_markup=None, caption_entities=None, parse_mode=None)

Bases: ABC, Dictionaryable, JsonSerializable

This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:

• InlineQueryResultCachedAudio

• InlineQueryResultCachedDocument

• InlineQueryResultCachedGif

• InlineQueryResultCachedMpeg4Gif

• InlineQueryResultCachedPhoto

• InlineQueryResultCachedSticker

• InlineQueryResultCachedVideo

• InlineQueryResultCachedVoice

• InlineQueryResultArticle

• InlineQueryResultAudio

• InlineQueryResultContact

• InlineQueryResultGame

• InlineQueryResultDocument

• InlineQueryResultGif

• InlineQueryResultLocation

• InlineQueryResultMpeg4Gif

• InlineQueryResultPhoto

• InlineQueryResultVenue

• InlineQueryResultVideo

• InlineQueryResultVoice

Telegram Documentation: https://core.telegram.org/bots/api#inlinequeryresult

class telebot.types.InlineQueryResultCachedAudio(id, audio_file_id, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultCachedBase

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.

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

Parameters:

• type (str) – Type of the result, must be audio

• id (str) – Unique identifier for this result, 1-64 bytes

• audio_file_id (str) – A valid file identifier for the audio file

• caption (str) – Optional. Caption, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the audio

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultCachedAudio

class telebot.types.InlineQueryResultCachedBase

Bases: ABC, JsonSerializable

Base class of all InlineQueryResultCached* classes.

class telebot.types.InlineQueryResultCachedDocument(id, document_file_id, title, description=None, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultCachedBase

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.

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

Parameters:

• type (str) – Type of the result, must be document

• id (str) – Unique identifier for this result, 1-64 bytes

• title (str) – Title for the result

• document_file_id (str) – A valid file identifier for the file

• description (str) – Optional. Short description of the result

• caption (str) – Optional. Caption of the document to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the document caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the file

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultCachedDocument

class telebot.types.InlineQueryResultCachedGif(id, gif_file_id, title=None, description=None, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultCachedBase

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.

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

Parameters:

• type (str) – Type of the result, must be gif

• id (str) – Unique identifier for this result, 1-64 bytes

• gif_file_id (str) – A valid file identifier for the GIF file

• title (str) – Optional. Title for the result

• caption (str) – Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the GIF animation

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultCachedGif

class telebot.types.InlineQueryResultCachedMpeg4Gif(id, mpeg4_file_id, title=None, description=None, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultCachedBase

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.

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

Parameters:

• type (str) – Type of the result, must be mpeg4_gif

• id (str) – Unique identifier for this result, 1-64 bytes

• mpeg4_file_id (str) – A valid file identifier for the MPEG4 file

• title (str) – Optional. Title for the result

• caption (str) – Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the video animation

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultCachedMpeg4Gif

class telebot.types.InlineQueryResultCachedPhoto(id, photo_file_id, title=None, description=None, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultCachedBase

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.

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

Parameters:

• type (str) – Type of the result, must be photo

• id (str) – Unique identifier for this result, 1-64 bytes

• photo_file_id (str) – A valid file identifier of the photo

• title (str) – Optional. Title for the result

• description (str) – Optional. Short description of the result

• caption (str) – Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the photo caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the photo

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultCachedPhoto

class telebot.types.InlineQueryResultCachedSticker(id, sticker_file_id, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultCachedBase

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.

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

Parameters:

• type (str) – Type of the result, must be sticker

• id (str) – Unique identifier for this result, 1-64 bytes

• sticker_file_id (str) – A valid file identifier of the sticker

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the sticker

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultCachedSticker

class telebot.types.InlineQueryResultCachedVideo(id, video_file_id, title, description=None, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultCachedBase

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.

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

Parameters:

• type (str) – Type of the result, must be video

• id (str) – Unique identifier for this result, 1-64 bytes

• video_file_id (str) – A valid file identifier for the video file

• title (str) – Title for the result

• description (str) – Optional. Short description of the result

• caption (str) – Optional. Caption of the video to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the video caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the video

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultCachedVideo

class telebot.types.InlineQueryResultCachedVoice(id, voice_file_id, title, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultCachedBase

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.

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

Parameters:

• type (str) – Type of the result, must be voice

• id (str) – Unique identifier for this result, 1-64 bytes

• voice_file_id (str) – A valid file identifier for the voice message

• title (str) – Voice message title

• caption (str) – Optional. Caption, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the voice message

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultCachedVoice

class telebot.types.InlineQueryResultContact(id, phone_number, first_name, last_name=None, vcard=None, reply_markup=None, input_message_content=None, thumbnail_url=None, thumbnail_width=None, thumbnail_height=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be contact

• id (str) – Unique identifier for this result, 1-64 Bytes

• phone_number (str) – Contact’s phone number

• first_name (str) – Contact’s first name

• last_name (str) – Optional. Contact’s last name

• vcard (str) – Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the contact

• thumbnail_url (str) – Optional. Url of the thumbnail for the result

• thumbnail_width (int) – Optional. Thumbnail width

• thumbnail_height (int) – Optional. Thumbnail height

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultContact

property thumb_height

property thumb_url

property thumb_width

class telebot.types.InlineQueryResultDocument(id, title, document_url, mime_type, caption=None, caption_entities=None, parse_mode=None, description=None, reply_markup=None, input_message_content=None, thumbnail_url=None, thumbnail_width=None, thumbnail_height=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be document

• id (str) – Unique identifier for this result, 1-64 bytes

• title (str) – Title for the result

• caption (str) – Optional. Caption of the document to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the document caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• document_url (str) – A valid URL for the file

• mime_type (str) – MIME type of the content of the file, either “application/pdf” or “application/zip”

• description (str) – Optional. Short description of the result

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the file

• thumbnail_url (str) – Optional. URL of the thumbnail (JPEG only) for the file

• thumbnail_width (int) – Optional. Thumbnail width

• thumbnail_height (int) – Optional. Thumbnail height

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultDocument

property thumb_height

property thumb_url

property thumb_width

class telebot.types.InlineQueryResultGame(id, game_short_name, reply_markup=None)

Bases: InlineQueryResultBase

Represents a Game.

Telegram Documentation: https://core.telegram.org/bots/api#inlinequeryresultgame

Parameters:

• type (str) – Type of the result, must be game

• id (str) – Unique identifier for this result, 1-64 bytes

• game_short_name (str) – Short name of the game

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultGame

class telebot.types.InlineQueryResultGif(id, gif_url, thumbnail_url, gif_width=None, gif_height=None, title=None, caption=None, caption_entities=None, reply_markup=None, input_message_content=None, gif_duration=None, parse_mode=None, thumbnail_mime_type=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be gif

• id (str) – Unique identifier for this result, 1-64 bytes

• gif_url (str) – A valid URL for the GIF file. File size must not exceed 1MB

• gif_width (int) – Optional. Width of the GIF

• gif_height (int) – Optional. Height of the GIF

• gif_duration (int) – Optional. Duration of the GIF in seconds

• thumbnail_url (str) – URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result

• thumbnail_mime_type (str) – Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”

• title (str) – Optional. Title for the result

• caption (str) – Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the GIF animation

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultGif

property thumb_mime_type

property thumb_url

class telebot.types.InlineQueryResultLocation(id, title, latitude, longitude, horizontal_accuracy, live_period=None, reply_markup=None, input_message_content=None, thumbnail_url=None, thumbnail_width=None, thumbnail_height=None, heading=None, proximity_alert_radius=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be location

• id (str) – Unique identifier for this result, 1-64 Bytes

• latitude (float number) – Location latitude in degrees

• longitude (float number) – Location longitude in degrees

• title (str) – Location title

• horizontal_accuracy (float number) – Optional. The radius of uncertainty for the location, measured in meters; 0-1500

• live_period (int) – Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

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

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

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the location

• thumbnail_url (str) – Optional. Url of the thumbnail for the result

• thumbnail_width (int) – Optional. Thumbnail width

• thumbnail_height (int) – Optional. Thumbnail height

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultLocation

property thumb_height

property thumb_url

property thumb_width

class telebot.types.InlineQueryResultMpeg4Gif(id, mpeg4_url, thumbnail_url, mpeg4_width=None, mpeg4_height=None, title=None, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None, mpeg4_duration=None, thumbnail_mime_type=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be mpeg4_gif

• id (str) – Unique identifier for this result, 1-64 bytes

• mpeg4_url (str) – A valid URL for the MPEG4 file. File size must not exceed 1MB

• mpeg4_width (int) – Optional. Video width

• mpeg4_height (int) – Optional. Video height

• mpeg4_duration (int) – Optional. Video duration in seconds

• thumbnail_url (str) – URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result

• thumbnail_mime_type (str) – Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”

• title (str) – Optional. Title for the result

• caption (str) – Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the video animation

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultMpeg4Gif

property thumb_mime_type

property thumb_url

class telebot.types.InlineQueryResultPhoto(id, photo_url, thumbnail_url, photo_width=None, photo_height=None, title=None, description=None, caption=None, caption_entities=None, parse_mode=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be photo

• id (str) – Unique identifier for this result, 1-64 bytes

• photo_url (str) – A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB

• thumbnail_url (str) – URL of the thumbnail for the photo

• photo_width (int) – Optional. Width of the photo

• photo_height (int) – Optional. Height of the photo

• title (str) – Optional. Title for the result

• description (str) – Optional. Short description of the result

• caption (str) – Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the photo caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the photo

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultPhoto

property thumb_url

class telebot.types.InlineQueryResultVenue(id, title, latitude, longitude, address, foursquare_id=None, foursquare_type=None, reply_markup=None, input_message_content=None, thumbnail_url=None, thumbnail_width=None, thumbnail_height=None, google_place_id=None, google_place_type=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be venue

• id (str) – Unique identifier for this result, 1-64 Bytes

• latitude (float) – Latitude of the venue location in degrees

• longitude (float) – Longitude of the venue location in degrees

• title (str) – Title of the venue

• address (str) – Address of the venue

• foursquare_id (str) – Optional. Foursquare identifier of the venue if known

• foursquare_type (str) – Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

• google_place_id (str) – Optional. Google Places identifier of the venue

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

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the venue

• thumbnail_url (str) – Optional. Url of the thumbnail for the result

• thumbnail_width (int) – Optional. Thumbnail width

• thumbnail_height (int) – Optional. Thumbnail height

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultVenue

property thumb_height

property thumb_url

property thumb_width

class telebot.types.InlineQueryResultVideo(id, video_url, mime_type, thumbnail_url, title, caption=None, caption_entities=None, parse_mode=None, video_width=None, video_height=None, video_duration=None, description=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be video

• id (str) – Unique identifier for this result, 1-64 bytes

• video_url (str) – A valid URL for the embedded video player or video file

• mime_type (str) – MIME type of the content of the video URL, “text/html” or “video/mp4”

• thumbnail_url (str) – URL of the thumbnail (JPEG only) for the video

• title (str) – Title for the result

• caption (str) – Optional. Caption of the video to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the video caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• video_width (int) – Optional. Video width

• video_height (int) – Optional. Video height

• video_duration (int) – Optional. Video duration in seconds

• description (str) – Optional. Short description of the result

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultVideo

property thumb_url

class telebot.types.InlineQueryResultVoice(id, voice_url, title, caption=None, caption_entities=None, parse_mode=None, voice_duration=None, reply_markup=None, input_message_content=None)

Bases: InlineQueryResultBase

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.

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

Parameters:

• type (str) – Type of the result, must be voice

• id (str) – Unique identifier for this result, 1-64 bytes

• voice_url (str) – A valid URL for the voice recording

• title (str) – Recording title

• caption (str) – Optional. Caption, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• voice_duration (int) – Optional. Recording duration in seconds

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message

• input_message_content (telebot.types.InputMessageContent) – Optional. Content of the message to be sent instead of the voice recording

Returns:

Instance of the class

Return type:

telebot.types.InlineQueryResultVoice

class telebot.types.InlineQueryResultsButton(text: str, web_app: WebAppInfo | None = None, start_parameter: str | None = None)

Bases: JsonSerializable, Dictionaryable

This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.

Telegram documentation: https://core.telegram.org/bots/api#inlinequeryresultsbutton

Parameters:

• text (str) – Label text on the button

• web_app (telebot.types.WebAppInfo) – Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method web_app_switch_inline_query inside the Web App.

• start_parameter (str) – Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot’s inline capabilities.

Returns:

Instance of the class

Return type:

InlineQueryResultsButton

class telebot.types.InputContactMessageContent(phone_number, first_name, last_name=None, vcard=None)

Bases: Dictionaryable

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

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

Parameters:

• phone_number (str) – Contact’s phone number

• first_name (str) – Contact’s first name

• last_name (str) – Optional. Contact’s last name

• vcard (str) – Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes

Returns:

Instance of the class

Return type:

telebot.types.InputContactMessageContent

class telebot.types.InputFile(file)

Bases: object

A class to send files through Telegram Bot API.

You need to pass a file, which should be an instance of io.IOBase or pathlib.Path, or str.

If you pass an str as a file, it will be opened and closed by the class.

Parameters:

file (io.IOBase or pathlib.Path or str) – A file to send.

Example on sending a file using this class

from telebot.types import InputFile

# Sending a file from disk
bot.send_document(
    chat_id,
    InputFile('/path/to/file/file.txt')
)


# Sending a file from an io.IOBase object
with open('/path/to/file/file.txt', 'rb') as f:
    bot.send_document(
        chat_id,
        InputFile(f)
    )

# Sending a file using pathlib.Path:
bot.send_document(
    chat_id,
    InputFile(pathlib.Path('/path/to/file/file.txt'))
)

property file

File object.

class telebot.types.InputInvoiceMessageContent(title, description, payload, provider_token, currency, prices, max_tip_amount=None, suggested_tip_amounts=None, provider_data=None, photo_url=None, photo_size=None, photo_width=None, photo_height=None, need_name=None, need_phone_number=None, need_email=None, need_shipping_address=None, send_phone_number_to_provider=None, send_email_to_provider=None, is_flexible=None)

Bases: Dictionaryable

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

Telegram Documentation: https://core.telegram.org/bots/api#inputinvoicemessagecontent

Parameters:

• title (str) – Product name, 1-32 characters

• description (str) – Product description, 1-255 characters

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

• provider_token (str) – Payment provider token, obtained via @BotFather

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

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

• max_tip_amount (int) – Optional. 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 (list of int) – Optional. A JSON-serialized array of suggested amounts of tip 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 (str) – Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.

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

• photo_size (int) – Optional. Photo size in bytes

• photo_width (int) – Optional. Photo width

• photo_height (int) – Optional. Photo height

• need_name (bool) – Optional. Pass True, if you require the user’s full name to complete the order

• need_phone_number (bool) – Optional. Pass True, if you require the user’s phone number to complete the order

• need_email (bool) – Optional. Pass True, if you require the user’s email address to complete the order

• need_shipping_address (bool) – Optional. Pass True, if you require the user’s shipping address to complete the order

• send_phone_number_to_provider (bool) – Optional. Pass True, if the user’s phone number should be sent to provider

• send_email_to_provider (bool) – Optional. Pass True, if the user’s email address should be sent to provider

• is_flexible (bool) – Optional. Pass True, if the final price depends on the shipping method

Returns:

Instance of the class

Return type:

telebot.types.InputInvoiceMessageContent

class telebot.types.InputLocationMessageContent(latitude, longitude, horizontal_accuracy=None, live_period=None, heading=None, proximity_alert_radius=None)

Bases: Dictionaryable

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

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

Parameters:

• latitude (float) – Latitude of the location in degrees

• longitude (float) – Longitude of the location in degrees

• horizontal_accuracy (float number) – Optional. The radius of uncertainty for the location, measured in meters; 0-1500

• live_period (int) – Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

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

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

Returns:

Instance of the class

Return type:

telebot.types.InputLocationMessageContent

class telebot.types.InputMedia(type, media, caption=None, parse_mode=None, caption_entities=None)

Bases: Dictionaryable, JsonSerializable

This object represents the content of a media message to be sent. It should be one of

• InputMediaAnimation

• InputMediaDocument

• InputMediaAudio

• InputMediaPhoto

• InputMediaVideo

class telebot.types.InputMediaAnimation(media, thumbnail=None, caption=None, parse_mode=None, caption_entities=None, width=None, height=None, duration=None, has_spoiler=None)

Bases: InputMedia

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

Telegram Documentation: https://core.telegram.org/bots/api#inputmediaanimation

Parameters:

• media (str) – File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

• thumbnail (InputFile or str) – Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »

• caption (str) – Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the animation caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• width (int) – Optional. Animation width

• height (int) – Optional. Animation height

• duration (int) – Optional. Animation duration in seconds

• has_spoiler (bool) – Optional. True, if the uploaded animation is a spoiler

Returns:

Instance of the class

Return type:

telebot.types.InputMediaAnimation

property thumb

class telebot.types.InputMediaAudio(media, thumbnail=None, caption=None, parse_mode=None, caption_entities=None, duration=None, performer=None, title=None)

Bases: InputMedia

Represents an audio file to be treated as music to be sent.

Telegram Documentation: https://core.telegram.org/bots/api#inputmediaaudio

Parameters:

• media (str) – File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

• thumbnail (InputFile or str) – Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »

• caption (str) – Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• duration (int) – Optional. Duration of the audio in seconds

• performer (str) – Optional. Performer of the audio

• title (str) – Optional. Title of the audio

Returns:

Instance of the class

Return type:

telebot.types.InputMediaAudio

property thumb

class telebot.types.InputMediaDocument(media, thumbnail=None, caption=None, parse_mode=None, caption_entities=None, disable_content_type_detection=None)

Bases: InputMedia

Represents a general file to be sent.

Telegram Documentation: https://core.telegram.org/bots/api#inputmediadocument

Parameters:

• media (str) – File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

• thumbnail (InputFile or str) – Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »

• caption (str) – Optional. Caption of the document to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the document caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• disable_content_type_detection (bool) – Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.

Returns:

Instance of the class

Return type:

telebot.types.InputMediaDocument

property thumb

class telebot.types.InputMediaPhoto(media, caption=None, parse_mode=None, caption_entities=None, has_spoiler=None)

Bases: InputMedia

Represents a photo to be sent.

Telegram Documentation: https://core.telegram.org/bots/api#inputmediaphoto

Parameters:

• media (str) – File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

• caption (str) – Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the photo caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• has_spoiler (bool) – Optional. True, if the uploaded photo is a spoiler

Returns:

Instance of the class

Return type:

telebot.types.InputMediaPhoto

class telebot.types.InputMediaVideo(media, thumbnail=None, caption=None, parse_mode=None, caption_entities=None, width=None, height=None, duration=None, supports_streaming=None, has_spoiler=None)

Bases: InputMedia

Represents a video to be sent.

Telegram Documentation: https://core.telegram.org/bots/api#inputmediavideo

Parameters:

• media (str) – File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

• thumbnail (InputFile or str) – Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »

• caption (str) – Optional. Caption of the video to be sent, 0-1024 characters after entities parsing

• parse_mode (str) – Optional. Mode for parsing entities in the video caption. See formatting options for more details.

• caption_entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

• width (int) – Optional. Video width

• height (int) – Optional. Video height

• duration (int) – Optional. Video duration in seconds

• supports_streaming (bool) – Optional. Pass True, if the uploaded video is suitable for streaming

• has_spoiler (bool) – Optional. True, if the uploaded video is a spoiler

Returns:

Instance of the class

Return type:

telebot.types.InputMediaVideo

property thumb

class telebot.types.InputSticker(sticker: str | InputFile, emoji_list: List[str], format: str | None = None, mask_position: MaskPosition | None = None, keywords: List[str] | None = None)

Bases: Dictionaryable, JsonSerializable

This object describes a sticker to be added to a sticker set.

Parameters:

• sticker (str or telebot.types.InputFile) – The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, 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. Animated and video stickers can’t be uploaded via HTTP URL.

• emoji_list (list of str) – One or more(up to 20) emoji(s) corresponding to the sticker

• mask_position (telebot.types.MaskPosition) – Optional. Position where the mask should be placed on faces. For “mask” stickers only.

• keywords (list of str) – Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only.

• format (str) – Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video

Returns:

Instance of the class

Return type:

telebot.types.InputSticker

convert_input_sticker()

class telebot.types.InputTextMessageContent(message_text, parse_mode=None, entities=None, disable_web_page_preview=None, link_preview_options=None)

Bases: Dictionaryable

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

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

Parameters:

• message_text (str) – Text of the message to be sent, 1-4096 characters

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

• entities (list of telebot.types.MessageEntity) – Optional. List of special entities that appear in message text, which can be specified instead of parse_mode

• disable_web_page_preview (bool) – deprecated

• link_preview_options (telebot.types.LinkPreviewOptions) – Optional. Link preview generation options for the message

Returns:

Instance of the class

Return type:

telebot.types.InputTextMessageContent

class telebot.types.InputVenueMessageContent(latitude, longitude, title, address, foursquare_id=None, foursquare_type=None, google_place_id=None, google_place_type=None)

Bases: Dictionaryable

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

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

Parameters:

• latitude (float) – Latitude of the venue in degrees

• longitude (float) – Longitude of the venue in degrees

• title (str) – Name of the venue

• address (str) – Address of the venue

• foursquare_id (str) – Optional. Foursquare identifier of the venue, if known

• foursquare_type (str) – Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

• google_place_id (str) – Optional. Google Places identifier of the venue

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

Returns:

Instance of the class

Return type:

telebot.types.InputVenueMessageContent

class telebot.types.Invoice(title, description, start_parameter, currency, total_amount, **kwargs)

Bases: JsonDeserializable

This object contains basic information about an invoice.

Telegram Documentation: https://core.telegram.org/bots/api#invoice

Parameters:

• title (str) – Product name

• description (str) – Product description

• start_parameter (str) – Unique bot deep-linking parameter that can be used to generate this invoice

• currency (str) – Three-letter ISO 4217 currency code

• total_amount (int) – Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

Returns:

Instance of the class

Return type:

telebot.types.Invoice

class telebot.types.JsonDeserializable

Bases: object

Subclasses of this class are guaranteed to be able to be created from a json-style dict or json formatted string. All subclasses of this class must override de_json.

class telebot.types.JsonSerializable

Bases: object

Subclasses of this class are guaranteed to be able to be converted to JSON format. All subclasses of this class must override to_json.

class telebot.types.KeyboardButton(text: str, request_contact: bool | None = None, request_location: bool | None = None, request_poll: KeyboardButtonPollType | None = None, web_app: WebAppInfo | None = None, request_user: KeyboardButtonRequestUser | None = None, request_chat: KeyboardButtonRequestChat | None = None, request_users: KeyboardButtonRequestUsers | None = None)

Bases: Dictionaryable, JsonSerializable

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 web_app, request_contact, request_location, and request_poll are mutually exclusive.

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

Parameters:

• text (str) – Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed

• request_contact (bool) – Optional. If True, the user’s phone number will be sent as a contact when the button is pressed. Available in private chats only.

• request_location (bool) – Optional. If True, the user’s current location will be sent when the button is pressed. Available in private chats only.

• request_poll (telebot.types.KeyboardButtonPollType) – Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

• web_app (telebot.types.WebAppInfo) – Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.

• request_user (telebot.types.KeyboardButtonRequestUser) – deprecated

• request_users (telebot.types.KeyboardButtonRequestUsers) – Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only.

• request_chat (telebot.types.KeyboardButtonRequestChat) – Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only.

Returns:

Instance of the class

Return type:

telebot.types.KeyboardButton

class telebot.types.KeyboardButtonPollType(type='')

Bases: Dictionaryable

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

Telegram Documentation: https://core.telegram.org/bots/api#keyboardbuttonpolltype

Parameters:

type (str) – Optional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.

Returns:

Instance of the class

Return type:

telebot.types.KeyboardButtonPollType

class telebot.types.KeyboardButtonRequestChat(request_id: int, chat_is_channel: bool, chat_is_forum: bool | None = None, chat_has_username: bool | None = None, chat_is_created: bool | None = None, user_administrator_rights: ChatAdministratorRights | None = None, bot_administrator_rights: ChatAdministratorRights | None = None, bot_is_member: bool | None = None, request_title: str | None = None, request_photo: bool | None = None, request_username: bool | None = None)

Bases: Dictionaryable

This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.

Telegram documentation: https://core.telegram.org/bots/api#keyboardbuttonrequestchat

Parameters:

• request_id (int) – Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message

• chat_is_channel (bool) – Pass True to request a channel chat, pass False to request a group or a supergroup chat.

• chat_is_forum (bool) – Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.

• chat_has_username (bool) – Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.

• chat_is_created (bool) – Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.

• user_administrator_rights (telebot.types.ChatAdministratorRights) – Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.

• bot_administrator_rights (telebot.types.ChatAdministratorRights) – Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.

• bot_is_member (bool) – Optional. Pass True to request a chat where the bot is a member. Otherwise, no additional restrictions are applied.

• request_title (bool) – Optional. Request title

• request_photo (bool) – Optional. Request photo

• request_username (bool) – Optional. Request username

Returns:

Instance of the class

Return type:

telebot.types.KeyboardButtonRequestChat

class telebot.types.KeyboardButtonRequestUser(request_id: int, user_is_bot: bool | None = None, user_is_premium: bool | None = None, max_quantity: int | None = None)

Bases: KeyboardButtonRequestUsers

Deprecated. Use KeyboardButtonRequestUsers instead.

class telebot.types.KeyboardButtonRequestUsers(request_id: int, user_is_bot: bool | None = None, user_is_premium: bool | None = None, max_quantity: int | None = None, request_name: str | None = None, request_username: bool | None = None, request_photo: bool | None = None)

Bases: Dictionaryable

This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.

Telegram documentation: https://core.telegram.org/bots/api#keyboardbuttonrequestusers

Parameters:

• request_id (int) – Signed 32-bit identifier of the request, which will be received back in the UsersShared object. Must be unique within the message

• user_is_bot (bool) – Optional. Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied.

• user_is_premium (bool) – Optional. Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied.

• max_quantity (int) – Optional. The maximum number of users to be selected; 1-10. Defaults to 1.

• request_name (bool) – Optional. Request name

• request_username (bool) – Optional. Request username

• request_photo (bool) – Optional. Request photo

Returns:

Instance of the class

Return type:

telebot.types.KeyboardButtonRequestUsers

class telebot.types.LabeledPrice(label, amount)

Bases: JsonSerializable, Dictionaryable

This object represents a portion of the price for goods or services.

Telegram Documentation: https://core.telegram.org/bots/api#labeledprice

Parameters:

• label (str) – Portion label

• amount (int) – Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

Returns:

Instance of the class

Return type:

telebot.types.LabeledPrice

class telebot.types.LinkPreviewOptions(is_disabled: bool | None = None, url: str | None = None, prefer_small_media: bool | None = None, prefer_large_media: bool | None = None, show_above_text: bool | None = None, **kwargs)

Bases: JsonDeserializable, Dictionaryable, JsonSerializable

Describes the options used for link preview generation.

Telegram documentation: https://core.telegram.org/bots/api#linkpreviewoptions

Parameters:

• is_disabled (bool) – Optional. True, if the link preview is disabled

• url (str) – Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used

• prefer_small_media (bool) – Optional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn’t explicitly specified or media size change isn’t supported for the preview

• prefer_large_media (bool) – Optional. True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn’t explicitly specified or media size change isn’t supported for the preview

• show_above_text (bool) – Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text

Returns:

Instance of the class

Return type:

LinkPreviewOptions

class telebot.types.Location(longitude, latitude, horizontal_accuracy=None, live_period=None, heading=None, proximity_alert_radius=None, **kwargs)

Bases: JsonDeserializable, JsonSerializable, Dictionaryable

This object represents a point on the map.

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

Parameters:

• longitude (float) – Longitude as defined by sender

• latitude (float) – Latitude as defined by sender

• horizontal_accuracy (float number) – Optional. The radius of uncertainty for the location, measured in meters; 0-1500

• live_period (int) – Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.

• heading (int) – Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.

• proximity_alert_radius (int) – Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.

Returns:

Instance of the class

Return type:

telebot.types.Location

class telebot.types.LoginUrl(url, forward_text=None, bot_username=None, request_write_access=None, **kwargs)

Bases: Dictionaryable, JsonSerializable, JsonDeserializable

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:

Telegram Documentation: https://core.telegram.org/bots/api#loginurl

Parameters:

• url (str) – An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data. NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.

• forward_text (str) – Optional. New text of the button in forwarded messages.

• bot_username (str) – Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot’s username will be assumed. The url’s domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.

• request_write_access (bool) – Optional. Pass True to request the permission for your bot to send messages to the user.

Returns:

Instance of the class

Return type:

telebot.types.LoginUrl

class telebot.types.MaskPosition(point, x_shift, y_shift, scale, **kwargs)

Bases: Dictionaryable, JsonDeserializable, JsonSerializable

This object describes the position on faces where a mask should be placed by default.

Telegram Documentation: https://core.telegram.org/bots/api#maskposition

Parameters:

• point (str) – The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.

• x_shift (float number) – Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.

• y_shift (float number) – Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.

• scale (float number) – Mask scaling coefficient. For example, 2.0 means double size.

Returns:

Instance of the class

Return type:

telebot.types.MaskPosition

class telebot.types.MenuButton

Bases: JsonDeserializable, JsonSerializable, Dictionaryable

This object describes the bot’s menu button in a private chat. It should be one of

• MenuButtonCommands

• MenuButtonWebApp

• MenuButtonDefault

If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.

class telebot.types.MenuButtonCommands(type=None, **kwargs)

Bases: MenuButton

Represents a menu button, which opens the bot’s list of commands.

Telegram Documentation: https://core.telegram.org/bots/api#menubuttoncommands

Parameters:

type (str) – Type of the button, must be commands

Returns:

Instance of the class

Return type:

telebot.types.MenuButtonCommands

class telebot.types.MenuButtonDefault(type=None, **kwargs)

Bases: MenuButton

Describes that no specific value for the menu button was set.

Telegram Documentation: https://core.telegram.org/bots/api#menubuttondefault

Parameters:

type (str) – Type of the button, must be default

Returns:

Instance of the class

Return type:

telebot.types.MenuButtonDefault

class telebot.types.MenuButtonWebApp(type, text, web_app, **kwargs)

Bases: MenuButton

Represents a menu button, which launches a Web App.

Telegram Documentation: https://core.telegram.org/bots/api#menubuttonwebapp

Parameters:

• type (str) – Type of the button, must be web_app

• text (str) – Text on the button

• web_app (telebot.types.WebAppInfo) – Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery.

Returns:

Instance of the class

Return type:

telebot.types.MenuButtonWebApp

class telebot.types.Message(message_id, from_user, date, chat, content_type, options, json_string)

Bases: JsonDeserializable

This object represents a message.

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

Parameters:

• message_id (int) – Unique message identifier inside this chat

• message_thread_id (int) – Optional. Unique identifier of a message thread to which the message belongs; for supergroups only

• from_user (telebot.types.User) – Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.

• sender_chat (telebot.types.Chat) – Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.

• sender_boost_count (int) – Optional. If the sender of the message boosted the chat, the number of boosts added by the user

• info (sender_business_bot) – Optional. Information about the business bot that sent the message

• date (int) – Date the message was sent in Unix time

• business_connection_id (str) – Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.

• chat (telebot.types.Chat) – Conversation the message belongs to

• is_topic_message (bool) – Optional. True, if the message is sent to a forum topic

• is_automatic_forward (bool) – Optional. bool, if the message is a channel post that was automatically forwarded to the connected discussion group

• reply_to_message (telebot.types.Message) – Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

• external_reply (telebot.types.ExternalReplyInfo) – Optional. Information about the message that is being replied to, which may come from another chat or forum topic

• quote (telebot.types.TextQuote) – Optional. For replies that quote part of the original message, the quoted part of the message

• reply_to_story (telebot.types.Story) – Optional. For replies to a story, the original story

• via_bot (telebot.types.User) – Optional. Bot through which the message was sent

• edit_date (int) – Optional. Date the message was last edited in Unix time

• has_protected_content (bool) – Optional. bool, if the message can’t be forwarded

• is_from_offline (bool) – Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

• media_group_id (str) – Optional. The unique identifier of a media message group this message belongs to

• author_signature (str) – Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator

• text (str) – Optional. For text messages, the actual UTF-8 text of the message

• entities (list of telebot.types.MessageEntity) – Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text

• link_preview_options (telebot.types.LinkPreviewOptions) – Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed

• animation (telebot.types.Animation) – Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set

• audio (telebot.types.Audio) – Optional. Message is an audio file, information about the file

• document (telebot.types.Document) – Optional. Message is a general file, information about the file

• photo (list of telebot.types.PhotoSize) – Optional. Message is a photo, available sizes of the photo

• sticker (telebot.types.Sticker) – Optional. Message is a sticker, information about the sticker

• story (telebot.types.Story) – Optional. Message is a forwarded story

• video (telebot.types.Video) – Optional. Message is a video, information about the video

• video_note (telebot.types.VideoNote) – Optional. Message is a video note, information about the video message

• voice (telebot.types.Voice) – Optional. Message is a voice message, information about the file

• caption (str) – Optional. Caption for the animation, audio, document, photo, video or voice

• caption_entities (list of telebot.types.MessageEntity) – Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption

• has_media_spoiler (bool) – Optional. True, if the message media is covered by a spoiler animation

• contact (telebot.types.Contact) – Optional. Message is a shared contact, information about the contact

• dice (telebot.types.Dice) – Optional. Message is a dice with random value

• game (telebot.types.Game) – Optional. Message is a game, information about the game. More about games »

• poll (telebot.types.Poll) – Optional. Message is a native poll, information about the poll

• venue (telebot.types.Venue) – Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set

• location (telebot.types.Location) – Optional. Message is a shared location, information about the location

• new_chat_members (list of telebot.types.User) – Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)

• left_chat_member (telebot.types.User) – Optional. A member was removed from the group, information about them (this member may be the bot itself)

• new_chat_title (str) – Optional. A chat title was changed to this value

• new_chat_photo (list of telebot.types.PhotoSize) – Optional. A chat photo was change to this value

• delete_chat_photo (bool) – Optional. Service message: the chat photo was deleted

• group_chat_created (bool) – Optional. Service message: the group has been created

• supergroup_chat_created (bool) – Optional. Service message: the supergroup has been created. This field can’t be received in a message coming through updates, because bot can’t be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.

• channel_chat_created (bool) – Optional. Service message: the channel has been created. This field can’t be received in a message coming through updates, because bot can’t be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.

• message_auto_delete_timer_changed (telebot.types.MessageAutoDeleteTimerChanged) – Optional. Service message: auto-delete timer settings changed in the chat

• migrate_to_chat_id (int) – Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

• migrate_from_chat_id (int) – Optional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.

• pinned_message (telebot.types.Message or telebot.types.InaccessibleMessage) – Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.

• invoice (telebot.types.Invoice) – Optional. Message is an invoice for a payment, information about the invoice. More about payments »

• successful_payment (telebot.types.SuccessfulPayment) – Optional. Message is a service message about a successful payment, information about the payment. More about payments »

• users_shared (telebot.types.UsersShared) – Optional. Service message: a user was shared with the bot

• chat_shared (telebot.types.ChatShared) – Optional. Service message: a chat was shared with the bot

• connected_website (str) – Optional. The domain name of the website on which the user has logged in. More about Telegram Login »

• write_access_allowed (telebot.types.WriteAccessAllowed) – Optional. Service message: the user allowed the bot added to the attachment menu to write messages

• passport_data (telebot.types.PassportData) – Optional. Telegram Passport data

• proximity_alert_triggered (telebot.types.ProximityAlertTriggered) – Optional. Service message. A user in the chat triggered another user’s proximity alert while sharing Live Location.

• boost_added (telebot.types.ChatBoostAdded) – Optional. Service message: user boosted the chat

• forum_topic_created (telebot.types.ForumTopicCreated) – Optional. Service message: forum topic created

• forum_topic_edited (telebot.types.ForumTopicEdited) – Optional. Service message: forum topic edited

• forum_topic_closed (telebot.types.ForumTopicClosed) – Optional. Service message: forum topic closed

• forum_topic_reopened (telebot.types.ForumTopicReopened) – Optional. Service message: forum topic reopened

• general_forum_topic_hidden (telebot.types.GeneralForumTopicHidden) – Optional. Service message: the ‘General’ forum topic hidden

• general_forum_topic_unhidden (telebot.types.GeneralForumTopicUnhidden) – Optional. Service message: the ‘General’ forum topic unhidden

• giveaway_created (telebot.types.GiveawayCreated) – Optional. Service message: a giveaway has been created

• giveaway (telebot.types.Giveaway) – Optional. The message is a scheduled giveaway message

• giveaway_winners (telebot.types.GiveawayWinners) – Optional. Service message: giveaway winners(public winners)

• giveaway_completed (telebot.types.GiveawayCompleted) – Optional. Service message: giveaway completed, without public winners

• video_chat_scheduled (telebot.types.VideoChatScheduled) – Optional. Service message: video chat scheduled

• video_chat_started (telebot.types.VideoChatStarted) – Optional. Service message: video chat started

• video_chat_ended (telebot.types.VideoChatEnded) – Optional. Service message: video chat ended

• video_chat_participants_invited (telebot.types.VideoChatParticipantsInvited) – Optional. Service message: new participants invited to a video chat

• web_app_data (telebot.types.WebAppData) – Optional. Service message: data sent by a Web App

• reply_markup (telebot.types.InlineKeyboardMarkup) – Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.

Forward_origin:

Optional. For forwarded messages, information about the original message;

Returns:

Instance of the class

Return type:

telebot.types.Message

property forward_date

property forward_from

property forward_from_chat

property forward_from_message_id

property forward_sender_name

property forward_signature

property html_caption

Returns html-rendered caption.

property html_text

Returns html-rendered text.

property new_chat_member

classmethod parse_chat(chat)

Parses chat.

classmethod parse_entities(message_entity_array)

Parses message entity array.

classmethod parse_photo(photo_size_array)

Parses photo array.

property user_shared

property voice_chat_ended

property voice_chat_participants_invited

property voice_chat_scheduled

property voice_chat_started

class telebot.types.MessageAutoDeleteTimerChanged(message_auto_delete_time, **kwargs)

Bases: JsonDeserializable

This object represents a service message about a change in auto-delete timer settings.

Telegram Documentation: https://core.telegram.org/bots/api#messageautodeletetimerchanged

Parameters:

message_auto_delete_time (int) – New auto-delete time for messages in the chat; in seconds

Returns:

Instance of the class

Return type:

telebot.types.MessageAutoDeleteTimerChanged

class telebot.types.MessageEntity(type, offset, length, url=None, user=None, language=None, custom_emoji_id=None, **kwargs)

Bases: Dictionaryable, JsonSerializable, JsonDeserializable

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

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

Parameters:

• type (str) – Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers)

• offset (int) – Offset in UTF-16 code units to the start of the entity

• length (int) – Length of the entity in UTF-16 code units

• url (str) – Optional. For “text_link” only, URL that will be opened after user taps on the text

• user (telebot.types.User) – Optional. For “text_mention” only, the mentioned user

• language (str) – Optional. For “pre” only, the programming language of the entity text

• custom_emoji_id (str) – Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use get_custom_emoji_stickers to get full information about the sticker.

Returns:

Instance of the class

Return type:

telebot.types.MessageEntity

static to_list_of_dicts(entity_list) → List[Dict] | None

Converts a list of MessageEntity objects to a list of dictionaries.

class telebot.types.MessageID(message_id, **kwargs)

Bases: JsonDeserializable

This object represents a unique message identifier.

Telegram Documentation: https://core.telegram.org/bots/api#messageid

Parameters:

message_id (int) – Unique message identifier

Returns:

Instance of the class

Return type:

telebot.types.MessageId

class telebot.types.MessageOrigin(type: str, date: int)

Bases: JsonDeserializable

This object describes the origin of a message.

Telegram documentation: https://core.telegram.org/bots/api#messageorigin

Parameters:

• type (str) – Type of the message origin

• date (int) – Date the message was sent originally in Unix time

• sender_user (User) – User that sent the message originally (for MessageOriginUser)

• sender_user_name (str) – Name of the user that sent the message originally (for MessageOriginHiddenUser)

• sender_chat (Chat) – Chat that sent the message originally (for MessageOriginChat)

• author_signature (str) – Optional. Author signature for certain cases

Returns:

Instance of the class

Return type:

MessageOrigin

class telebot.types.MessageOriginChannel(date: int, chat: Chat, message_id: int, author_signature: str | None = None)

Bases: MessageOrigin

The message was originally sent to a channel chat.

Parameters:

• chat (Chat) – Channel chat to which the message was originally sent

• message_id (int) – Unique message identifier inside the chat

• author_signature (str) – Optional. Signature of the original post author

class telebot.types.MessageOriginChat(date: int, sender_chat: Chat, author_signature: str | None = None)

Bases: MessageOrigin

The message was originally sent on behalf of a chat to a group chat.

Parameters:

• sender_chat (Chat) – Chat that sent the message originally

• author_signature (str) – Optional. For messages originally sent by an anonymous chat administrator, original message author signature

class telebot.types.MessageOriginHiddenUser(date: int, sender_user_name: str)

Bases: MessageOrigin

The message was originally sent by an unknown user.

Parameters:

sender_user_name (str) – Name of the user that sent the message originally

class telebot.types.MessageOriginUser(date: int, sender_user: User)

Bases: MessageOrigin

The message was originally sent by a known user.

Parameters:

sender_user (User) – User that sent the message originally

class telebot.types.MessageReactionCountUpdated(chat: Chat, message_id: int, date: int, reactions: List[ReactionCount], **kwargs)

Bases: JsonDeserializable

This object represents a service message about a change in the list of the current user’s reactions to a message.

Telegram documentation: https://core.telegram.org/bots/api#messagereactioncountupdated

Parameters:

• chat (telebot.types.Chat) – The chat containing the message

• message_id (int) – Unique message identifier inside the chat

• date (int) – Date of the change in Unix time

• reactions (list of ReactionCount) – List of reactions that are present on the message

Returns:

Instance of the class

Return type:

MessageReactionCountUpdated

class telebot.types.MessageReactionUpdated(chat: Chat, message_id: int, date: int, old_reaction: List[ReactionType], new_reaction: List[ReactionType], user: User | None = None, actor_chat: Chat | None = None, **kwargs)

Bases: JsonDeserializable

This object represents a service message about a change in the list of the current user’s reactions to a message.

Telegram documentation: https://core.telegram.org/bots/api#messagereactionupdated

Parameters:

• chat (telebot.types.Chat) – The chat containing the message the user reacted to

• message_id (int) – Unique identifier of the message inside the chat

• user (telebot.types.User) – Optional. The user that changed the reaction, if the user isn’t anonymous

• actor_chat (telebot.types.Chat) – Optional. The chat on behalf of which the reaction was changed, if the user is anonymous

• date (int) – Date of the change in Unix time

• old_reaction (list of ReactionType) – Previous list of reaction types that were set by the user

• new_reaction (list of ReactionType) – New list of reaction types that have been set by the user

Returns:

Instance of the class

Return type:

MessageReactionUpdated

class telebot.types.OrderInfo(name=None, phone_number=None, email=None, shipping_address=None, **kwargs)

Bases: JsonDeserializable

This object represents information about an order.

Telegram Documentation: https://core.telegram.org/bots/api#orderinfo

Parameters:

• name (str) – Optional. User name

• phone_number (str) – Optional. User’s phone number

• email (str) – Optional. User email

• shipping_address (telebot.types.ShippingAddress) – Optional. User shipping address

Returns:

Instance of the class

Return type:

telebot.types.OrderInfo

class telebot.types.PhotoSize(file_id, file_unique_id, width, height, file_size=None, **kwargs)

Bases: JsonDeserializable

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

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

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• width (int) – Photo width

• height (int) – Photo height

• file_size (int) – Optional. File size in bytes

Returns:

Instance of the class

Return type:

telebot.types.PhotoSize

class telebot.types.Poll(question, options, poll_id=None, total_voter_count=None, is_closed=None, is_anonymous=None, type=None, allows_multiple_answers=None, correct_option_id=None, explanation=None, explanation_entities=None, open_period=None, close_date=None, poll_type=None, **kwargs)

Bases: JsonDeserializable

This object contains information about a poll.

Telegram Documentation: https://core.telegram.org/bots/api#poll

Parameters:

• id (str) – Unique poll identifier

• question (str) – Poll question, 1-300 characters

• options (list of telebot.types.PollOption) – List of poll options

• total_voter_count (int) – Total number of users that voted in the poll

• is_closed (bool) – True, if the poll is closed

• is_anonymous (bool) – True, if the poll is anonymous

• type (str) – Poll type, currently can be “regular” or “quiz”

• allows_multiple_answers (bool) – True, if the poll allows multiple answers

• correct_option_id (int) – Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.

• explanation (str) – Optional. 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

• explanation_entities (list of telebot.types.MessageEntity) – Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation

• open_period (int) – Optional. Amount of time in seconds the poll will be active after creation

• close_date (int) – Optional. Point in time (Unix timestamp) when the poll will be automatically closed

Returns:

Instance of the class

Return type:

telebot.types.Poll

add(option)

Add an option to the poll.

Parameters:

option (telebot.types.PollOption or str) – Option to add

class telebot.types.PollAnswer(poll_id, option_ids, user=None, voter_chat=None, **kwargs)

Bases: JsonSerializable, JsonDeserializable, Dictionaryable

This object represents an answer of a user in a non-anonymous poll.

Telegram Documentation: https://core.telegram.org/bots/api#pollanswer

Parameters:

• poll_id (str) – Unique poll identifier

• voter_chat (telebot.types.Chat) – Optional. The chat that changed the answer to the poll, if the voter is anonymous

• user (telebot.types.User) – Optional. The user, who changed the answer to the poll

• option_ids (list of int) – 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.

Returns:

Instance of the class

Return type:

telebot.types.PollAnswer

class telebot.types.PollOption(text, voter_count=0, **kwargs)

Bases: JsonDeserializable

This object contains information about one answer option in a poll.

Telegram Documentation: https://core.telegram.org/bots/api#polloption

Parameters:

• text (str) – Option text, 1-100 characters

• voter_count (int) – Number of users that voted for this option

Returns:

Instance of the class

Return type:

telebot.types.PollOption

class telebot.types.PreCheckoutQuery(id, from_user, currency, total_amount, invoice_payload, shipping_option_id=None, order_info=None, **kwargs)

Bases: JsonDeserializable

This object contains information about an incoming pre-checkout query.

Telegram Documentation: https://core.telegram.org/bots/api#precheckoutquery

Parameters:

• id (str) – Unique query identifier

• from (telebot.types.User) – User who sent the query

• currency (str) – Three-letter ISO 4217 currency code

• total_amount (int) – Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

• invoice_payload (str) – Bot specified invoice payload

• shipping_option_id (str) – Optional. Identifier of the shipping option chosen by the user

• order_info (telebot.types.OrderInfo) – Optional. Order information provided by the user

Returns:

Instance of the class

Return type:

telebot.types.PreCheckoutQuery

class telebot.types.ProximityAlertTriggered(traveler, watcher, distance, **kwargs)

Bases: JsonDeserializable

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

Telegram Documentation: https://core.telegram.org/bots/api#proximityalerttriggered

Parameters:

• traveler (telebot.types.User) – User that triggered the alert

• watcher (telebot.types.User) – User that set the alert

• distance (int) – The distance between the users

Returns:

Instance of the class

Return type:

telebot.types.ProximityAlertTriggered

class telebot.types.ReactionCount(type: ReactionType, total_count: int, **kwargs)

Bases: JsonDeserializable

This object represents a reaction added to a message along with the number of times it was added.

Telegram documentation: https://core.telegram.org/bots/api#reactioncount

Parameters:

• type (ReactionType) – Type of the reaction

• total_count (int) – Number of times the reaction was added

Returns:

Instance of the class

Return type:

ReactionCount

class telebot.types.ReactionType(type: str)

Bases: JsonDeserializable, Dictionaryable, JsonSerializable

This object represents a reaction type.

Telegram documentation: https://core.telegram.org/bots/api#reactiontype

Parameters:

type (str) – Type of the reaction

Returns:

Instance of the class

Return type:

ReactionType

class telebot.types.ReactionTypeCustomEmoji(custom_emoji_id: str, **kwargs)

Bases: ReactionType

This object represents a custom emoji reaction type.

Telegram documentation: https://core.telegram.org/bots/api#reactiontypecustomemoji

Parameters:

• type (str) – Type of the reaction, must be custom_emoji

• custom_emoji_id (str) – Identifier of the custom emoji

Returns:

Instance of the class

Return type:

ReactionTypeCustomEmoji

class telebot.types.ReactionTypeEmoji(emoji: str, **kwargs)

Bases: ReactionType

This object represents an emoji reaction type.

Telegram documentation: https://core.telegram.org/bots/api#reactiontypeemoji

Parameters:

• type (str) – Type of the reaction, must be emoji

• emoji (str) – Reaction emoji. List is available on the API doc.

Returns:

Instance of the class

Return type:

ReactionTypeEmoji

class telebot.types.ReplyKeyboardMarkup(resize_keyboard: bool | None = None, one_time_keyboard: bool | None = None, selective: bool | None = None, row_width: int = 3, input_field_placeholder: str | None = None, is_persistent: bool | None = None)

Bases: JsonSerializable

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

Example on creating ReplyKeyboardMarkup object

from telebot.types import ReplyKeyboardMarkup, KeyboardButton

markup = ReplyKeyboardMarkup(resize_keyboard=True)
markup.add(KeyboardButton('Text'))
# or:
markup.add('Text')

# display this markup:
bot.send_message(chat_id, 'Text', reply_markup=markup)

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

Parameters:

• keyboard (list of list of telebot.types.KeyboardButton) – list of button rows, each represented by an list of telebot.types.KeyboardButton objects

• resize_keyboard (bool) – Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app’s standard keyboard.

• one_time_keyboard (bool) – Optional. Requests clients to hide the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.

• input_field_placeholder (str) – Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters

• selective (bool) – Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply to a message in the same chat and forum topic, sender of the original message. Example: A user requests to change the bot’s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

• is_persistent –

  Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply (has reply_to_message_id), sender of the original message.

  Example: A user requests to change the bot’s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.

Returns:

Instance of the class

Return type:

telebot.types.ReplyKeyboardMarkup

add(*args, row_width=None)

This function adds strings to the keyboard, while not exceeding row_width. E.g. ReplyKeyboardMarkup#add(“A”, “B”, “C”) yields the json result {keyboard: [[“A”], [“B”], [“C”]]} when row_width is set to 1. When row_width is set to 2, the following is the result of this function: {keyboard: [[“A”, “B”], [“C”]]} See https://core.telegram.org/bots/api#replykeyboardmarkup

Parameters:

• args (str or telebot.types.KeyboardButton) – KeyboardButton to append to the keyboard

• row_width (int) – width of row

Returns:

self, to allow function chaining.

Return type:

telebot.types.ReplyKeyboardMarkup

max_row_keys = 12

row(*args)

Adds a list of KeyboardButton to the keyboard. This function does not consider row_width. ReplyKeyboardMarkup#row(“A”)#row(“B”, “C”)#to_json() outputs ‘{keyboard: [[“A”], [“B”, “C”]]}’ See https://core.telegram.org/bots/api#replykeyboardmarkup

Parameters:

args (str) – strings

Returns:

self, to allow function chaining.

Return type:

telebot.types.ReplyKeyboardMarkup

class telebot.types.ReplyKeyboardRemove(selective=None)

Bases: JsonSerializable

Upon receiving a message with this object, Telegram clients will remove 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).

Telegram Documentation: https://core.telegram.org/bots/api#replykeyboardremove

Parameters:

• remove_keyboard (bool) – Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) Note that this parameter is set to True by default by the library. You cannot modify it.

• selective (bool) – Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot’s message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven’t voted yet.

Returns:

Instance of the class

Return type:

telebot.types.ReplyKeyboardRemove

class telebot.types.ReplyParameters(message_id: int, chat_id: int | str | None = None, allow_sending_without_reply: bool | None = None, quote: str | None = None, quote_parse_mode: str | None = None, quote_entities: List[MessageEntity] | None = None, quote_position: int | None = None, **kwargs)

Bases: JsonDeserializable, Dictionaryable, JsonSerializable

Describes reply parameters for the message that is being sent.

Telegram documentation: https://core.telegram.org/bots/api#replyparameters

Parameters:

• message_id (int) – Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified

• chat_id (int or str) – Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername)

• allow_sending_without_reply (bool) – Optional. Pass True if the message should be sent even if the specified message to be replied to is not found; can be used only for replies in the same chat and forum topic.

• quote (str) – Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn’t found in the original message.

• quote_parse_mode (str) – Optional. Mode for parsing entities in the quote. See formatting options for more details.

• quote_entities (list of MessageEntity) – Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode.

• quote_position (int) – Optional. Position of the quote in the original message in UTF-16 code units

Returns:

Instance of the class

Return type:

ReplyParameters

class telebot.types.SentWebAppMessage(inline_message_id=None, **kwargs)

Bases: JsonDeserializable, Dictionaryable

Describes an inline message sent by a Web App on behalf of a user.

Telegram Documentation: https://core.telegram.org/bots/api#sentwebappmessage

Parameters:

inline_message_id (str) – Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.

Returns:

Instance of the class

Return type:

telebot.types.SentWebAppMessage

class telebot.types.SharedUser(user_id, first_name=None, last_name=None, username=None, photo=None, **kwargs)

Bases: JsonDeserializable

This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.

Telegram documentation: https://core.telegram.org/bots/api#shareduser

Parameters:

• user_id (int) – Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.

• first_name (str) – Optional. First name of the user, if the name was requested by the bot

• last_name (str) – Optional. Last name of the user, if the name was requested by the bot

• username (str) – Optional. Username of the user, if the username was requested by the bot

• photo (list of PhotoSize) – Optional. Available sizes of the chat photo, if the photo was requested by the bot

Returns:

Instance of the class

Return type:

SharedUser

class telebot.types.ShippingAddress(country_code, state, city, street_line1, street_line2, post_code, **kwargs)

Bases: JsonDeserializable

This object represents a shipping address.

Telegram Documentation: https://core.telegram.org/bots/api#shippingaddress

Parameters:

• country_code (str) – Two-letter ISO 3166-1 alpha-2 country code

• state (str) – State, if applicable

• city (str) – City

• street_line1 (str) – First line for the address

• street_line2 (str) – Second line for the address

• post_code (str) – Address post code

Returns:

Instance of the class

Return type:

telebot.types.ShippingAddress

class telebot.types.ShippingOption(id, title)

Bases: JsonSerializable

This object represents one shipping option.

Telegram Documentation: https://core.telegram.org/bots/api#shippingoption

Parameters:

• id (str) – Shipping option identifier

• title (str) – Option title

• prices (list of telebot.types.LabeledPrice) – List of price portions

Returns:

Instance of the class

Return type:

telebot.types.ShippingOption

add_price(*args)

Add LabeledPrice to ShippingOption

Parameters:

args (LabeledPrice) – LabeledPrices

Returns:

None

class telebot.types.ShippingQuery(id, from_user, invoice_payload, shipping_address, **kwargs)

Bases: JsonDeserializable

This object contains information about an incoming shipping query.

Telegram Documentation: https://core.telegram.org/bots/api#shippingquery

Parameters:

• id (str) – Unique query identifier

• from (telebot.types.User) – User who sent the query

• invoice_payload (str) – Bot specified invoice payload

• shipping_address (telebot.types.ShippingAddress) – User specified shipping address

Returns:

Instance of the class

Return type:

telebot.types.ShippingQuery

class telebot.types.Sticker(file_id, file_unique_id, type, width, height, is_animated, is_video, thumbnail=None, emoji=None, set_name=None, mask_position=None, file_size=None, premium_animation=None, custom_emoji_id=None, needs_repainting=None, **kwargs)

Bases: JsonDeserializable

This object represents a sticker.

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

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• type (str) – Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.

• width (int) – Sticker width

• height (int) – Sticker height

• is_animated (bool) – True, if the sticker is animated

• is_video (bool) – True, if the sticker is a video sticker

• thumbnail (telebot.types.PhotoSize) – Optional. Sticker thumbnail in the .WEBP or .JPG format

• emoji (str) – Optional. Emoji associated with the sticker

• set_name (str) – Optional. Name of the sticker set to which the sticker belongs

• premium_animation (telebot.types.File) – Optional. Premium animation for the sticker, if the sticker is premium

• mask_position (telebot.types.MaskPosition) – Optional. For mask stickers, the position where the mask should be placed

• custom_emoji_id (str) – Optional. For custom emoji stickers, unique identifier of the custom emoji

• needs_repainting (bool) – Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places

• file_size (int) – Optional. File size in bytes

Returns:

Instance of the class

Return type:

telebot.types.Sticker

property thumb

class telebot.types.StickerSet(name, title, sticker_type, stickers, thumbnail=None, **kwargs)

Bases: JsonDeserializable

This object represents a sticker set.

Telegram Documentation: https://core.telegram.org/bots/api#stickerset

Parameters:

• name (str) – Sticker set name

• title (str) – Sticker set title

• sticker_type (str) – Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”

• stickers (list of telebot.types.Sticker) – List of all set stickers

• thumbnail (telebot.types.PhotoSize) – Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format

Returns:

Instance of the class

Return type:

telebot.types.StickerSet

property contains_masks

Deprecated since Bot API 6.2, use sticker_type instead.

property is_animated

Deprecated since Bot API 7.2. Stickers can be mixed now.

property is_video

Deprecated since Bot API 7.2. Stickers can be mixed now.

property thumb

class telebot.types.Story(chat: Chat, id: int, **kwargs)

Bases: JsonDeserializable

This object represents a story.

Telegram documentation: https://core.telegram.org/bots/api#story

Parameters:

• chat (telebot.types.Chat) – Chat that posted the story

• id (int) – Unique identifier for the story in the chat

Returns:

Instance of the class

Return type:

Story

class telebot.types.SuccessfulPayment(currency, total_amount, invoice_payload, shipping_option_id=None, order_info=None, telegram_payment_charge_id=None, provider_payment_charge_id=None, **kwargs)

Bases: JsonDeserializable

This object contains basic information about a successful payment.

Telegram Documentation: https://core.telegram.org/bots/api#successfulpayment

Parameters:

• currency (str) – Three-letter ISO 4217 currency code

• total_amount (int) – Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

• invoice_payload (str) – Bot specified invoice payload

• shipping_option_id (str) – Optional. Identifier of the shipping option chosen by the user

• order_info (telebot.types.OrderInfo) – Optional. Order information provided by the user

• telegram_payment_charge_id (str) – Telegram payment identifier

• provider_payment_charge_id (str) – Provider payment identifier

Returns:

Instance of the class

Return type:

telebot.types.SuccessfulPayment

class telebot.types.SwitchInlineQueryChosenChat(query=None, allow_user_chats=None, allow_bot_chats=None, allow_group_chats=None, allow_channel_chats=None, **kwargs)

Bases: JsonDeserializable, Dictionaryable, JsonSerializable

Represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

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

Parameters:

• query (str) – Optional. The default inline query to be inserted in the input field. If left empty, only the bot’s username will be inserted

• allow_user_chats (bool) – Optional. True, if private chats with users can be chosen

• allow_bot_chats (bool) – Optional. True, if private chats with bots can be chosen

• allow_group_chats (bool) – Optional. True, if group and supergroup chats can be chosen

• allow_channel_chats (bool) – Optional. True, if channel chats can be chosen

Returns:

Instance of the class

Return type:

SwitchInlineQueryChosenChat

class telebot.types.TextQuote(text: str, position: int, entities: List[MessageEntity] | None = None, is_manual: bool | None = None, **kwargs)

Bases: JsonDeserializable

This object contains information about the quoted part of a message that is replied to by the given message.

Telegram documentation: https://core.telegram.org/bots/api#textquote

Parameters:

• text (str) – Text of the quoted part of a message that is replied to by the given message

• entities (list of MessageEntity) – Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes.

• position (int) – Approximate quote position in the original message in UTF-16 code units as specified by the sender

• is_manual (bool) – Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.

Returns:

Instance of the class

Return type:

TextQuote

class telebot.types.Update(update_id, message, edited_message, channel_post, edited_channel_post, inline_query, chosen_inline_result, callback_query, shipping_query, pre_checkout_query, poll, poll_answer, my_chat_member, chat_member, chat_join_request, message_reaction, message_reaction_count, removed_chat_boost, chat_boost, business_connection, business_message, edited_business_message, deleted_business_messages, **kwargs)

Bases: JsonDeserializable

This object represents an incoming update.At most one of the optional parameters can be present in any given update.

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

Parameters:

• update_id (int) – The update’s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.

• message (telebot.types.Message) – Optional. New incoming message of any kind - text, photo, sticker, etc.

• edited_message (telebot.types.Message) – Optional. New version of a message that is known to the bot and was edited

• channel_post (telebot.types.Message) – Optional. New incoming channel post of any kind - text, photo, sticker, etc.

• edited_channel_post (telebot.types.Message) – Optional. New version of a channel post that is known to the bot and was edited

• message_reaction (telebot.types.MessageReactionUpdated) – Optional. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify “message_reaction” in the list of allowed_updates to receive these updates. The update isn’t received for reactions set by bots.

• message_reaction_count (telebot.types.MessageReactionCountUpdated) – Optional. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify “message_reaction_count” in the list of allowed_updates to receive these updates.

• inline_query (telebot.types.InlineQuery) – Optional. New incoming inline query

• chosen_inline_result (telebot.types.ChosenInlineResult) – Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.

• callback_query (telebot.types.CallbackQuery) – Optional. New incoming callback query

• shipping_query (telebot.types.ShippingQuery) – Optional. New incoming shipping query. Only for invoices with flexible price

• pre_checkout_query (telebot.types.PreCheckoutQuery) – Optional. New incoming pre-checkout query. Contains full information about checkout

• poll (telebot.types.Poll) – Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot

• poll_answer (telebot.types.PollAnswer) – Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.

• my_chat_member (telebot.types.ChatMemberUpdated) – Optional. The bot’s chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.

• chat_member (telebot.types.ChatMemberUpdated) – Optional. A chat member’s status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates.

• chat_join_request (telebot.types.ChatJoinRequest) – Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.

• chat_boost (telebot.types.ChatBoostUpdated) – Optional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.

• removed_chat_boost (telebot.types.RemovedChatBoost) – Optional. A chat boost was removed. The bot must be an administrator in the chat to receive these updates.

• business_connection (telebot.types.BusinessConnection) – Optional. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot

• business_message (telebot.types.Message) – Optional. New non-service message from a connected business account

• edited_business_message (telebot.types.Message) – Optional. New version of a non-service message from a connected business account that is known to the bot and was edited

• deleted_business_messages (telebot.types.Message) – Optional. Service message: the chat connected to the business account was deleted

Returns:

Instance of the class

Return type:

telebot.types.Update

class telebot.types.User(id, is_bot, first_name, last_name=None, username=None, language_code=None, can_join_groups=None, can_read_all_group_messages=None, supports_inline_queries=None, is_premium=None, added_to_attachment_menu=None, can_connect_to_business=None, **kwargs)

Bases: JsonDeserializable, Dictionaryable, JsonSerializable

This object represents a Telegram user or bot.

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

Parameters:

• id (int) – Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.

• is_bot (bool) – True, if this user is a bot

• first_name (str) – User’s or bot’s first name

• last_name (str) – Optional. User’s or bot’s last name

• username (str) – Optional. User’s or bot’s username

• language_code (str) – Optional. IETF language tag of the user’s language

• is_premium (bool) – Optional. bool, if this user is a Telegram Premium user

• added_to_attachment_menu (bool) – Optional. bool, if this user added the bot to the attachment menu

• can_join_groups (bool) – Optional. True, if the bot can be invited to groups. Returned only in getMe.

• can_read_all_group_messages (bool) – Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.

• supports_inline_queries (bool) – Optional. True, if the bot supports inline queries. Returned only in getMe.

• can_connect_to_business (bool) – Optional. True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe.

Returns:

Instance of the class

Return type:

telebot.types.User

property full_name

User’s full name

Type:

return

class telebot.types.UserChatBoosts(boosts, **kwargs)

Bases: JsonDeserializable

This object represents a list of boosts added to a chat by a user.

Telegram documentation: https://core.telegram.org/bots/api#userchatboosts

Parameters:

boosts (list of ChatBoost) – The list of boosts added to the chat by the user

Returns:

Instance of the class

Return type:

UserChatBoosts

class telebot.types.UserProfilePhotos(total_count, photos=None, **kwargs)

Bases: JsonDeserializable

This object represent a user’s profile pictures.

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

Parameters:

• total_count (int) – Total number of profile pictures the target user has

• photos (list of list of telebot.types.PhotoSize) – Requested profile pictures (in up to 4 sizes each)

Returns:

Instance of the class

Return type:

telebot.types.UserProfilePhotos

class telebot.types.UsersShared(request_id, user_ids: SharedUser, **kwargs)

Bases: JsonDeserializable

This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.

Telegram documentation: https://core.telegram.org/bots/api#usersshared

Parameters:

• request_id (int) – Identifier of the request

• user_ids (list of types.SharedUser) – Array of types.SharedUser of the shared users. These numbers may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting them. But they have at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the users and could be unable to use these identifiers unless the users are already known to the bot by some other means.

Returns:

Instance of the class

Return type:

UsersShared

property user_id

class telebot.types.Venue(location, title, address, foursquare_id=None, foursquare_type=None, google_place_id=None, google_place_type=None, **kwargs)

Bases: JsonDeserializable

This object represents a venue.

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

Parameters:

• location (telebot.types.Location) – Venue location. Can’t be a live location

• title (str) – Name of the venue

• address (str) – Address of the venue

• foursquare_id (str) – Optional. Foursquare identifier of the venue

• foursquare_type (str) – Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)

• google_place_id (str) – Optional. Google Places identifier of the venue

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

Returns:

Instance of the class

Return type:

telebot.types.Venue

class telebot.types.Video(file_id, file_unique_id, width, height, duration, thumbnail=None, file_name=None, mime_type=None, file_size=None, **kwargs)

Bases: JsonDeserializable

This object represents a video file.

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

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• width (int) – Video width as defined by sender

• height (int) – Video height as defined by sender

• duration (int) – Duration of the video in seconds as defined by sender

• thumbnail (telebot.types.PhotoSize) – Optional. Video thumbnail

• file_name (str) – Optional. Original filename as defined by sender

• mime_type (str) – Optional. MIME type of the file as defined by sender

• file_size (int) – Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

Returns:

Instance of the class

Return type:

telebot.types.Video

property thumb

class telebot.types.VideoChatEnded(duration, **kwargs)

Bases: JsonDeserializable

This object represents a service message about a video chat ended in the chat.

Telegram Documentation: https://core.telegram.org/bots/api#videochatended

Parameters:

duration (int) – Video chat duration in seconds

Returns:

Instance of the class

Return type:

telebot.types.VideoChatEnded

class telebot.types.VideoChatParticipantsInvited(users=None, **kwargs)

Bases: JsonDeserializable

This object represents a service message about new members invited to a video chat.

Telegram Documentation: https://core.telegram.org/bots/api#videochatparticipantsinvited

Parameters:

users (list of telebot.types.User) – New members that were invited to the video chat

Returns:

Instance of the class

Return type:

telebot.types.VideoChatParticipantsInvited

class telebot.types.VideoChatScheduled(start_date, **kwargs)

Bases: JsonDeserializable

This object represents a service message about a video chat scheduled in the chat.

Telegram Documentation: https://core.telegram.org/bots/api#videochatscheduled

Parameters:

start_date (int) – Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator

Returns:

Instance of the class

Return type:

telebot.types.VideoChatScheduled

class telebot.types.VideoChatStarted

Bases: JsonDeserializable

This object represents a service message about a video chat started in the chat. Currently holds no information.

class telebot.types.VideoNote(file_id, file_unique_id, length, duration, thumbnail=None, file_size=None, **kwargs)

Bases: JsonDeserializable

This object represents a video message (available in Telegram apps as of v.4.0).

Telegram Documentation: https://core.telegram.org/bots/api#videonote

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• length (int) – Video width and height (diameter of the video message) as defined by sender

• duration (int) – Duration of the video in seconds as defined by sender

• thumbnail (telebot.types.PhotoSize) – Optional. Video thumbnail

• file_size (int) – Optional. File size in bytes

Returns:

Instance of the class

Return type:

telebot.types.VideoNote

property thumb

class telebot.types.Voice(file_id, file_unique_id, duration, mime_type=None, file_size=None, **kwargs)

Bases: JsonDeserializable

This object represents a voice note.

Telegram Documentation: https://core.telegram.org/bots/api#voice

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• duration (int) – Duration of the audio in seconds as defined by sender

• mime_type (str) – Optional. MIME type of the file as defined by sender

• file_size (int) – Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

Returns:

Instance of the class

Return type:

telebot.types.Voice

class telebot.types.VoiceChatEnded(*args, **kwargs)

Bases: VideoChatEnded

Deprecated, use VideoChatEnded instead.

class telebot.types.VoiceChatParticipantsInvited(*args, **kwargs)

Bases: VideoChatParticipantsInvited

Deprecated, use VideoChatParticipantsInvited instead.

class telebot.types.VoiceChatScheduled(*args, **kwargs)

Bases: VideoChatScheduled

Deprecated, use VideoChatScheduled instead.

class telebot.types.VoiceChatStarted

Bases: VideoChatStarted

Deprecated, use VideoChatStarted instead.

class telebot.types.WebAppData(data, button_text, **kwargs)

Bases: JsonDeserializable, Dictionaryable

Describes data sent from a Web App to the bot.

Telegram Documentation: https://core.telegram.org/bots/api#webappdata

Parameters:

• data (str) – The data. Be aware that a bad client can send arbitrary data in this field.

• button_text (str) – Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.

Returns:

Instance of the class

Return type:

telebot.types.WebAppData

class telebot.types.WebAppInfo(url, **kwargs)

Bases: JsonDeserializable, Dictionaryable

Describes a Web App.

Telegram Documentation: https://core.telegram.org/bots/api#webappinfo

Parameters:

url (str) – An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps

Returns:

Instance of the class

Return type:

telebot.types.WebAppInfo

class telebot.types.WebhookInfo(url, has_custom_certificate, pending_update_count, ip_address=None, last_error_date=None, last_error_message=None, last_synchronization_error_date=None, max_connections=None, allowed_updates=None, **kwargs)

Bases: JsonDeserializable

Describes the current status of a webhook.

Telegram Documentation: https://core.telegram.org/bots/api#webhookinfo

Parameters:

• url (str) – Webhook URL, may be empty if webhook is not set up

• has_custom_certificate (bool) – True, if a custom certificate was provided for webhook certificate checks

• pending_update_count (int) – Number of updates awaiting delivery

• ip_address (str) – Optional. Currently used webhook IP address

• last_error_date (int) – Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook

• last_error_message (str) – Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook

• last_synchronization_error_date (int) – Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters

• max_connections (int) – Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery

• allowed_updates (list of str) – Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member

Returns:

Instance of the class

Return type:

telebot.types.WebhookInfo

class telebot.types.WriteAccessAllowed(from_request: bool | None = None, web_app_name: str | None = None, from_attachment_menu: bool | None = None, **kwargs)

Bases: JsonDeserializable

This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.

Telegram documentation: https://core.telegram.org/bots/api#writeaccessallowed

Parameters:

• from_request (bool) – Optional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess

• web_app_name (str) – Optional. Name of the Web App which was launched from a link

• from_attachment_menu (bool) – Optional. True, if the access was granted when the bot was added to the attachment or side menu