telegram.constants Module¶
This module contains several constants that are relevant for working with the Bot API.
Unless noted otherwise, all constants in this module were extracted from the Telegram Bots FAQ and Telegram Bots API.
Most of the following constants are related to specific classes or topics and are grouped into enums. If they are related to a specific class, then they are also available as attributes of those classes.
Changed in version 20.0:
Most of the constants in this module are grouped into enums.
- class telegram.constants.AccentColor(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
Enum
This enum contains the available accent colors for
telegram.ChatFullInfo.accent_color_id
. The members of this enum are named tuples with the following attributes:identifier
(int
): The identifier of the accent color.name
(str
): Optional. The name of the accent color.light_colors
(tuple[str
]): Optional. The light colors of the accent color as HEX value.dark_colors
(tuple[str
]): Optional. The dark colors of the accent color as HEX value.
Since Telegram gives no exact specification for the accent colors, future accent colors might have a different data type.
Added in version 20.8.
- COLOR_001 = (1, 'orange', (), ())[source]¶
Accent color 1. This color can be customized by app themes.
- COLOR_002 = (2, 'purple/violet', (), ())[source]¶
Accent color 2. This color can be customized by app themes.
- COLOR_003 = (3, 'green', (), ())[source]¶
Accent color 3. This color can be customized by app themes.
- COLOR_004 = (4, 'cyan', (), ())[source]¶
Accent color 4. This color can be customized by app themes.
- COLOR_005 = (5, 'blue', (), ())[source]¶
Accent color 5. This color can be customized by app themes.
- COLOR_006 = (6, 'pink', (), ())[source]¶
Accent color 6. This color can be customized by app themes.
- COLOR_007 = (7, None, (14766162, 16363107), (16749440, 10039095))[source]¶
Accent color 7. This contains two light colors
and two dark colors
- COLOR_008 = (8, None, (14712875, 16434484), (15511630, 12801812))[source]¶
Accent color 8. This contains two light colors
and two dark colors
- COLOR_009 = (9, None, (10510323, 16027647), (13015039, 6173128))[source]¶
Accent color 9. This contains two light colors
and two dark colors
- COLOR_010 = (10, None, (2599184, 11000919), (11004782, 1474093))[source]¶
Accent color 10. This contains two light colors
and two dark colors
- COLOR_011 = (11, None, (2600142, 8579286), (4249808, 285823))[source]¶
Accent color 11. This contains two light colors
and two dark colors
- COLOR_012 = (12, None, (3379668, 8246256), (5423103, 742548))[source]¶
Accent color 12. This contains two light colors
and two dark colors
- COLOR_013 = (13, None, (14500721, 16760479), (16746150, 9320046))[source]¶
Accent color 13. This contains two light colors
and two dark colors
- COLOR_014 = (14, None, (2391021, 15747158, 16777215), (4170494, 15024719, 16777215))[source]¶
Accent color 14. This contains three light colors
and three dark colors
- COLOR_015 = (15, None, (14055202, 2007057, 16777215), (16748638, 3319079, 16777215))[source]¶
Accent color 15. This contains three light colors
and three dark colors
- COLOR_016 = (16, None, (1547842, 15223359, 16777215), (6738788, 13976655, 16777215))[source]¶
Accent color 16. This contains three light colors
and three dark colors
- COLOR_017 = (17, None, (2659503, 7324758, 16777215), (2276578, 4039232, 16777215))[source]¶
Accent color 17. This contains three light colors
and three dark colors
- COLOR_018 = (18, None, (826035, 16756117, 16770741), (2276578, 16750456, 16767595))[source]¶
Accent color 18. This contains three light colors
and three dark colors
- telegram.constants.BOT_API_VERSION = '7.11'[source]¶
Telegram Bot API version supported by this version of python-telegram-bot. Also available as
telegram.__bot_api_version__
.Added in version 13.4.
- Type:
- telegram.constants.BOT_API_VERSION_INFO = (7, 11)[source]¶
The components can also be accessed by name, so
BOT_API_VERSION_INFO[0]
is equivalent toBOT_API_VERSION_INFO.major
and so on. Also available astelegram.__bot_api_version_info__
.Added in version 20.0.
- class telegram.constants.BackgroundFillLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.BackgroundFillGradient
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 21.2.
- MAX_ROTATION_ANGLE = 359[source]¶
Maximum value allowed for:
rotation_angle
parameter oftelegram.BackgroundFillGradient
- Type:
- class telegram.constants.BackgroundFillType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.BackgroundFill
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 21.2.
- FREEFORM_GRADIENT = 'freeform_gradient'[source]¶
A
telegram.BackgroundFill
with freeform_gradient fill.- Type:
- GRADIENT = 'gradient'[source]¶
A
telegram.BackgroundFill
with gradient fill.- Type:
- SOLID = 'solid'[source]¶
A
telegram.BackgroundFill
with solid fill.- Type:
- class telegram.constants.BackgroundTypeLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.BackgroundTypeFill
,telegram.BackgroundTypeWallpaper
andtelegram.BackgroundTypePattern
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 21.2.
- MAX_DIMMING = 100[source]¶
Maximum value allowed for:
dark_theme_dimming
parameter of
dark_theme_dimming
parameter of
- Type:
- MAX_INTENSITY = 100[source]¶
Maximum value allowed for
intensity
parameter oftelegram.BackgroundTypePattern
- Type:
- class telegram.constants.BackgroundTypeType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.BackgroundType
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 21.2.
- CHAT_THEME = 'chat_theme'[source]¶
A
telegram.BackgroundType
with chat_theme background.- Type:
- FILL = 'fill'[source]¶
A
telegram.BackgroundType
with fill background.- Type:
- PATTERN = 'pattern'[source]¶
A
telegram.BackgroundType
with pattern background.- Type:
- WALLPAPER = 'wallpaper'[source]¶
A
telegram.BackgroundType
with wallpaper background.- Type:
- class telegram.constants.BotCommandLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.BotCommand
andtelegram.Bot.set_my_commands()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_COMMAND = 32[source]¶
Maximum value allowed for
command
parameter oftelegram.BotCommand
.- Type:
- MAX_COMMAND_NUMBER = 100[source]¶
Maximum number of bot commands passed in a
list
to thecommands
parameter oftelegram.Bot.set_my_commands()
.- Type:
- MAX_DESCRIPTION = 256[source]¶
Maximum value allowed for
description
parameter oftelegram.BotCommand
.- Type:
- MIN_COMMAND = 1[source]¶
Minimum value allowed for
command
parameter oftelegram.BotCommand
.- Type:
- MIN_DESCRIPTION = 1[source]¶
Minimum value allowed for
description
parameter oftelegram.BotCommand
.- Type:
- class telegram.constants.BotCommandScopeType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.BotCommandScope
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- ALL_CHAT_ADMINISTRATORS = 'all_chat_administrators'[source]¶
The type of
telegram.BotCommandScopeAllChatAdministrators
.- Type:
- ALL_GROUP_CHATS = 'all_group_chats'[source]¶
The type of
telegram.BotCommandScopeAllGroupChats
.- Type:
- ALL_PRIVATE_CHATS = 'all_private_chats'[source]¶
The type of
telegram.BotCommandScopeAllPrivateChats
.- Type:
- CHAT = 'chat'[source]¶
The type of
telegram.BotCommandScopeChat
.- Type:
- CHAT_ADMINISTRATORS = 'chat_administrators'[source]¶
The type of
telegram.BotCommandScopeChatAdministrators
.- Type:
- CHAT_MEMBER = 'chat_member'[source]¶
The type of
telegram.BotCommandScopeChatMember
.- Type:
- DEFAULT = 'default'[source]¶
The type of
telegram.BotCommandScopeDefault
.- Type:
- class telegram.constants.BotDescriptionLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for the methods
telegram.Bot.set_my_description()
andtelegram.Bot.set_my_short_description()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.2.
- MAX_DESCRIPTION_LENGTH = 512[source]¶
Maximum length for the parameter
description
oftelegram.Bot.set_my_description()
- Type:
- MAX_SHORT_DESCRIPTION_LENGTH = 120[source]¶
Maximum length for the parameter
short_description
oftelegram.Bot.set_my_short_description()
- Type:
- class telegram.constants.BotNameLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for the methods
telegram.Bot.set_my_name()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.3.
- MAX_NAME_LENGTH = 64[source]¶
Maximum length for the parameter
name
oftelegram.Bot.set_my_name()
- Type:
- class telegram.constants.BulkRequestLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.delete_messages()
,telegram.Bot.forward_messages()
andtelegram.Bot.copy_messages()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.8.
- class telegram.constants.CallbackQueryLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.CallbackQuery
/telegram.Bot.answer_callback_query()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- class telegram.constants.ChatAction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available chat actions for
telegram.Bot.send_chat_action()
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- CHOOSE_STICKER = 'choose_sticker'[source]¶
Chat action indicating that the bot is selecting a sticker.
- Type:
- FIND_LOCATION = 'find_location'[source]¶
Chat action indicating that the bot is selecting a location.
- Type:
- RECORD_VIDEO = 'record_video'[source]¶
Chat action indicating that the bot is recording a video.
- Type:
- RECORD_VIDEO_NOTE = 'record_video_note'[source]¶
Chat action indicating that the bot is recording a video note.
- Type:
- RECORD_VOICE = 'record_voice'[source]¶
Chat action indicating that the bot is recording a voice message.
- Type:
- UPLOAD_DOCUMENT = 'upload_document'[source]¶
Chat action indicating that the bot is uploading a document.
- Type:
- UPLOAD_PHOTO = 'upload_photo'[source]¶
Chat action indicating that the bot is uploading a photo.
- Type:
- UPLOAD_VIDEO = 'upload_video'[source]¶
Chat action indicating that the bot is uploading a video.
- Type:
- class telegram.constants.ChatBoostSources(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available sources for a
Telegram chat boost
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.8.
- GIFT_CODE = 'gift_code'[source]¶
The source of the chat boost was a Telegram Premium gift code.
- Type:
- class telegram.constants.ChatID(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains some special chat IDs. The enum members of this enumeration are instances of
int
and can be treated as such.Added in version 20.0.
- ANONYMOUS_ADMIN = 1087968824[source]¶
User ID in groups for messages sent by anonymous admins. Telegram chat: @GroupAnonymousBot.
Note
telegram.Message.from_user
will contain this ID for backwards compatibility only. It’s recommended to usetelegram.Message.sender_chat
instead.- Type:
- FAKE_CHANNEL = 136817688[source]¶
User ID in groups when message is sent on behalf of a channel, or when a channel votes on a poll. Telegram chat: @Channel_Bot.
Note
telegram.Message.from_user
will contain this ID for backwards compatibility only. It’s recommended to usetelegram.Message.sender_chat
instead.telegram.PollAnswer.user
will contain this ID for backwards compatibility only. It’s recommended to usetelegram.PollAnswer.voter_chat
instead.
- Type:
- SERVICE_CHAT = 777000[source]¶
Telegram service chat, that also acts as sender of channel posts forwarded to discussion groups. Telegram chat: Telegram.
Note
telegram.Message.from_user
will contain this ID for backwards compatibility only. It’s recommended to usetelegram.Message.sender_chat
instead.- Type:
- class telegram.constants.ChatInviteLinkLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.ChatInviteLink
/telegram.Bot.create_chat_invite_link()
/telegram.Bot.edit_chat_invite_link()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_MEMBER_LIMIT = 99999[source]¶
Maximum value allowed for the
member_limit
parameter oftelegram.Bot.create_chat_invite_link()
andmember_limit
oftelegram.Bot.edit_chat_invite_link()
.- Type:
- MIN_MEMBER_LIMIT = 1[source]¶
Minimum value allowed for the
member_limit
parameter oftelegram.Bot.create_chat_invite_link()
andmember_limit
oftelegram.Bot.edit_chat_invite_link()
.- Type:
- NAME_LENGTH = 32[source]¶
Maximum number of characters in a
str
passed as thename
parameter oftelegram.Bot.create_chat_invite_link()
andname
oftelegram.Bot.edit_chat_invite_link()
.- Type:
- class telegram.constants.ChatLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.set_chat_administrator_custom_title()
,telegram.Bot.set_chat_description()
, andtelegram.Bot.set_chat_title()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- CHAT_ADMINISTRATOR_CUSTOM_TITLE_LENGTH = 16[source]¶
Maximum length of a
str
passed as thecustom_title
parameter oftelegram.Bot.set_chat_administrator_custom_title()
.- Type:
- CHAT_DESCRIPTION_LENGTH = 255[source]¶
Maximum number of characters in a
str
passed as thedescription
parameter oftelegram.Bot.set_chat_description()
.- Type:
- MAX_CHAT_TITLE_LENGTH = 128[source]¶
Maximum length of a
str
passed as thetitle
parameter oftelegram.Bot.set_chat_title()
.- Type:
- class telegram.constants.ChatMemberStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available states for
telegram.ChatMember
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- ADMINISTRATOR = 'administrator'[source]¶
A
telegram.ChatMember
who is administrator of the chat.- Type:
- BANNED = 'kicked'[source]¶
A
telegram.ChatMember
who was banned in the chat.- Type:
- LEFT = 'left'[source]¶
A
telegram.ChatMember
who has left the chat.- Type:
- MEMBER = 'member'[source]¶
A
telegram.ChatMember
who is a member of the chat.- Type:
- OWNER = 'creator'[source]¶
A
telegram.ChatMember
who is the owner of the chat.- Type:
- RESTRICTED = 'restricted'[source]¶
A
telegram.ChatMember
who was restricted in this chat.- Type:
- class telegram.constants.ChatPhotoSize(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.ChatPhoto
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- BIG = 640[source]¶
Width and height of a big chat photo, ID of which is passed in
big_file_id
andbig_file_unique_id
parameters oftelegram.ChatPhoto
.- Type:
- SMALL = 160[source]¶
Width and height of a small chat photo, ID of which is passed in
small_file_id
andsmall_file_unique_id
parameters oftelegram.ChatPhoto
.- Type:
- class telegram.constants.ChatSubscriptionLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.create_chat_subscription_invite_link.subscription_period
andtelegram.Bot.create_chat_subscription_invite_link.subscription_price
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 21.5.
- MAX_PRICE = 2500[source]¶
Amount of stars a user pays, maximum amount the subscription can be set to.
- Type:
- class telegram.constants.ChatType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.Chat
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- CHANNEL = 'channel'[source]¶
A
telegram.Chat
that is a channel.- Type:
- GROUP = 'group'[source]¶
A
telegram.Chat
that is a group.- Type:
- PRIVATE = 'private'[source]¶
A
telegram.Chat
that is private.- Type:
- SENDER = 'sender'[source]¶
A
telegram.Chat
that represents the chat of atelegram.User
sending antelegram.InlineQuery
.- Type:
- SUPERGROUP = 'supergroup'[source]¶
A
telegram.Chat
that is a supergroup.- Type:
- class telegram.constants.ContactLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.InlineQueryResultContact
,telegram.InputContactMessageContent
, andtelegram.Bot.send_contact()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- VCARD = 2048[source]¶
Maximum value allowed for:
vcard
parameter ofsend_contact()
vcard
parameter ofInlineQueryResultContact
vcard
parameter ofInputContactMessageContent
- Type:
- class telegram.constants.CustomEmojiStickerLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.get_custom_emoji_stickers()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- CUSTOM_EMOJI_IDENTIFIER_LIMIT = 200[source]¶
Maximum amount of custom emoji identifiers which can be specified for the
custom_emoji_ids
parameter oftelegram.Bot.get_custom_emoji_stickers()
.- Type:
- class telegram.constants.DiceEmoji(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available emoji for
telegram.Dice
/telegram.Bot.send_dice()
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- BASKETBALL = '🏀'[source]¶
A
telegram.Dice
with the emoji🏀
.- Type:
- BOWLING = '🎳'[source]¶
A
telegram.Dice
with the emoji🎳
.- Type:
- DARTS = '🎯'[source]¶
A
telegram.Dice
with the emoji🎯
.- Type:
- DICE = '🎲'[source]¶
A
telegram.Dice
with the emoji🎲
.- Type:
- FOOTBALL = '⚽'[source]¶
A
telegram.Dice
with the emoji⚽
.- Type:
- SLOT_MACHINE = '🎰'[source]¶
A
telegram.Dice
with the emoji🎰
.- Type:
- class telegram.constants.DiceLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Dice
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_VALUE_BASKETBALL = 5[source]¶
Maximum value allowed for
value
parameter oftelegram.Dice
ifemoji
is'🏀'
.- Type:
- MAX_VALUE_BOWLING = 6[source]¶
Maximum value allowed for
value
parameter oftelegram.Dice
ifemoji
is'🎳'
.- Type:
- MAX_VALUE_DARTS = 6[source]¶
Maximum value allowed for
value
parameter oftelegram.Dice
ifemoji
is'🎯'
.- Type:
- MAX_VALUE_DICE = 6[source]¶
Maximum value allowed for
value
parameter oftelegram.Dice
ifemoji
is'🎲'
.- Type:
- MAX_VALUE_FOOTBALL = 5[source]¶
Maximum value allowed for
value
parameter oftelegram.Dice
ifemoji
is'⚽'
.- Type:
- MAX_VALUE_SLOT_MACHINE = 64[source]¶
Maximum value allowed for
value
parameter oftelegram.Dice
ifemoji
is'🎰'
.- Type:
- MIN_VALUE = 1[source]¶
Minimum value allowed for
value
parameter oftelegram.Dice
(any emoji).- Type:
- class telegram.constants.FileSizeLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations regarding the upload and download of files. The enum members of this enumeration are instances of
int
and can be treated as such.Added in version 20.0.
- FILESIZE_DOWNLOAD_LOCAL_MODE = 9223372036854775807[source]¶
Bots can download files without a size limit when using a local bot API server.
- Type:
- FILESIZE_UPLOAD_LOCAL_MODE = 2000000000[source]¶
Bots can upload non-photo files of up to 2000MB in size when using a local bot API server.
- Type:
- VOICE_NOTE_FILE_SIZE = 1000000[source]¶
File size limit for the
send_voice()
method oftelegram.Bot
. Bots can send audio/ogg files of up to 1MB in size as a voice note. Larger voice notes (up to 20MB) will be sent as files.- Type:
- class telegram.constants.FloodLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations regarding flood limits. The enum members of this enumeration are instances of
int
and can be treated as such.Added in version 20.0.
- MESSAGES_PER_MINUTE_PER_GROUP = 20[source]¶
The number of messages that can roughly be sent to a particular group within one minute.
- Type:
- MESSAGES_PER_SECOND = 30[source]¶
The number of messages that can roughly be sent in an interval of 30 seconds across all chats.
- Type:
- MESSAGES_PER_SECOND_PER_CHAT = 1[source]¶
The number of messages that can be sent per second in a particular chat. Telegram may allow short bursts that go over this limit, but eventually you’ll begin receiving 429 errors.
- Type:
- PAID_MESSAGES_PER_SECOND = 1000[source]¶
The number of messages that can be sent per second when paying with the bot’s Telegram Star balance. See e.g. parameter
allow_paid_broadcast
ofsend_message()
.Added in version 21.7.
- Type:
- class telegram.constants.ForumIconColor(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains the available colors for use in
telegram.Bot.create_forum_topic.icon_color
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- class telegram.constants.ForumTopicLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.create_forum_topic.name
andtelegram.Bot.edit_forum_topic.name
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_NAME_LENGTH = 128[source]¶
Maximum length of a
str
passed as:name
parameter oftelegram.Bot.create_forum_topic()
name
parameter oftelegram.Bot.edit_forum_topic()
name
parameter oftelegram.Bot.edit_general_forum_topic()
- Type:
- MIN_NAME_LENGTH = 1[source]¶
Minimum length of a
str
passed as:name
parameter oftelegram.Bot.create_forum_topic()
name
parameter oftelegram.Bot.edit_forum_topic()
name
parameter oftelegram.Bot.edit_general_forum_topic()
- Type:
- class telegram.constants.GiveawayLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Giveaway
and related classes. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.8.
- MAX_WINNERS = 100[source]¶
Maximum number of winners allowed for
telegram.GiveawayWinners.winners
.- Type:
- class telegram.constants.InlineKeyboardButtonLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.InlineKeyboardButton
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_CALLBACK_DATA = 64[source]¶
Maximum length allowed for
callback_data
parameter oftelegram.InlineKeyboardButton
- Type:
- MAX_COPY_TEXT = 256[source]¶
Maximum length allowed for
text
parameter oftelegram.CopyTextButton
- Type:
- MIN_CALLBACK_DATA = 1[source]¶
Minimum length allowed for
callback_data
parameter oftelegram.InlineKeyboardButton
- Type:
- MIN_COPY_TEXT = 1[source]¶
Minimum length allowed for
text
parameter oftelegram.CopyTextButton
- Type:
- class telegram.constants.InlineKeyboardMarkupLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.InlineKeyboardMarkup
/telegram.Bot.send_message()
& friends. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- class telegram.constants.InlineQueryLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.InlineQuery
/telegram.Bot.answer_inline_query()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_OFFSET_LENGTH = 64[source]¶
Maximum number of bytes in a
str
passed as thenext_offset
parameter oftelegram.Bot.answer_inline_query()
.- Type:
- MAX_QUERY_LENGTH = 256[source]¶
Maximum number of characters in a
str
passed as thequery
parameter oftelegram.InlineQuery
.- Type:
- MAX_SWITCH_PM_TEXT_LENGTH = 64[source]¶
Maximum number of characters in a
str
passed as theswitch_pm_parameter
parameter oftelegram.Bot.answer_inline_query()
.Deprecated since version 20.3: Deprecated in favor of
InlineQueryResultsButtonLimit.MAX_START_PARAMETER_LENGTH
.- Type:
- MIN_SWITCH_PM_TEXT_LENGTH = 1[source]¶
Minimum number of characters in a
str
passed as theswitch_pm_parameter
parameter oftelegram.Bot.answer_inline_query()
.Deprecated since version 20.3: Deprecated in favor of
InlineQueryResultsButtonLimit.MIN_START_PARAMETER_LENGTH
.- Type:
- RESULTS = 50[source]¶
Maximum number of results that can be passed to
telegram.Bot.answer_inline_query()
.- Type:
- class telegram.constants.InlineQueryResultLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.InlineQueryResult
and its subclasses. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_ID_LENGTH = 64[source]¶
Maximum number of bytes in a
str
passed as theid
parameter oftelegram.InlineQueryResult
and its subclasses- Type:
- class telegram.constants.InlineQueryResultType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.InlineQueryResult
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- ARTICLE = 'article'[source]¶
Type of
telegram.InlineQueryResultArticle
.- Type:
- AUDIO = 'audio'[source]¶
Type of
telegram.InlineQueryResultAudio
andtelegram.InlineQueryResultCachedAudio
.- Type:
- CONTACT = 'contact'[source]¶
Type of
telegram.InlineQueryResultContact
.- Type:
- DOCUMENT = 'document'[source]¶
Type of
telegram.InlineQueryResultDocument
andtelegram.InlineQueryResultCachedDocument
.- Type:
- GAME = 'game'[source]¶
Type of
telegram.InlineQueryResultGame
.- Type:
- GIF = 'gif'[source]¶
Type of
telegram.InlineQueryResultGif
andtelegram.InlineQueryResultCachedGif
.- Type:
- LOCATION = 'location'[source]¶
Type of
telegram.InlineQueryResultLocation
.- Type:
- MPEG4GIF = 'mpeg4_gif'[source]¶
Type of
telegram.InlineQueryResultMpeg4Gif
andtelegram.InlineQueryResultCachedMpeg4Gif
.- Type:
- PHOTO = 'photo'[source]¶
Type of
telegram.InlineQueryResultPhoto
andtelegram.InlineQueryResultCachedPhoto
.- Type:
- STICKER = 'sticker'[source]¶
Type of and
telegram.InlineQueryResultCachedSticker
.- Type:
- VENUE = 'venue'[source]¶
Type of
telegram.InlineQueryResultVenue
.- Type:
- VIDEO = 'video'[source]¶
Type of
telegram.InlineQueryResultVideo
andtelegram.InlineQueryResultCachedVideo
.- Type:
- VOICE = 'voice'[source]¶
Type of
telegram.InlineQueryResultVoice
andtelegram.InlineQueryResultCachedVoice
.- Type:
- class telegram.constants.InlineQueryResultsButtonLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.InlineQueryResultsButton
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.3.
- MAX_START_PARAMETER_LENGTH = 64[source]¶
Maximum number of characters in a
str
passed as thestart_parameter
parameter oftelegram.InlineQueryResultsButton()
.- Type:
- MIN_START_PARAMETER_LENGTH = 1[source]¶
Minimum number of characters in a
str
passed as thestart_parameter
parameter oftelegram.InlineQueryResultsButton()
.- Type:
- class telegram.constants.InputMediaType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.InputMedia
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- ANIMATION = 'animation'[source]¶
Type of
telegram.InputMediaAnimation
.- Type:
- AUDIO = 'audio'[source]¶
Type of
telegram.InputMediaAudio
.- Type:
- DOCUMENT = 'document'[source]¶
Type of
telegram.InputMediaDocument
.- Type:
- PHOTO = 'photo'[source]¶
Type of
telegram.InputMediaPhoto
.- Type:
- VIDEO = 'video'[source]¶
Type of
telegram.InputMediaVideo
.- Type:
- class telegram.constants.InputPaidMediaType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.InputPaidMedia
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 21.4.
- PHOTO = 'photo'[source]¶
Type of
telegram.InputMediaPhoto
.- Type:
- VIDEO = 'video'[source]¶
Type of
telegram.InputMediaVideo
.- Type:
- class telegram.constants.InvoiceLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.InputInvoiceMessageContent
,telegram.Bot.send_invoice()
, andtelegram.Bot.create_invoice_link()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_DESCRIPTION_LENGTH = 255[source]¶
Maximum number of characters in a
str
passed as:description
parameter oftelegram.InputInvoiceMessageContent
description
parameter oftelegram.Bot.send_invoice()
.description
parameter oftelegram.Bot.create_invoice_link()
.
- Type:
- MAX_PAYLOAD_LENGTH = 128[source]¶
Maximum amount of bytes in a
str
passed as:payload
parameter oftelegram.InputInvoiceMessageContent
payload
parameter oftelegram.Bot.send_invoice()
.payload
parameter oftelegram.Bot.create_invoice_link()
.payload
parameter oftelegram.Bot.send_paid_media()
.
- Type:
- MAX_STAR_COUNT = 2500[source]¶
Maximum amount of starts that must be paid to buy access to a paid media passed as
star_count
parameter oftelegram.Bot.send_paid_media()
.Added in version 21.6.
- Type:
- MAX_TIP_AMOUNTS = 4[source]¶
Maximum length of a
Sequence
passed as:suggested_tip_amounts
parameter oftelegram.Bot.send_invoice()
.suggested_tip_amounts
parameter oftelegram.Bot.create_invoice_link()
.
- Type:
- MAX_TITLE_LENGTH = 32[source]¶
Maximum number of characters in a
str
passed as:title
parameter oftelegram.InputInvoiceMessageContent
title
parameter oftelegram.Bot.send_invoice()
.title
parameter oftelegram.Bot.create_invoice_link()
.
- Type:
- MIN_DESCRIPTION_LENGTH = 1[source]¶
Minimum number of characters in a
str
passed as:description
parameter oftelegram.InputInvoiceMessageContent
description
parameter oftelegram.Bot.send_invoice()
.description
parameter oftelegram.Bot.create_invoice_link()
.
- Type:
- MIN_PAYLOAD_LENGTH = 1[source]¶
Minimum amount of bytes in a
str
passed as:payload
parameter oftelegram.InputInvoiceMessageContent
payload
parameter oftelegram.Bot.send_invoice()
.payload
parameter oftelegram.Bot.create_invoice_link()
.
- Type:
- MIN_STAR_COUNT = 1[source]¶
Minimum amount of starts that must be paid to buy access to a paid media passed as
star_count
parameter oftelegram.Bot.send_paid_media()
.Added in version 21.6.
- Type:
- MIN_TITLE_LENGTH = 1[source]¶
Minimum number of characters in a
str
passed as:title
parameter oftelegram.InputInvoiceMessageContent
title
parameter oftelegram.Bot.send_invoice()
.title
parameter oftelegram.Bot.create_invoice_link()
.
- Type:
- class telegram.constants.KeyboardButtonRequestUsersLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.KeyboardButtonRequestUsers
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.8.
- MAX_QUANTITY = 10[source]¶
Maximum value allowed for
max_quantity
parameter oftelegram.KeyboardButtonRequestUsers
.- Type:
- MIN_QUANTITY = 1[source]¶
Minimum value allowed for
max_quantity
parameter oftelegram.KeyboardButtonRequestUsers
.- Type:
- class telegram.constants.LocationLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Location
/telegram.ChatLocation
/telegram.Bot.edit_message_live_location()
/telegram.Bot.send_location()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- HORIZONTAL_ACCURACY = 1500[source]¶
Maximum value allowed for:
horizontal_accuracy
parameter oftelegram.Location
horizontal_accuracy
parameter oftelegram.InlineQueryResultLocation
horizontal_accuracy
parameter oftelegram.InputLocationMessageContent
horizontal_accuracy
parameter oftelegram.Bot.edit_message_live_location()
horizontal_accuracy
parameter oftelegram.Bot.send_location()
- Type:
- LIVE_PERIOD_FOREVER = 2147483647[source]¶
Value for live locations that can be edited indefinitely. Passed in:
live_period
parameter oftelegram.InlineQueryResultLocation
live_period
parameter oftelegram.InputLocationMessageContent
live_period
parameter oftelegram.Bot.edit_message_live_location()
live_period
parameter oftelegram.Bot.send_location()
Added in version 21.2.
- Type:
- MAX_CHAT_LOCATION_ADDRESS = 64[source]¶
Minimum value allowed for
address
parameter oftelegram.ChatLocation
- Type:
- MAX_HEADING = 360[source]¶
Maximum value allowed for:
heading
parameter oftelegram.Location
heading
parameter oftelegram.InlineQueryResultLocation
heading
parameter oftelegram.InputLocationMessageContent
heading
parameter oftelegram.Bot.edit_message_live_location()
heading
parameter oftelegram.Bot.send_location()
- Type:
- MAX_LIVE_PERIOD = 86400[source]¶
Maximum value allowed for:
live_period
parameter oftelegram.InlineQueryResultLocation
live_period
parameter oftelegram.InputLocationMessageContent
live_period
parameter oftelegram.Bot.edit_message_live_location()
live_period
parameter oftelegram.Bot.send_location()
- Type:
- MAX_PROXIMITY_ALERT_RADIUS = 100000[source]¶
Maximum value allowed for:
proximity_alert_radius
parameter oftelegram.InlineQueryResultLocation
proximity_alert_radius
parameter oftelegram.InputLocationMessageContent
proximity_alert_radius
parameter oftelegram.Bot.edit_message_live_location()
proximity_alert_radius
parameter oftelegram.Bot.send_location()
- Type:
- MIN_CHAT_LOCATION_ADDRESS = 1[source]¶
Minimum value allowed for
address
parameter oftelegram.ChatLocation
- Type:
- MIN_HEADING = 1[source]¶
Minimum value allowed for:
heading
parameter oftelegram.Location
heading
parameter oftelegram.InlineQueryResultLocation
heading
parameter oftelegram.InputLocationMessageContent
heading
parameter oftelegram.Bot.edit_message_live_location()
heading
parameter oftelegram.Bot.send_location()
- Type:
- MIN_LIVE_PERIOD = 60[source]¶
Minimum value allowed for:
live_period
parameter oftelegram.InlineQueryResultLocation
live_period
parameter oftelegram.InputLocationMessageContent
live_period
parameter oftelegram.Bot.edit_message_live_location()
live_period
parameter oftelegram.Bot.send_location()
- Type:
- MIN_PROXIMITY_ALERT_RADIUS = 1[source]¶
Minimum value allowed for:
proximity_alert_radius
parameter oftelegram.InlineQueryResultLocation
proximity_alert_radius
parameter oftelegram.InputLocationMessageContent
proximity_alert_radius
parameter oftelegram.Bot.edit_message_live_location()
proximity_alert_radius
parameter oftelegram.Bot.send_location()
- Type:
- class telegram.constants.MaskPosition(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available positions for
telegram.MaskPosition
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- class telegram.constants.MediaGroupLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.send_media_group()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_MEDIA_LENGTH = 10[source]¶
Maximum length of a
list
passed as themedia
parameter oftelegram.Bot.send_media_group()
.- Type:
- class telegram.constants.MenuButtonType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.MenuButton
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- COMMANDS = 'commands'[source]¶
The type of
telegram.MenuButtonCommands
.- Type:
- DEFAULT = 'default'[source]¶
The type of
telegram.MenuButtonDefault
.- Type:
- WEB_APP = 'web_app'[source]¶
The type of
telegram.MenuButtonWebApp
.- Type:
- class telegram.constants.MessageAttachmentType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.Message
that can be seen as attachment. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- ANIMATION = 'animation'[source]¶
Messages with
telegram.Message.animation
.- Type:
- AUDIO = 'audio'[source]¶
Messages with
telegram.Message.audio
.- Type:
- CONTACT = 'contact'[source]¶
Messages with
telegram.Message.contact
.- Type:
- DICE = 'dice'[source]¶
Messages with
telegram.Message.dice
.- Type:
- DOCUMENT = 'document'[source]¶
Messages with
telegram.Message.document
.- Type:
- GAME = 'game'[source]¶
Messages with
telegram.Message.game
.- Type:
- INVOICE = 'invoice'[source]¶
Messages with
telegram.Message.invoice
.- Type:
- LOCATION = 'location'[source]¶
Messages with
telegram.Message.location
.- Type:
- PAID_MEDIA = 'paid_media'[source]¶
Messages with
telegram.Message.paid_media
.Added in version 21.4.
- Type:
- PASSPORT_DATA = 'passport_data'[source]¶
Messages with
telegram.Message.passport_data
.- Type:
- PHOTO = 'photo'[source]¶
Messages with
telegram.Message.photo
.- Type:
- POLL = 'poll'[source]¶
Messages with
telegram.Message.poll
.- Type:
- STICKER = 'sticker'[source]¶
Messages with
telegram.Message.sticker
.- Type:
- STORY = 'story'[source]¶
Messages with
telegram.Message.story
.- Type:
- SUCCESSFUL_PAYMENT = 'successful_payment'[source]¶
Messages with
telegram.Message.successful_payment
.- Type:
- VENUE = 'venue'[source]¶
Messages with
telegram.Message.venue
.- Type:
- VIDEO = 'video'[source]¶
Messages with
telegram.Message.video
.- Type:
- VIDEO_NOTE = 'video_note'[source]¶
Messages with
telegram.Message.video_note
.- Type:
- VOICE = 'voice'[source]¶
Messages with
telegram.Message.voice
.- Type:
- class telegram.constants.MessageEntityType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.MessageEntity
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- BLOCKQUOTE = 'blockquote'[source]¶
Message entities representing a block quotation.
Added in version 20.8.
- Type:
- CUSTOM_EMOJI = 'custom_emoji'[source]¶
Message entities representing inline custom emoji stickers.
Added in version 20.0.
- Type:
- EXPANDABLE_BLOCKQUOTE = 'expandable_blockquote'[source]¶
Message entities representing collapsed-by-default block quotation.
Added in version 21.3.
- Type:
- class telegram.constants.MessageLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Message
/telegram.InputTextMessageContent
/telegram.Bot.send_message()
& friends. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- CAPTION_LENGTH = 1024[source]¶
Maximum number of characters in a
str
passed as:caption
parameter oftelegram.Message
caption
parameter oftelegram.InputMedia
and its subclassescaption
parameter of subclasses oftelegram.InlineQueryResult
caption
parameter oftelegram.Bot.send_photo()
,telegram.Bot.send_audio()
,telegram.Bot.send_document()
,telegram.Bot.send_video()
,telegram.Bot.send_animation()
,telegram.Bot.send_voice()
,telegram.Bot.edit_message_caption()
,telegram.Bot.copy_message()
- Type:
- MAX_TEXT_LENGTH = 4096[source]¶
Maximum number of characters in a
str
passed as:text
parameter oftelegram.Game
text
parameter oftelegram.Message
message_text
parameter oftelegram.InputTextMessageContent
text
parameter oftelegram.Bot.send_message()
text
parameter oftelegram.Bot.edit_message_text()
- Type:
- MESSAGE_ENTITIES = 100[source]¶
Maximum number of entities that can be displayed in a message. Further entities will simply be ignored by Telegram.
Note
This value is undocumented and might be changed by Telegram.
- Type:
- MIN_TEXT_LENGTH = 1[source]¶
Minimum number of characters in a
str
passed as themessage_text
parameter oftelegram.InputTextMessageContent
and thetext
parameter oftelegram.Bot.edit_message_text()
.- Type:
- class telegram.constants.MessageOriginType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.MessageOrigin
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.8.
- CHANNEL = 'channel'[source]¶
A
telegram.MessageOrigin
who is sent by a channel.- Type:
- CHAT = 'chat'[source]¶
A
telegram.MessageOrigin
who is sent by a chat.- Type:
- HIDDEN_USER = 'hidden_user'[source]¶
A
telegram.MessageOrigin
who is sent by a hidden user.- Type:
- USER = 'user'[source]¶
A
telegram.MessageOrigin
who is sent by an user.- Type:
- class telegram.constants.MessageType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.Message
. Here, a “type” means a kind of message that is visually distinct from other kinds of messages in the Telegram app. In particular, auxiliary attributes that can be present for multiple types of messages are not considered in this enumeration.The enum members of this enumeration are instances of
str
and can be treated as such.Added in version 20.0.
- ANIMATION = 'animation'[source]¶
Messages with
telegram.Message.animation
.- Type:
- AUDIO = 'audio'[source]¶
Messages with
telegram.Message.audio
.- Type:
- BOOST_ADDED = 'boost_added'[source]¶
Messages with
telegram.Message.boost_added
.Added in version 21.0.
- Type:
- BUSINESS_CONNECTION_ID = 'business_connection_id'[source]¶
Messages with
telegram.Message.business_connection_id
.Added in version 21.1.
- Type:
- CHANNEL_CHAT_CREATED = 'channel_chat_created'[source]¶
Messages with
telegram.Message.channel_chat_created
.- Type:
- CHAT_BACKGROUND_SET = 'chat_background_set'[source]¶
Messages with
telegram.Message.chat_background_set
.Added in version 21.2.
- Type:
- CHAT_SHARED = 'chat_shared'[source]¶
Messages with
telegram.Message.chat_shared
.Added in version 20.8.
- Type:
- CONNECTED_WEBSITE = 'connected_website'[source]¶
Messages with
telegram.Message.connected_website
.- Type:
- CONTACT = 'contact'[source]¶
Messages with
telegram.Message.contact
.- Type:
- DELETE_CHAT_PHOTO = 'delete_chat_photo'[source]¶
Messages with
telegram.Message.delete_chat_photo
.- Type:
- DICE = 'dice'[source]¶
Messages with
telegram.Message.dice
.- Type:
- DOCUMENT = 'document'[source]¶
Messages with
telegram.Message.document
.- Type:
- EFFECT_ID = 'effect_id'[source]¶
Messages with
telegram.Message.effect_id
.Added in version 21.3.
- Type:
- FORUM_TOPIC_CLOSED = 'forum_topic_closed'[source]¶
Messages with
telegram.Message.forum_topic_closed
.Added in version 20.8.
- Type:
- FORUM_TOPIC_CREATED = 'forum_topic_created'[source]¶
Messages with
telegram.Message.forum_topic_created
.Added in version 20.8.
- Type:
- FORUM_TOPIC_EDITED = 'forum_topic_edited'[source]¶
Messages with
telegram.Message.forum_topic_edited
.Added in version 20.8.
- Type:
- FORUM_TOPIC_REOPENED = 'forum_topic_reopened'[source]¶
Messages with
telegram.Message.forum_topic_reopened
.Added in version 20.8.
- Type:
- GAME = 'game'[source]¶
Messages with
telegram.Message.game
.- Type:
- GENERAL_FORUM_TOPIC_HIDDEN = 'general_forum_topic_hidden'[source]¶
Messages with
telegram.Message.general_forum_topic_hidden
.Added in version 20.8.
- Type:
- GENERAL_FORUM_TOPIC_UNHIDDEN = 'general_forum_topic_unhidden'[source]¶
Messages with
telegram.Message.general_forum_topic_unhidden
.Added in version 20.8.
- Type:
- GIVEAWAY = 'giveaway'[source]¶
Messages with
telegram.Message.giveaway
.Added in version 20.8.
- Type:
- GIVEAWAY_COMPLETED = 'giveaway_completed'[source]¶
Messages with
telegram.Message.giveaway_completed
.Added in version 20.8.
- Type:
- GIVEAWAY_CREATED = 'giveaway_created'[source]¶
Messages with
telegram.Message.giveaway_created
.Added in version 20.8.
- Type:
- GIVEAWAY_WINNERS = 'giveaway_winners'[source]¶
Messages with
telegram.Message.giveaway_winners
.Added in version 20.8.
- Type:
- GROUP_CHAT_CREATED = 'group_chat_created'[source]¶
Messages with
telegram.Message.group_chat_created
.- Type:
- INVOICE = 'invoice'[source]¶
Messages with
telegram.Message.invoice
.- Type:
- LEFT_CHAT_MEMBER = 'left_chat_member'[source]¶
Messages with
telegram.Message.left_chat_member
.- Type:
- LOCATION = 'location'[source]¶
Messages with
telegram.Message.location
.- Type:
- MESSAGE_AUTO_DELETE_TIMER_CHANGED = 'message_auto_delete_timer_changed'[source]¶
Messages with
telegram.Message.message_auto_delete_timer_changed
.- Type:
- MIGRATE_TO_CHAT_ID = 'migrate_to_chat_id'[source]¶
Messages with
telegram.Message.migrate_to_chat_id
.- Type:
- NEW_CHAT_MEMBERS = 'new_chat_members'[source]¶
Messages with
telegram.Message.new_chat_members
.- Type:
- NEW_CHAT_PHOTO = 'new_chat_photo'[source]¶
Messages with
telegram.Message.new_chat_photo
.- Type:
- NEW_CHAT_TITLE = 'new_chat_title'[source]¶
Messages with
telegram.Message.new_chat_title
.- Type:
- PAID_MEDIA = 'paid_media'[source]¶
Messages with
telegram.Message.paid_media
.Added in version 21.4.
- Type:
- PASSPORT_DATA = 'passport_data'[source]¶
Messages with
telegram.Message.passport_data
.- Type:
- PHOTO = 'photo'[source]¶
Messages with
telegram.Message.photo
.- Type:
- PINNED_MESSAGE = 'pinned_message'[source]¶
Messages with
telegram.Message.pinned_message
.- Type:
- POLL = 'poll'[source]¶
Messages with
telegram.Message.poll
.- Type:
- PROXIMITY_ALERT_TRIGGERED = 'proximity_alert_triggered'[source]¶
Messages with
telegram.Message.proximity_alert_triggered
.- Type:
- REFUNDED_PAYMENT = 'refunded_payment'[source]¶
Messages with
telegram.Message.refunded_payment
.Added in version 21.4.
- Type:
- REPLY_TO_STORY = 'reply_to_story'[source]¶
Messages with
telegram.Message.reply_to_story
.Added in version 21.0.
- Type:
- SENDER_BOOST_COUNT = 'sender_boost_count'[source]¶
Messages with
telegram.Message.sender_boost_count
.Added in version 21.0.
- Type:
- SENDER_BUSINESS_BOT = 'sender_business_bot'[source]¶
Messages with
telegram.Message.sender_business_bot
.Added in version 21.1.
- Type:
- STICKER = 'sticker'[source]¶
Messages with
telegram.Message.sticker
.- Type:
- STORY = 'story'[source]¶
Messages with
telegram.Message.story
.- Type:
- SUCCESSFUL_PAYMENT = 'successful_payment'[source]¶
Messages with
telegram.Message.successful_payment
.- Type:
- SUPERGROUP_CHAT_CREATED = 'supergroup_chat_created'[source]¶
Messages with
telegram.Message.supergroup_chat_created
.- Type:
- TEXT = 'text'[source]¶
Messages with
telegram.Message.text
.- Type:
- USERS_SHARED = 'users_shared'[source]¶
Messages with
telegram.Message.users_shared
.Added in version 20.8.
- Type:
- VENUE = 'venue'[source]¶
Messages with
telegram.Message.venue
.- Type:
- VIDEO = 'video'[source]¶
Messages with
telegram.Message.video
.- Type:
- VIDEO_CHAT_ENDED = 'video_chat_ended'[source]¶
Messages with
telegram.Message.video_chat_ended
.- Type:
- VIDEO_CHAT_PARTICIPANTS_INVITED = 'video_chat_participants_invited'[source]¶
Messages with
telegram.Message.video_chat_participants_invited
.- Type:
- VIDEO_CHAT_SCHEDULED = 'video_chat_scheduled'[source]¶
Messages with
telegram.Message.video_chat_scheduled
.- Type:
- VIDEO_CHAT_STARTED = 'video_chat_started'[source]¶
Messages with
telegram.Message.video_chat_started
.- Type:
- VIDEO_NOTE = 'video_note'[source]¶
Messages with
telegram.Message.video_note
.- Type:
- VOICE = 'voice'[source]¶
Messages with
telegram.Message.voice
.- Type:
- WEB_APP_DATA = 'web_app_data'[source]¶
Messages with
telegram.Message.web_app_data
.Added in version 20.8.
- Type:
- WRITE_ACCESS_ALLOWED = 'write_access_allowed'[source]¶
Messages with
telegram.Message.write_access_allowed
.Added in version 20.8.
- Type:
- class telegram.constants.PaidMediaType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.PaidMedia
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 21.4.
- PHOTO = 'photo'[source]¶
The type of
telegram.PaidMediaPhoto
.- Type:
- PREVIEW = 'preview'[source]¶
The type of
telegram.PaidMediaPreview
.- Type:
- VIDEO = 'video'[source]¶
The type of
telegram.PaidMediaVideo
.- Type:
- class telegram.constants.ParseMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available parse modes. The enum members of this enumeration are instances of
str
and can be treated as such.Added in version 20.0.
- MARKDOWN = 'Markdown'[source]¶
Markdown parse mode.
Note
MARKDOWN
is a legacy mode, retained by Telegram for backward compatibility. You should useMARKDOWN_V2
instead.- Type:
- class telegram.constants.PollLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Poll
/telegram.PollOption
/telegram.Bot.send_poll()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_EXPLANATION_LENGTH = 200[source]¶
Maximum number of characters in a
str
passed as theexplanation
parameter oftelegram.Poll
and theexplanation
parameter oftelegram.Bot.send_poll()
.- Type:
- MAX_EXPLANATION_LINE_FEEDS = 2[source]¶
Maximum number of line feeds in a
str
passed as theexplanation
parameter oftelegram.Bot.send_poll()
after entities parsing.- Type:
- MAX_OPEN_PERIOD = 600[source]¶
Maximum value allowed for the
open_period
parameter oftelegram.Bot.send_poll()
. Also used in theclose_date
parameter oftelegram.Bot.send_poll()
.- Type:
- MAX_OPTION_LENGTH = 100[source]¶
Maximum length of each
str
passed in alist
to theoptions
parameter oftelegram.Bot.send_poll()
.- Type:
- MAX_OPTION_NUMBER = 10[source]¶
Maximum number of strings passed in a
list
to theoptions
parameter oftelegram.Bot.send_poll()
.- Type:
- MAX_QUESTION_LENGTH = 300[source]¶
Maximum value allowed for the
question
parameter oftelegram.Poll
and thequestion
parameter oftelegram.Bot.send_poll()
.- Type:
- MIN_OPEN_PERIOD = 5[source]¶
Minimum value allowed for the
open_period
parameter oftelegram.Bot.send_poll()
. Also used in theclose_date
parameter oftelegram.Bot.send_poll()
.- Type:
- MIN_OPTION_LENGTH = 1[source]¶
Minimum length of each
str
passed in alist
to theoptions
parameter oftelegram.Bot.send_poll()
.- Type:
- MIN_OPTION_NUMBER = 2[source]¶
Minimum number of strings passed in a
list
to theoptions
parameter oftelegram.Bot.send_poll()
.- Type:
- MIN_QUESTION_LENGTH = 1[source]¶
Minimum value allowed for the
question
parameter oftelegram.Poll
and thequestion
parameter oftelegram.Bot.send_poll()
.- Type:
- class telegram.constants.PollType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types for
telegram.Poll
/telegram.Bot.send_poll()
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- class telegram.constants.PollingLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.get_updates.limit
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_LIMIT = 100[source]¶
Maximum value allowed for the
limit
parameter oftelegram.Bot.get_updates()
.- Type:
- MIN_LIMIT = 1[source]¶
Minimum value allowed for the
limit
parameter oftelegram.Bot.get_updates()
.- Type:
- class telegram.constants.ProfileAccentColor(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
Enum
This enum contains the available accent colors for
telegram.ChatFullInfo.profile_accent_color_id
. The members of this enum are named tuples with the following attributes:identifier
(int
): The identifier of the accent color.name
(str
): Optional. The name of the accent color.light_colors
(tuple[str
]): Optional. The light colors of the accent color as HEX value.dark_colors
(tuple[str
]): Optional. The dark colors of the accent color as HEX value.
Since Telegram gives no exact specification for the accent colors, future accent colors might have a different data type.
Added in version 20.8.
- COLOR_000 = (0, None, (12211792,), (10241344,))[source]¶
Accent color 0. This contains one light color
and one dark color
- COLOR_001 = (1, None, (12745790,), (9723436,))[source]¶
Accent color 1. This contains one light color
and one dark color
- COLOR_002 = (2, None, (9792200,), (7426201,))[source]¶
Accent color 2. This contains one light color
and one dark color
- COLOR_003 = (3, None, (4825941,), (3371323,))[source]¶
Accent color 3. This contains one light color
and one dark color
- COLOR_004 = (4, None, (4102061,), (3702407,))[source]¶
Accent color 4. This contains one light color
and one dark color
- COLOR_005 = (5, None, (5935035,), (4682132,))[source]¶
Accent color 5. This contains one light color
and one dark color
- COLOR_006 = (6, None, (12079992,), (9717603,))[source]¶
Accent color 6. This contains one light color
and one dark color
- COLOR_007 = (7, None, (8358805,), (4412001,))[source]¶
Accent color 7. This contains one light color
and one dark color
- COLOR_008 = (8, None, (13194845, 14253143), (10044227, 11294782))[source]¶
Accent color 8. This contains two light colors
and two dark colors
- COLOR_009 = (9, None, (13595204, 13407283), (9393455, 10580530))[source]¶
Accent color 9. This contains two light colors
and two dark colors
- COLOR_010 = (10, None, (9855700, 12150454), (6506129, 9588898))[source]¶
Accent color 10. This contains two light colors
and two dark colors
- COLOR_011 = (11, None, (4036437, 9021008), (2714179, 6262596))[source]¶
Accent color 11. This contains two light colors
and two dark colors
- COLOR_012 = (12, None, (4036026, 5287320), (3173500, 4102270))[source]¶
Accent color 12. This contains two light colors
and two dark colors
- COLOR_013 = (13, None, (5475266, 5089469), (3694988, 4557729))[source]¶
Accent color 13. This contains two light colors
and two dark colors
- class telegram.constants.ReactionEmoji(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available emojis of
telegram.ReactionTypeEmoji
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.8.
- GRINNING_FACE_WITH_ONE_LARGE_AND_ONE_SMALL_EYE = '🤪'[source]¶
Grinning face with one large and one small eye
- Type:
- REVERSED_HAND_WITH_MIDDLE_FINGER_EXTENDED = '🖕'[source]¶
Reversed hand with middle finger extended
- Type:
- class telegram.constants.ReactionType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.ReactionType
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.8.
- CUSTOM_EMOJI = 'custom_emoji'[source]¶
A
telegram.ReactionType
with a custom emoji.- Type:
- EMOJI = 'emoji'[source]¶
A
telegram.ReactionType
with a normal emoji.- Type:
- PAID = 'paid'[source]¶
A
telegram.ReactionType
with a paid reaction.Added in version 21.5.
- Type:
- class telegram.constants.ReplyLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.ForceReply
andtelegram.ReplyKeyboardMarkup
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_INPUT_FIELD_PLACEHOLDER = 64[source]¶
Maximum value allowed for
input_field_placeholder
parameter oftelegram.ForceReply
andinput_field_placeholder
parameter oftelegram.ReplyKeyboardMarkup
- Type:
- MIN_INPUT_FIELD_PLACEHOLDER = 1[source]¶
Minimum value allowed for
input_field_placeholder
parameter oftelegram.ForceReply
andinput_field_placeholder
parameter oftelegram.ReplyKeyboardMarkup
- Type:
- class telegram.constants.RevenueWithdrawalStateType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.RevenueWithdrawalState
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 21.4.
- telegram.constants.SUPPORTED_WEBHOOK_PORTS = [443, 80, 88, 8443][source]¶
Ports supported by
telegram.Bot.set_webhook.url
.- Type:
list[
int
]
- class telegram.constants.StarTransactionsLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.get_star_transactions
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 21.4.
- MAX_LIMIT = 100[source]¶
Maximum value allowed for the
limit
parameter oftelegram.Bot.get_star_transactions()
.- Type:
- MIN_LIMIT = 1[source]¶
Minimum value allowed for the
limit
parameter oftelegram.Bot.get_star_transactions()
.- Type:
- class telegram.constants.StickerFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available formats of
telegram.Sticker
in the set. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.2.
- class telegram.constants.StickerLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for various sticker methods, such as
telegram.Bot.create_new_sticker_set()
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_KEYWORD_LENGTH = 64[source]¶
Maximum number of characters in a search keyword for a sticker, for each item in
keywords
sequence oftelegram.Bot.set_sticker_keywords()
.Added in version 20.2.
- Type:
- MAX_NAME_AND_TITLE = 64[source]¶
Maximum number of characters in a
str
passed as thename
parameter or thetitle
parameter oftelegram.Bot.create_new_sticker_set()
.- Type:
- MAX_SEARCH_KEYWORDS = 20[source]¶
Maximum number of search keywords for a sticker, passed as the
keywords
parameter oftelegram.Bot.set_sticker_keywords()
.Added in version 20.2.
- Type:
- MAX_STICKER_EMOJI = 20[source]¶
Maximum number of emojis associated with a sticker, passed as the
emoji_list
parameter oftelegram.Bot.set_sticker_emoji_list()
.Added in version 20.2.
- Type:
- MIN_NAME_AND_TITLE = 1[source]¶
Minimum number of characters in a
str
passed as thename
parameter or thetitle
parameter oftelegram.Bot.create_new_sticker_set()
.- Type:
- MIN_STICKER_EMOJI = 1[source]¶
Minimum number of emojis associated with a sticker, passed as the
emoji_list
parameter oftelegram.Bot.set_sticker_emoji_list()
.Added in version 20.2.
- Type:
- class telegram.constants.StickerSetLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for various sticker set methods, such as
telegram.Bot.create_new_sticker_set()
andtelegram.Bot.add_sticker_to_set()
.The enum members of this enumeration are instances of
int
and can be treated as such.Added in version 20.2.
- MAX_ANIMATED_STICKERS = 50[source]¶
Maximum number of stickers allowed in an animated or video sticker set, as given in
telegram.Bot.add_sticker_to_set()
.Deprecated since version 21.1: The animated sticker limit is now 120, the same as
MAX_STATIC_STICKERS
.- Type:
- MAX_ANIMATED_THUMBNAIL_SIZE = 32[source]¶
Maximum size of the thumbnail if it is a .TGS or .WEBM in kilobytes, as given in
telegram.Bot.set_sticker_set_thumbnail()
.- Type:
- MAX_EMOJI_STICKERS = 200[source]¶
Maximum number of stickers allowed in an emoji sticker set, as given in
telegram.Bot.add_sticker_to_set()
.- Type:
- MAX_INITIAL_STICKERS = 50[source]¶
Maximum number of stickers allowed while creating a sticker set, passed as the
stickers
parameter oftelegram.Bot.create_new_sticker_set()
.- Type:
- MAX_STATIC_STICKERS = 120[source]¶
Maximum number of stickers allowed in a static sticker set, as given in
telegram.Bot.add_sticker_to_set()
.- Type:
- MAX_STATIC_THUMBNAIL_SIZE = 128[source]¶
Maximum size of the thumbnail if it is a .WEBP or .PNG in kilobytes, as given in
telegram.Bot.set_sticker_set_thumbnail()
.- Type:
- MIN_INITIAL_STICKERS = 1[source]¶
Minimum number of stickers needed to create a sticker set, passed as the
stickers
parameter oftelegram.Bot.create_new_sticker_set()
.- Type:
- STATIC_THUMB_DIMENSIONS = 100[source]¶
Exact height and width of the thumbnail if it is a .WEBP or .PNG in pixels, as given in
telegram.Bot.set_sticker_set_thumbnail()
.- Type:
- class telegram.constants.StickerType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.Sticker
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- class telegram.constants.TransactionPartnerType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.TransactionPartner
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 21.4.
- TELEGRAM_API = 'telegram_api'[source]¶
Transaction with with payment for paid broadcasting.
..versionadded:: 21.7
- Type:
- class telegram.constants.UpdateType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
-
This enum contains the available types of
telegram.Update
. The enum members of this enumeration are instances ofstr
and can be treated as such.Added in version 20.0.
- BUSINESS_CONNECTION = 'business_connection'[source]¶
Updates with
telegram.Update.business_connection
.Added in version 21.1.
- Type:
- BUSINESS_MESSAGE = 'business_message'[source]¶
Updates with
telegram.Update.business_message
.Added in version 21.1.
- Type:
- CALLBACK_QUERY = 'callback_query'[source]¶
Updates with
telegram.Update.callback_query
.- Type:
- CHANNEL_POST = 'channel_post'[source]¶
Updates with
telegram.Update.channel_post
.- Type:
- CHAT_BOOST = 'chat_boost'[source]¶
Updates with
telegram.Update.chat_boost
.Added in version 20.8.
- Type:
- CHAT_JOIN_REQUEST = 'chat_join_request'[source]¶
Updates with
telegram.Update.chat_join_request
.- Type:
- CHAT_MEMBER = 'chat_member'[source]¶
Updates with
telegram.Update.chat_member
.- Type:
- CHOSEN_INLINE_RESULT = 'chosen_inline_result'[source]¶
Updates with
telegram.Update.chosen_inline_result
.- Type:
- DELETED_BUSINESS_MESSAGES = 'deleted_business_messages'[source]¶
Updates with
telegram.Update.deleted_business_messages
.Added in version 21.1.
- Type:
- EDITED_BUSINESS_MESSAGE = 'edited_business_message'[source]¶
Updates with
telegram.Update.edited_business_message
.Added in version 21.1.
- Type:
- EDITED_CHANNEL_POST = 'edited_channel_post'[source]¶
Updates with
telegram.Update.edited_channel_post
.- Type:
- EDITED_MESSAGE = 'edited_message'[source]¶
Updates with
telegram.Update.edited_message
.- Type:
- INLINE_QUERY = 'inline_query'[source]¶
Updates with
telegram.Update.inline_query
.- Type:
- MESSAGE = 'message'[source]¶
Updates with
telegram.Update.message
.- Type:
- MESSAGE_REACTION = 'message_reaction'[source]¶
Updates with
telegram.Update.message_reaction
.Added in version 20.8.
- Type:
- MESSAGE_REACTION_COUNT = 'message_reaction_count'[source]¶
Updates with
telegram.Update.message_reaction_count
.Added in version 20.8.
- Type:
- MY_CHAT_MEMBER = 'my_chat_member'[source]¶
Updates with
telegram.Update.my_chat_member
.- Type:
- POLL = 'poll'[source]¶
Updates with
telegram.Update.poll
.- Type:
- POLL_ANSWER = 'poll_answer'[source]¶
Updates with
telegram.Update.poll_answer
.- Type:
- PRE_CHECKOUT_QUERY = 'pre_checkout_query'[source]¶
Updates with
telegram.Update.pre_checkout_query
.- Type:
- PURCHASED_PAID_MEDIA = 'purchased_paid_media'[source]¶
Updates with
telegram.Update.purchased_paid_media
.Added in version 21.6.
- Type:
- REMOVED_CHAT_BOOST = 'removed_chat_boost'[source]¶
Updates with
telegram.Update.removed_chat_boost
.Added in version 20.8.
- Type:
- SHIPPING_QUERY = 'shipping_query'[source]¶
Updates with
telegram.Update.shipping_query
.- Type:
- class telegram.constants.UserProfilePhotosLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.get_user_profile_photos.limit
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_LIMIT = 100[source]¶
Maximum value allowed for
limit
parameter oftelegram.Bot.get_user_profile_photos()
.- Type:
- MIN_LIMIT = 1[source]¶
Minimum value allowed for
limit
parameter oftelegram.Bot.get_user_profile_photos()
.- Type:
- class telegram.constants.WebhookLimit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
enum.IntEnum
This enum contains limitations for
telegram.Bot.set_webhook.max_connections
andtelegram.Bot.set_webhook.secret_token
. The enum members of this enumeration are instances ofint
and can be treated as such.Added in version 20.0.
- MAX_CONNECTIONS_LIMIT = 100[source]¶
Maximum value allowed for the
max_connections
parameter oftelegram.Bot.set_webhook()
.- Type:
- MAX_SECRET_TOKEN_LENGTH = 256[source]¶
Maximum length of the secret token for the
secret_token
parameter oftelegram.Bot.set_webhook()
.- Type:
- MIN_CONNECTIONS_LIMIT = 1[source]¶
Minimum value allowed for the
max_connections
parameter oftelegram.Bot.set_webhook()
.- Type:
- MIN_SECRET_TOKEN_LENGTH = 1[source]¶
Minimum length of the secret token for the
secret_token
parameter oftelegram.Bot.set_webhook()
.- Type:
- telegram.constants.ZERO_DATE = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)[source]¶
datetime.datetime
, value of unix 0. This date literal is used intelegram.InaccessibleMessage
Added in version 20.8.