Types of API#

class telebot.types.Animation(file_id, file_unique_id, width=None, height=None, duration=None, thumb=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
thumb (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

class telebot.types.Audio(file_id, file_unique_id, duration, performer=None, title=None, file_name=None, mime_type=None, file_size=None, thumb=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.
thumb (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

class telebot.types.BotCommand(command, description)#

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.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) – Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old
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, **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.
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.
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.
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.
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.
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: Optional[bool] = None, can_edit_messages: Optional[bool] = None, can_pin_messages: Optional[bool] = None, can_manage_topics: Optional[bool] = None)#

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

Returns

Instance of the class

Return type

telebot.types.ChatAdministratorRights

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, 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 that sent the join request
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_media_messages=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, **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

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_media_messages=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, **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

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_media_messages=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, **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_media_messages=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, **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_media_messages=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, **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_media_messages=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, **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_media_messages=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, **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_media_messages (bool) – True, if the user is allowed to send audios, documents, photos, videos, video notes and 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, **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.

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_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_media_messages (bool) – Optional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages
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, implies can_send_media_messages
can_add_web_page_previews (bool) – Optional. True, if the user is allowed to add web page previews to their messages, implies can_send_media_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

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.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, thumb=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.
thumb (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

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: Optional[bool] = None, input_field_placeholder: Optional[str] = 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 (has reply_to_message_id), 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: Optional[str] = None)#

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: Optional[str] = None)#

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: Optional[str] = None, icon_custom_emoji_id: Optional[str] = None)#

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.InlineKeyboardButton(text, url=None, callback_data=None, web_app=None, switch_inline_query=None, switch_inline_query_current_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.
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(
    {'text': 'Press me', 'callback_data': 'press'},
    {'text': 'Press me too', 'callback_data': 'press_too'}
)

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

Parameters: inline_keyboard (list of list of telebot.types.InlineKeyboardButton) – list of button rows, each represented by an list of telebot.types.InlineKeyboardButton objects
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, thumb_url=None, thumb_width=None, thumb_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
thumb_url (str) – Optional. Url of the thumbnail for the result
thumb_width (int) – Optional. Thumbnail width
thumb_height (int) – Optional. Thumbnail height

Returns

Instance of the class

Return type

telebot.types.InlineQueryResultArticle

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:

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, thumb_url=None, thumb_width=None, thumb_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
thumb_url (str) – Optional. Url of the thumbnail for the result
thumb_width (int) – Optional. Thumbnail width
thumb_height (int) – Optional. Thumbnail height

Returns

Instance of the class

Return type

telebot.types.InlineQueryResultContact

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, thumb_url=None, thumb_width=None, thumb_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
thumb_url (str) – Optional. URL of the thumbnail (JPEG only) for the file
thumb_width (int) – Optional. Thumbnail width
thumb_height (int) – Optional. Thumbnail height

Returns

Instance of the class

Return type

telebot.types.InlineQueryResultDocument

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, thumb_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, thumb_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
thumb_url (str) – URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
thumb_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

class telebot.types.InlineQueryResultLocation(id, title, latitude, longitude, horizontal_accuracy, live_period=None, reply_markup=None, input_message_content=None, thumb_url=None, thumb_width=None, thumb_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
thumb_url (str) – Optional. Url of the thumbnail for the result
thumb_width (int) – Optional. Thumbnail width
thumb_height (int) – Optional. Thumbnail height

Returns

Instance of the class

Return type

telebot.types.InlineQueryResultLocation

class telebot.types.InlineQueryResultMpeg4Gif(id, mpeg4_url, thumb_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, thumb_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
thumb_url (str) – URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
thumb_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

class telebot.types.InlineQueryResultPhoto(id, photo_url, thumb_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
thumb_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

class telebot.types.InlineQueryResultVenue(id, title, latitude, longitude, address, foursquare_id=None, foursquare_type=None, reply_markup=None, input_message_content=None, thumb_url=None, thumb_width=None, thumb_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
thumb_url (str) – Optional. Url of the thumbnail for the result
thumb_width (int) – Optional. Thumbnail width
thumb_height (int) – Optional. Thumbnail height

Returns

Instance of the class

Return type

telebot.types.InlineQueryResultVenue

class telebot.types.InlineQueryResultVideo(id, video_url, mime_type, thumb_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”
thumb_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

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.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, thumb=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 »
thumb (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

class telebot.types.InputMediaAudio(media, thumb=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 »
thumb (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

class telebot.types.InputMediaDocument(media, thumb=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 »
thumb (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

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, thumb=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 »
thumb (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

class telebot.types.InputTextMessageContent(message_text, parse_mode=None, entities=None, disable_web_page_preview=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) – Optional. Disables link previews for links in the sent 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: Optional[bool] = None, request_location: Optional[bool] = None, request_poll: Optional[KeyboardButtonPollType] = None, web_app: Optional[WebAppInfo] = 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.

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.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.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)#

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)#

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)#

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.
date (int) – Date the message was sent in Unix time
chat (telebot.types.Chat) – Conversation the message belongs to
forward_from (telebot.types.User) – Optional. For forwarded messages, sender of the original message
forward_from_chat (telebot.types.Chat) – Optional. For messages forwarded from channels or from anonymous administrators, information about the original sender chat
forward_from_message_id (int) – Optional. For messages forwarded from channels, identifier of the original message in the channel
forward_signature (str) – Optional. For forwarded messages that were originally sent in channels or by an anonymous chat administrator, signature of the message sender if present
forward_sender_name (str) – Optional. Sender’s name for messages forwarded from users who disallow adding a link to their account in forwarded messages
forward_date (int) – Optional. For forwarded messages, date the original message was sent in Unix time
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.
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
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
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
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) – 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 »
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.
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
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.

Returns

Instance of the class

Return type

telebot.types.Message

property html_caption#: Returns html-rendered caption.

property html_text#: Returns html-rendered text.

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.

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) → Optional[List[Dict]]#: 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.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, user, option_ids, **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
user (telebot.types.User) – 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.ReplyKeyboardMarkup(resize_keyboard: Optional[bool] = None, one_time_keyboard: Optional[bool] = None, selective: Optional[bool] = None, row_width: int = 3, input_field_placeholder: Optional[str] = None, is_persistent: Optional[bool] = 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 (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.
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.SentWebAppMessage(inline_message_id=None)#

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.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, thumb=None, emoji=None, set_name=None, mask_position=None, file_size=None, premium_animation=None, custom_emoji_id=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
thumb (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
file_size (int) – Optional. File size in bytes

Returns

Instance of the class

Return type

telebot.types.Sticker

class telebot.types.StickerSet(name, title, sticker_type, is_animated, is_video, stickers, thumb=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”
is_animated (bool) – True, if the sticker set contains animated stickers
is_video (bool) – True, if the sticker set contains video stickers
contains_masks (bool) – True, if the sticker set contains masks. Deprecated since Bot API 6.2, use sticker_type instead.
stickers (list of telebot.types.Sticker) – List of all set stickers
thumb (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.

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.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)#

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
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.

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, **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.

Returns

Instance of the class

Return type

telebot.types.User

property full_name#

User’s full name

Type: return

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.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, thumb=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
thumb (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

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, thumb=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
thumb (telebot.types.PhotoSize) – Optional. Video thumbnail
file_size (int) – Optional. File size in bytes

Returns

Instance of the class

Return type

telebot.types.VideoNote

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)#

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#

Bases: JsonDeserializable

This object represents a service message about a user allowed to post messages in the chat. Currently holds no information.

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