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=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

This enum contains the available accent colors for telegram.Chat.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.

New in version 20.8.

COLOR_000 = (0, 'red', (), ())[source]

Accent color 0. This color can be customized by app themes.

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


COLOR_019 = (19, None, (7821270, 16225808, 16768654), (9933311, 15889181, 16767833))[source]

Accent color 19. This contains three light colors


and three dark colors


COLOR_020 = (20, None, (1410511, 15903517, 16777215), (4040427, 15639837, 16777215))[source]

Accent color 20. This contains three light colors


and three dark colors


telegram.constants.BOT_API_VERSION = '7.2'[source]

Telegram Bot API version supported by this version of python-telegram-bot. Also available as telegram.__bot_api_version__.

New in version 13.4.

Type:

str

telegram.constants.BOT_API_VERSION_INFO = (7, 2)[source]

The components can also be accessed by name, so BOT_API_VERSION_INFO[0] is equivalent to BOT_API_VERSION_INFO.major and so on. Also available as telegram.__bot_api_version_info__.

New in version 20.0.

class telegram.constants.BotCommandLimit(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: enum.IntEnum

This enum contains limitations for telegram.BotCommand and telegram.Bot.set_my_commands(). The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.0.

MAX_COMMAND = 32[source]

Maximum value allowed for command parameter of telegram.BotCommand.

Type:

int

MAX_COMMAND_NUMBER = 100[source]

Maximum number of bot commands passed in a list to the commands parameter of telegram.Bot.set_my_commands().

Type:

int

MAX_DESCRIPTION = 256[source]

Maximum value allowed for description parameter of telegram.BotCommand.

Type:

int

MIN_COMMAND = 1[source]

Minimum value allowed for command parameter of telegram.BotCommand.

Type:

int

MIN_DESCRIPTION = 1[source]

Minimum value allowed for description parameter of telegram.BotCommand.

Type:

int

class telegram.constants.BotCommandScopeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.BotCommandScope. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

ALL_CHAT_ADMINISTRATORS = 'all_chat_administrators'[source]

The type of telegram.BotCommandScopeAllChatAdministrators.

Type:

str

ALL_GROUP_CHATS = 'all_group_chats'[source]

The type of telegram.BotCommandScopeAllGroupChats.

Type:

str

ALL_PRIVATE_CHATS = 'all_private_chats'[source]

The type of telegram.BotCommandScopeAllPrivateChats.

Type:

str

CHAT = 'chat'[source]

The type of telegram.BotCommandScopeChat.

Type:

str

CHAT_ADMINISTRATORS = 'chat_administrators'[source]

The type of telegram.BotCommandScopeChatAdministrators.

Type:

str

CHAT_MEMBER = 'chat_member'[source]

The type of telegram.BotCommandScopeChatMember.

Type:

str

DEFAULT = 'default'[source]

The type of telegram.BotCommandScopeDefault.

Type:

str

class telegram.constants.BotDescriptionLimit(value, names=None, *, 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() and telegram.Bot.set_my_short_description(). The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.2.

MAX_DESCRIPTION_LENGTH = 512[source]

Maximum length for the parameter description of telegram.Bot.set_my_description()

Type:

int

MAX_SHORT_DESCRIPTION_LENGTH = 120[source]

Maximum length for the parameter short_description of telegram.Bot.set_my_short_description()

Type:

int

class telegram.constants.BotNameLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.3.

MAX_NAME_LENGTH = 64[source]

Maximum length for the parameter name of telegram.Bot.set_my_name()

Type:

int

class telegram.constants.BulkRequestLimit(value, names=None, *, 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() and telegram.Bot.copy_messages(). The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.8.

MAX_LIMIT = 100[source]

Maximum number of messages required for bulk actions.

Type:

int

MIN_LIMIT = 1[source]

Minimum number of messages required for bulk actions.

Type:

int

class telegram.constants.CallbackQueryLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

ANSWER_CALLBACK_QUERY_TEXT_LENGTH = 200[source]

Maximum number of characters in a str passed as the text parameter of telegram.Bot.answer_callback_query().

Type:

int

class telegram.constants.ChatAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available chat actions for telegram.Bot.send_chat_action(). The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

CHOOSE_STICKER = 'choose_sticker'[source]

Chat action indicating that the bot is selecting a sticker.

Type:

str

FIND_LOCATION = 'find_location'[source]

Chat action indicating that the bot is selecting a location.

Type:

str

RECORD_VIDEO = 'record_video'[source]

Chat action indicating that the bot is recording a video.

Type:

str

RECORD_VIDEO_NOTE = 'record_video_note'[source]

Chat action indicating that the bot is recording a video note.

Type:

str

RECORD_VOICE = 'record_voice'[source]

Chat action indicating that the bot is recording a voice message.

Type:

str

TYPING = 'typing'[source]

A chat indicating the bot is typing.

Type:

str

UPLOAD_DOCUMENT = 'upload_document'[source]

Chat action indicating that the bot is uploading a document.

Type:

str

UPLOAD_PHOTO = 'upload_photo'[source]

Chat action indicating that the bot is uploading a photo.

Type:

str

UPLOAD_VIDEO = 'upload_video'[source]

Chat action indicating that the bot is uploading a video.

Type:

str

UPLOAD_VIDEO_NOTE = 'upload_video_note'[source]

Chat action indicating that the bot is uploading a video note.

Type:

str

UPLOAD_VOICE = 'upload_voice'[source]

Chat action indicating that the bot is uploading a voice message.

Type:

str

class telegram.constants.ChatBoostSources(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available sources for a Telegram chat boost. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.8.

GIFT_CODE = 'gift_code'[source]

The source of the chat boost was a Telegram Premium gift code.

Type:

str

GIVEAWAY = 'giveaway'[source]

The source of the chat boost was a Telegram Premium giveaway.

Type:

str

PREMIUM = 'premium'[source]

The source of the chat boost was a Telegram Premium subscription/gift.

Type:

str

class telegram.constants.ChatID(value, names=None, *, 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.

New 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 use telegram.Message.sender_chat instead.

Type:

int

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

Type:

int

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 use telegram.Message.sender_chat instead.

Type:

int

class telegram.constants.ChatInviteLinkLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_MEMBER_LIMIT = 99999[source]

Maximum value allowed for the member_limit parameter of telegram.Bot.create_chat_invite_link() and member_limit of telegram.Bot.edit_chat_invite_link().

Type:

int

MIN_MEMBER_LIMIT = 1[source]

Minimum value allowed for the member_limit parameter of telegram.Bot.create_chat_invite_link() and member_limit of telegram.Bot.edit_chat_invite_link().

Type:

int

NAME_LENGTH = 32[source]

Maximum number of characters in a str passed as the name parameter of telegram.Bot.create_chat_invite_link() and name of telegram.Bot.edit_chat_invite_link().

Type:

int

class telegram.constants.ChatLimit(value, names=None, *, 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(), and telegram.Bot.set_chat_title(). The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.0.

CHAT_ADMINISTRATOR_CUSTOM_TITLE_LENGTH = 16[source]

Maximum length of a str passed as the custom_title parameter of telegram.Bot.set_chat_administrator_custom_title().

Type:

int

CHAT_DESCRIPTION_LENGTH = 255[source]

Maximum number of characters in a str passed as the description parameter of telegram.Bot.set_chat_description().

Type:

int

MAX_CHAT_TITLE_LENGTH = 128[source]

Maximum length of a str passed as the title parameter of telegram.Bot.set_chat_title().

Type:

int

MIN_CHAT_TITLE_LENGTH = 1[source]

Minimum length of a str passed as the title parameter of telegram.Bot.set_chat_title().

Type:

int

class telegram.constants.ChatMemberStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available states for telegram.ChatMember. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

ADMINISTRATOR = 'administrator'[source]

A telegram.ChatMember who is administrator of the chat.

Type:

str

BANNED = 'kicked'[source]

A telegram.ChatMember who was banned in the chat.

Type:

str

LEFT = 'left'[source]

A telegram.ChatMember who has left the chat.

Type:

str

MEMBER = 'member'[source]

A telegram.ChatMember who is a member of the chat.

Type:

str

OWNER = 'creator'[source]

A telegram.ChatMember who is the owner of the chat.

Type:

str

RESTRICTED = 'restricted'[source]

A telegram.ChatMember who was restricted in this chat.

Type:

str

class telegram.constants.ChatPhotoSize(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

BIG = 640[source]

Width and height of a big chat photo, ID of which is passed in big_file_id and big_file_unique_id parameters of telegram.ChatPhoto.

Type:

int

SMALL = 160[source]

Width and height of a small chat photo, ID of which is passed in small_file_id and small_file_unique_id parameters of telegram.ChatPhoto.

Type:

int

class telegram.constants.ChatType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.Chat. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

CHANNEL = 'channel'[source]

A telegram.Chat that is a channel.

Type:

str

GROUP = 'group'[source]

A telegram.Chat that is a group.

Type:

str

PRIVATE = 'private'[source]

A telegram.Chat that is private.

Type:

str

SENDER = 'sender'[source]

A telegram.Chat that represents the chat of a telegram.User sending an telegram.InlineQuery.

Type:

str

SUPERGROUP = 'supergroup'[source]

A telegram.Chat that is a supergroup.

Type:

str

class telegram.constants.ContactLimit(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: enum.IntEnum

This enum contains limitations for telegram.InlineQueryResultContact, telegram.InputContactMessageContent, and telegram.Bot.send_contact(). The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.0.

VCARD = 2048[source]

Maximum value allowed for:

Type:

int

class telegram.constants.CustomEmojiStickerLimit(value, names=None, *, 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 of int and can be treated as such.

New 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 of telegram.Bot.get_custom_emoji_stickers().

Type:

int

class telegram.constants.DiceEmoji(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available emoji for telegram.Dice/ telegram.Bot.send_dice(). The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

BASKETBALL = '🏀'[source]

A telegram.Dice with the emoji 🏀.

Type:

str

BOWLING = '🎳'[source]

A telegram.Dice with the emoji 🎳.

Type:

str

DARTS = '🎯'[source]

A telegram.Dice with the emoji 🎯.

Type:

str

DICE = '🎲'[source]

A telegram.Dice with the emoji 🎲.

Type:

str

FOOTBALL = '⚽'[source]

A telegram.Dice with the emoji ⚽.

Type:

str

SLOT_MACHINE = '🎰'[source]

A telegram.Dice with the emoji 🎰.

Type:

str

class telegram.constants.DiceLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_VALUE_BASKETBALL = 5[source]

Maximum value allowed for value parameter of telegram.Dice if emoji is '🏀'.

Type:

int

MAX_VALUE_BOWLING = 6[source]

Maximum value allowed for value parameter of telegram.Dice if emoji is '🎳'.

Type:

int

MAX_VALUE_DARTS = 6[source]

Maximum value allowed for value parameter of telegram.Dice if emoji is '🎯'.

Type:

int

MAX_VALUE_DICE = 6[source]

Maximum value allowed for value parameter of telegram.Dice if emoji is '🎲'.

Type:

int

MAX_VALUE_FOOTBALL = 5[source]

Maximum value allowed for value parameter of telegram.Dice if emoji is '⚽'.

Type:

int

MAX_VALUE_SLOT_MACHINE = 64[source]

Maximum value allowed for value parameter of telegram.Dice if emoji is '🎰'.

Type:

int

MIN_VALUE = 1[source]

Minimum value allowed for value parameter of telegram.Dice (any emoji).

Type:

int

class telegram.constants.FileSizeLimit(value, names=None, *, 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.

New in version 20.0.

FILESIZE_DOWNLOAD = 20000000[source]

Bots can download files of up to 20MB in size.

Type:

int

FILESIZE_DOWNLOAD_LOCAL_MODE = 9223372036854775807[source]

Bots can download files without a size limit when using a local bot API server.

Type:

int

FILESIZE_UPLOAD = 50000000[source]

Bots can upload non-photo files of up to 50MB in size.

Type:

int

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:

int

PHOTOSIZE_UPLOAD = 10000000[source]

Bots can upload photo files of up to 10MB in size.

Type:

int

VOICE_NOTE_FILE_SIZE = 1000000[source]

File size limit for the send_voice() method of telegram.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:

int

class telegram.constants.FloodLimit(value, names=None, *, 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.

New 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:

int

MESSAGES_PER_SECOND = 30[source]

The number of messages that can roughly be sent in an interval of 30 seconds across all chats.

Type:

int

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:

int

class telegram.constants.ForumIconColor(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

BLUE = 7322096[source]

An icon with a color which corresponds to blue (0x6FB9F0).

Type:

int

GREEN = 9367192[source]

An icon with a color which corresponds to green (0x8EEE98).

Type:

int

PINK = 16749490[source]

An icon with a color which corresponds to pink (0xFF93B2).

Type:

int

PURPLE = 13338331[source]

An icon with a color which corresponds to purple (0xCB86DB).

Type:

int

RED = 16478047[source]

An icon with a color which corresponds to red (0xFB6F5F).

Type:

int

YELLOW = 16766590[source]

An icon with a color which corresponds to yellow (0xFFD67E).

Type:

int

class telegram.constants.ForumTopicLimit(value, names=None, *, 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 and telegram.Bot.edit_forum_topic.name. The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.0.

MAX_NAME_LENGTH = 128[source]

Maximum length of a str passed as:

Type:

int

MIN_NAME_LENGTH = 1[source]

Minimum length of a str passed as:

Type:

int

class telegram.constants.GiveawayLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.8.

MAX_WINNERS = 100[source]

Maximum number of winners allowed for telegram.GiveawayWinners.winners.

Type:

int

class telegram.constants.InlineKeyboardButtonLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_CALLBACK_DATA = 64[source]

Maximum value allowed for callback_data parameter of telegram.InlineKeyboardButton

Type:

int

MIN_CALLBACK_DATA = 1[source]

Minimum value allowed for callback_data parameter of telegram.InlineKeyboardButton

Type:

int

class telegram.constants.InlineKeyboardMarkupLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

BUTTONS_PER_ROW = 8[source]

Maximum number of buttons that can be attached to a message per row.

Note

This value is undocumented and might be changed by Telegram.

Type:

int

TOTAL_BUTTON_NUMBER = 100[source]

Maximum number of buttons that can be attached to a message.

Note

This value is undocumented and might be changed by Telegram.

Type:

int

class telegram.constants.InlineQueryLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_OFFSET_LENGTH = 64[source]

Maximum number of bytes in a str passed as the next_offset parameter of telegram.Bot.answer_inline_query().

Type:

int

MAX_QUERY_LENGTH = 256[source]

Maximum number of characters in a str passed as the query parameter of telegram.InlineQuery.

Type:

int

MAX_SWITCH_PM_TEXT_LENGTH = 64[source]

Maximum number of characters in a str passed as the switch_pm_parameter parameter of telegram.Bot.answer_inline_query().

Deprecated since version 20.3: Deprecated in favor of InlineQueryResultsButtonLimit.MAX_START_PARAMETER_LENGTH.

Type:

int

MIN_SWITCH_PM_TEXT_LENGTH = 1[source]

Minimum number of characters in a str passed as the switch_pm_parameter parameter of telegram.Bot.answer_inline_query().

Deprecated since version 20.3: Deprecated in favor of InlineQueryResultsButtonLimit.MIN_START_PARAMETER_LENGTH.

Type:

int

RESULTS = 50[source]

Maximum number of results that can be passed to telegram.Bot.answer_inline_query().

Type:

int

class telegram.constants.InlineQueryResultLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_ID_LENGTH = 64[source]

Maximum number of bytes in a str passed as the id parameter of telegram.InlineQueryResult and its subclasses

Type:

int

MIN_ID_LENGTH = 1[source]

Minimum number of bytes in a str passed as the id parameter of telegram.InlineQueryResult and its subclasses

Type:

int

class telegram.constants.InlineQueryResultType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.InlineQueryResult. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

ARTICLE = 'article'[source]

Type of telegram.InlineQueryResultArticle.

Type:

str

AUDIO = 'audio'[source]

Type of telegram.InlineQueryResultAudio and telegram.InlineQueryResultCachedAudio.

Type:

str

CONTACT = 'contact'[source]

Type of telegram.InlineQueryResultContact.

Type:

str

DOCUMENT = 'document'[source]

Type of telegram.InlineQueryResultDocument and telegram.InlineQueryResultCachedDocument.

Type:

str

GAME = 'game'[source]

Type of telegram.InlineQueryResultGame.

Type:

str

GIF = 'gif'[source]

Type of telegram.InlineQueryResultGif and telegram.InlineQueryResultCachedGif.

Type:

str

LOCATION = 'location'[source]

Type of telegram.InlineQueryResultLocation.

Type:

str

MPEG4GIF = 'mpeg4_gif'[source]

Type of telegram.InlineQueryResultMpeg4Gif and telegram.InlineQueryResultCachedMpeg4Gif.

Type:

str

PHOTO = 'photo'[source]

Type of telegram.InlineQueryResultPhoto and telegram.InlineQueryResultCachedPhoto.

Type:

str

STICKER = 'sticker'[source]

Type of and telegram.InlineQueryResultCachedSticker.

Type:

str

VENUE = 'venue'[source]

Type of telegram.InlineQueryResultVenue.

Type:

str

VIDEO = 'video'[source]

Type of telegram.InlineQueryResultVideo and telegram.InlineQueryResultCachedVideo.

Type:

str

VOICE = 'voice'[source]

Type of telegram.InlineQueryResultVoice and telegram.InlineQueryResultCachedVoice.

Type:

str

class telegram.constants.InlineQueryResultsButtonLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.3.

MAX_START_PARAMETER_LENGTH = 64[source]

Maximum number of characters in a str passed as the start_parameter parameter of telegram.InlineQueryResultsButton().

Type:

int

MIN_START_PARAMETER_LENGTH = 1[source]

Minimum number of characters in a str passed as the start_parameter parameter of telegram.InlineQueryResultsButton().

Type:

int

class telegram.constants.InputMediaType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.InputMedia. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

ANIMATION = 'animation'[source]

Type of telegram.InputMediaAnimation.

Type:

str

AUDIO = 'audio'[source]

Type of telegram.InputMediaAudio.

Type:

str

DOCUMENT = 'document'[source]

Type of telegram.InputMediaDocument.

Type:

str

PHOTO = 'photo'[source]

Type of telegram.InputMediaPhoto.

Type:

str

VIDEO = 'video'[source]

Type of telegram.InputMediaVideo.

Type:

str

class telegram.constants.InvoiceLimit(value, names=None, *, 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(), and telegram.Bot.create_invoice_link(). The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.0.

MAX_DESCRIPTION_LENGTH = 255[source]

Maximum number of characters in a str passed as:

Type:

int

MAX_PAYLOAD_LENGTH = 128[source]

Maximum amount of bytes in a str passed as:

Type:

int

MAX_TIP_AMOUNTS = 4[source]

Maximum length of a Sequence passed as:

Type:

int

MAX_TITLE_LENGTH = 32[source]

Maximum number of characters in a str passed as:

Type:

int

MIN_DESCRIPTION_LENGTH = 1[source]

Minimum number of characters in a str passed as:

Type:

int

MIN_PAYLOAD_LENGTH = 1[source]

Minimum amount of bytes in a str passed as:

Type:

int

MIN_TITLE_LENGTH = 1[source]

Minimum number of characters in a str passed as:

Type:

int

class telegram.constants.KeyboardButtonRequestUsersLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.8.

MAX_QUANTITY = 10[source]

Maximum value allowed for max_quantity parameter of telegram.KeyboardButtonRequestUsers.

Type:

int

MIN_QUANTITY = 1[source]

Minimum value allowed for max_quantity parameter of telegram.KeyboardButtonRequestUsers.

Type:

int

class telegram.constants.LocationLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

HORIZONTAL_ACCURACY = 1500[source]

Maximum value allowed for:

Type:

int

MAX_CHAT_LOCATION_ADDRESS = 64[source]

Minimum value allowed for address parameter of telegram.ChatLocation

Type:

int

MAX_HEADING = 360[source]

Maximum value allowed for:

Type:

int

MAX_LIVE_PERIOD = 86400[source]

Maximum value allowed for:

Type:

int

MAX_PROXIMITY_ALERT_RADIUS = 100000[source]

Maximum value allowed for:

Type:

int

MIN_CHAT_LOCATION_ADDRESS = 1[source]

Minimum value allowed for address parameter of telegram.ChatLocation

Type:

int

MIN_HEADING = 1[source]

Minimum value allowed for:

Type:

int

MIN_LIVE_PERIOD = 60[source]

Minimum value allowed for:

Type:

int

MIN_PROXIMITY_ALERT_RADIUS = 1[source]

Minimum value allowed for:

Type:

int

class telegram.constants.MaskPosition(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available positions for telegram.MaskPosition. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

CHIN = 'chin'[source]

Mask position for a sticker on the chin.

Type:

str

EYES = 'eyes'[source]

Mask position for a sticker on the eyes.

Type:

str

FOREHEAD = 'forehead'[source]

Mask position for a sticker on the forehead.

Type:

str

MOUTH = 'mouth'[source]

Mask position for a sticker on the mouth.

Type:

str

class telegram.constants.MediaGroupLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_MEDIA_LENGTH = 10[source]

Maximum length of a list passed as the media parameter of telegram.Bot.send_media_group().

Type:

int

MIN_MEDIA_LENGTH = 2[source]

Minimum length of a list passed as the media parameter of telegram.Bot.send_media_group().

Type:

int

class telegram.constants.MenuButtonType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.MenuButton. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

COMMANDS = 'commands'[source]

The type of telegram.MenuButtonCommands.

Type:

str

DEFAULT = 'default'[source]

The type of telegram.MenuButtonDefault.

Type:

str

WEB_APP = 'web_app'[source]

The type of telegram.MenuButtonWebApp.

Type:

str

class telegram.constants.MessageAttachmentType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.Message that can be seen as attachment. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

ANIMATION = 'animation'[source]

Messages with telegram.Message.animation.

Type:

str

AUDIO = 'audio'[source]

Messages with telegram.Message.audio.

Type:

str

CONTACT = 'contact'[source]

Messages with telegram.Message.contact.

Type:

str

DICE = 'dice'[source]

Messages with telegram.Message.dice.

Type:

str

DOCUMENT = 'document'[source]

Messages with telegram.Message.document.

Type:

str

GAME = 'game'[source]

Messages with telegram.Message.game.

Type:

str

INVOICE = 'invoice'[source]

Messages with telegram.Message.invoice.

Type:

str

LOCATION = 'location'[source]

Messages with telegram.Message.location.

Type:

str

PASSPORT_DATA = 'passport_data'[source]

Messages with telegram.Message.passport_data.

Type:

str

PHOTO = 'photo'[source]

Messages with telegram.Message.photo.

Type:

str

POLL = 'poll'[source]

Messages with telegram.Message.poll.

Type:

str

STICKER = 'sticker'[source]

Messages with telegram.Message.sticker.

Type:

str

STORY = 'story'[source]

Messages with telegram.Message.story.

Type:

str

SUCCESSFUL_PAYMENT = 'successful_payment'[source]

Messages with telegram.Message.successful_payment.

Type:

str

VENUE = 'venue'[source]

Messages with telegram.Message.venue.

Type:

str

VIDEO = 'video'[source]

Messages with telegram.Message.video.

Type:

str

VIDEO_NOTE = 'video_note'[source]

Messages with telegram.Message.video_note.

Type:

str

VOICE = 'voice'[source]

Messages with telegram.Message.voice.

Type:

str

class telegram.constants.MessageEntityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.MessageEntity. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

BLOCKQUOTE = 'blockquote'[source]

Message entities representing a block quotation.

New in version 20.8.

Type:

str

BOLD = 'bold'[source]

Message entities representing bold text.

Type:

str

BOT_COMMAND = 'bot_command'[source]

Message entities representing a bot command.

Type:

str

CASHTAG = 'cashtag'[source]

Message entities representing a cashtag.

Type:

str

CODE = 'code'[source]

Message entities representing monowidth string.

Type:

str

CUSTOM_EMOJI = 'custom_emoji'[source]

Message entities representing inline custom emoji stickers.

New in version 20.0.

Type:

str

EMAIL = 'email'[source]

Message entities representing a email.

Type:

str

HASHTAG = 'hashtag'[source]

Message entities representing a hashtag.

Type:

str

ITALIC = 'italic'[source]

Message entities representing italic text.

Type:

str

MENTION = 'mention'[source]

Message entities representing a mention.

Type:

str

PHONE_NUMBER = 'phone_number'[source]

Message entities representing a phone number.

Type:

str

PRE = 'pre'[source]

Message entities representing monowidth block.

Type:

str

SPOILER = 'spoiler'[source]

Message entities representing spoiler text.

Type:

str

STRIKETHROUGH = 'strikethrough'[source]

Message entities representing strikethrough text.

Type:

str

Message entities representing clickable text URLs.

Type:

str

TEXT_MENTION = 'text_mention'[source]

Message entities representing text mention for users without usernames.

Type:

str

UNDERLINE = 'underline'[source]

Message entities representing underline text.

Type:

str

URL = 'url'[source]

Message entities representing a url.

Type:

str

class telegram.constants.MessageLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

CAPTION_LENGTH = 1024[source]

Maximum number of characters in a str passed as:

Type:

int

Maximum number of characters for a deep link.

Type:

int

MAX_TEXT_LENGTH = 4096[source]

Maximum number of characters in a str passed as:

Type:

int

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:

int

MIN_TEXT_LENGTH = 1[source]

Minimum number of characters in a str passed as the message_text parameter of telegram.InputTextMessageContent and the text parameter of telegram.Bot.edit_message_text().

Type:

int

class telegram.constants.MessageOriginType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.MessageOrigin. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.8.

CHANNEL = 'channel'[source]

A telegram.MessageOrigin who is sent by a channel.

Type:

str

CHAT = 'chat'[source]

A telegram.MessageOrigin who is sent by a chat.

Type:

str

HIDDEN_USER = 'hidden_user'[source]

A telegram.MessageOrigin who is sent by a hidden user.

Type:

str

USER = 'user'[source]

A telegram.MessageOrigin who is sent by an user.

Type:

str

class telegram.constants.MessageType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

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.

New in version 20.0.

ANIMATION = 'animation'[source]

Messages with telegram.Message.animation.

Type:

str

AUDIO = 'audio'[source]

Messages with telegram.Message.audio.

Type:

str

BOOST_ADDED = 'boost_added'[source]

Messages with telegram.Message.boost_added.

New in version 21.0.

Type:

str

BUSINESS_CONNECTION_ID = 'business_connection_id'[source]

Messages with telegram.Message.business_connection_id.

New in version 21.1.

Type:

str

CHANNEL_CHAT_CREATED = 'channel_chat_created'[source]

Messages with telegram.Message.channel_chat_created.

Type:

str

CHAT_SHARED = 'chat_shared'[source]

Messages with telegram.Message.chat_shared.

New in version 20.8.

Type:

str

CONNECTED_WEBSITE = 'connected_website'[source]

Messages with telegram.Message.connected_website.

Type:

str

CONTACT = 'contact'[source]

Messages with telegram.Message.contact.

Type:

str

DELETE_CHAT_PHOTO = 'delete_chat_photo'[source]

Messages with telegram.Message.delete_chat_photo.

Type:

str

DICE = 'dice'[source]

Messages with telegram.Message.dice.

Type:

str

DOCUMENT = 'document'[source]

Messages with telegram.Message.document.

Type:

str

FORUM_TOPIC_CLOSED = 'forum_topic_closed'[source]

Messages with telegram.Message.forum_topic_closed.

New in version 20.8.

Type:

str

FORUM_TOPIC_CREATED = 'forum_topic_created'[source]

Messages with telegram.Message.forum_topic_created.

New in version 20.8.

Type:

str

FORUM_TOPIC_EDITED = 'forum_topic_edited'[source]

Messages with telegram.Message.forum_topic_edited.

New in version 20.8.

Type:

str

FORUM_TOPIC_REOPENED = 'forum_topic_reopened'[source]

Messages with telegram.Message.forum_topic_reopened.

New in version 20.8.

Type:

str

GAME = 'game'[source]

Messages with telegram.Message.game.

Type:

str

GENERAL_FORUM_TOPIC_HIDDEN = 'general_forum_topic_hidden'[source]

Messages with telegram.Message.general_forum_topic_hidden.

New in version 20.8.

Type:

str

GENERAL_FORUM_TOPIC_UNHIDDEN = 'general_forum_topic_unhidden'[source]

Messages with telegram.Message.general_forum_topic_unhidden.

New in version 20.8.

Type:

str

GIVEAWAY = 'giveaway'[source]

Messages with telegram.Message.giveaway.

New in version 20.8.

Type:

str

GIVEAWAY_COMPLETED = 'giveaway_completed'[source]

Messages with telegram.Message.giveaway_completed.

New in version 20.8.

Type:

str

GIVEAWAY_CREATED = 'giveaway_created'[source]

Messages with telegram.Message.giveaway_created.

New in version 20.8.

Type:

str

GIVEAWAY_WINNERS = 'giveaway_winners'[source]

Messages with telegram.Message.giveaway_winners.

New in version 20.8.

Type:

str

GROUP_CHAT_CREATED = 'group_chat_created'[source]

Messages with telegram.Message.group_chat_created.

Type:

str

INVOICE = 'invoice'[source]

Messages with telegram.Message.invoice.

Type:

str

LEFT_CHAT_MEMBER = 'left_chat_member'[source]

Messages with telegram.Message.left_chat_member.

Type:

str

LOCATION = 'location'[source]

Messages with telegram.Message.location.

Type:

str

MESSAGE_AUTO_DELETE_TIMER_CHANGED = 'message_auto_delete_timer_changed'[source]

Messages with telegram.Message.message_auto_delete_timer_changed.

Type:

str

MIGRATE_TO_CHAT_ID = 'migrate_to_chat_id'[source]

Messages with telegram.Message.migrate_to_chat_id.

Type:

str

NEW_CHAT_MEMBERS = 'new_chat_members'[source]

Messages with telegram.Message.new_chat_members.

Type:

str

NEW_CHAT_PHOTO = 'new_chat_photo'[source]

Messages with telegram.Message.new_chat_photo.

Type:

str

NEW_CHAT_TITLE = 'new_chat_title'[source]

Messages with telegram.Message.new_chat_title.

Type:

str

PASSPORT_DATA = 'passport_data'[source]

Messages with telegram.Message.passport_data.

Type:

str

PHOTO = 'photo'[source]

Messages with telegram.Message.photo.

Type:

str

PINNED_MESSAGE = 'pinned_message'[source]

Messages with telegram.Message.pinned_message.

Type:

str

POLL = 'poll'[source]

Messages with telegram.Message.poll.

Type:

str

PROXIMITY_ALERT_TRIGGERED = 'proximity_alert_triggered'[source]

Messages with telegram.Message.proximity_alert_triggered.

Type:

str

REPLY_TO_STORY = 'reply_to_story'[source]

Messages with telegram.Message.reply_to_story.

New in version 21.0.

Type:

str

SENDER_BOOST_COUNT = 'sender_boost_count'[source]

Messages with telegram.Message.sender_boost_count.

New in version 21.0.

Type:

str

SENDER_BUSINESS_BOT = 'sender_business_bot'[source]

Messages with telegram.Message.sender_business_bot.

New in version 21.1.

Type:

str

STICKER = 'sticker'[source]

Messages with telegram.Message.sticker.

Type:

str

STORY = 'story'[source]

Messages with telegram.Message.story.

Type:

str

SUCCESSFUL_PAYMENT = 'successful_payment'[source]

Messages with telegram.Message.successful_payment.

Type:

str

SUPERGROUP_CHAT_CREATED = 'supergroup_chat_created'[source]

Messages with telegram.Message.supergroup_chat_created.

Type:

str

TEXT = 'text'[source]

Messages with telegram.Message.text.

Type:

str

USERS_SHARED = 'users_shared'[source]

Messages with telegram.Message.users_shared.

New in version 20.8.

Type:

str

VENUE = 'venue'[source]

Messages with telegram.Message.venue.

Type:

str

VIDEO = 'video'[source]

Messages with telegram.Message.video.

Type:

str

VIDEO_CHAT_ENDED = 'video_chat_ended'[source]

Messages with telegram.Message.video_chat_ended.

Type:

str

VIDEO_CHAT_PARTICIPANTS_INVITED = 'video_chat_participants_invited'[source]

Messages with telegram.Message.video_chat_participants_invited.

Type:

str

VIDEO_CHAT_SCHEDULED = 'video_chat_scheduled'[source]

Messages with telegram.Message.video_chat_scheduled.

Type:

str

VIDEO_CHAT_STARTED = 'video_chat_started'[source]

Messages with telegram.Message.video_chat_started.

Type:

str

VIDEO_NOTE = 'video_note'[source]

Messages with telegram.Message.video_note.

Type:

str

VOICE = 'voice'[source]

Messages with telegram.Message.voice.

Type:

str

WEB_APP_DATA = 'web_app_data'[source]

Messages with telegram.Message.web_app_data.

New in version 20.8.

Type:

str

WRITE_ACCESS_ALLOWED = 'write_access_allowed'[source]

Messages with telegram.Message.write_access_allowed.

New in version 20.8.

Type:

str

class telegram.constants.ParseMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available parse modes. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

HTML = 'HTML'[source]

HTML parse mode.

Type:

str

MARKDOWN = 'Markdown'[source]

Markdown parse mode.

Note

MARKDOWN is a legacy mode, retained by Telegram for backward compatibility. You should use MARKDOWN_V2 instead.

Type:

str

MARKDOWN_V2 = 'MarkdownV2'[source]

Markdown parse mode version 2.

Type:

str

class telegram.constants.PollLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_EXPLANATION_LENGTH = 200[source]

Maximum number of characters in a str passed as the explanation parameter of telegram.Poll and the explanation parameter of telegram.Bot.send_poll().

Type:

int

MAX_EXPLANATION_LINE_FEEDS = 2[source]

Maximum number of line feeds in a str passed as the explanation parameter of telegram.Bot.send_poll() after entities parsing.

Type:

int

MAX_OPEN_PERIOD = 600[source]

Maximum value allowed for the open_period parameter of telegram.Bot.send_poll(). Also used in the close_date parameter of telegram.Bot.send_poll().

Type:

int

MAX_OPTION_LENGTH = 100[source]

Maximum length of each str passed in a list to the options parameter of telegram.Bot.send_poll().

Type:

int

MAX_OPTION_NUMBER = 10[source]

Maximum number of strings passed in a list to the options parameter of telegram.Bot.send_poll().

Type:

int

MAX_QUESTION_LENGTH = 300[source]

Maximum value allowed for the question parameter of telegram.Poll and the question parameter of telegram.Bot.send_poll().

Type:

int

MIN_OPEN_PERIOD = 5[source]

Minimum value allowed for the open_period parameter of telegram.Bot.send_poll(). Also used in the close_date parameter of telegram.Bot.send_poll().

Type:

int

MIN_OPTION_LENGTH = 1[source]

Minimum length of each str passed in a list to the options parameter of telegram.Bot.send_poll().

Type:

int

MIN_OPTION_NUMBER = 2[source]

Minimum number of strings passed in a list to the options parameter of telegram.Bot.send_poll().

Type:

int

MIN_QUESTION_LENGTH = 1[source]

Minimum value allowed for the question parameter of telegram.Poll and the question parameter of telegram.Bot.send_poll().

Type:

int

class telegram.constants.PollType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types for telegram.Poll/ telegram.Bot.send_poll(). The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

QUIZ = 'quiz'[source]

quiz polls.

Type:

str

REGULAR = 'regular'[source]

regular polls.

Type:

str

class telegram.constants.PollingLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_LIMIT = 100[source]

Maximum value allowed for the limit parameter of telegram.Bot.get_updates().

Type:

int

MIN_LIMIT = 1[source]

Minimum value allowed for the limit parameter of telegram.Bot.get_updates().

Type:

int

class telegram.constants.ProfileAccentColor(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

This enum contains the available accent colors for telegram.Chat.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.

New 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


COLOR_014 = (14, None, (11554676, 13723245), (8929632, 10900057))[source]

Accent color 14. This contains two light colors


and two dark colors


COLOR_015 = (15, None, (6517890, 8096407), (5464174, 3688020))[source]

Accent color 15. This contains two light colors


and two dark colors


class telegram.constants.ReactionEmoji(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available emojis of telegram.ReactionTypeEmoji. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.8.

ALIEN_MONSTER = '👾'[source]

Alien monster

Type:

str

BANANA = '🍌'[source]

Banana

Type:

str

BOTTLE_WITH_POPPING_CORK = '🍾'[source]

Bottle with popping cork

Type:

str

BROKEN_HEART = '💔'[source]

Broken heart

Type:

str

CHRISTMAS_TREE = '🎄'[source]

Christmas tree

Type:

str

CLAPPING_HANDS = '👏'[source]

Clapping Hands

Type:

str

CLOWN_FACE = '🤡'[source]

Clown face

Type:

str

CRYING_FACE = '😢'[source]

Crying face

Type:

str

DOVE_OF_PEACE = '🕊'[source]

Dove of peace

Type:

str

EYES = '👀'[source]

Eyes

Type:

str

FACE_SCREAMING_IN_FEAR = '😱'[source]

Face screaming in fear

Type:

str

FACE_THROWING_A_KISS = '😘'[source]

Face throwing a kiss

Type:

str

FACE_WITH_ONE_EYEBROW_RAISED = '🤨'[source]

Face with one eyebrow raised

Type:

str

FACE_WITH_OPEN_MOUTH_VOMITING = '🤮'[source]

Face with open mouth vomiting

Type:

str

FACE_WITH_UNEVEN_EYES_AND_WAVY_MOUTH = '🥴'[source]

Face with uneven eyes and wavy mouth

Type:

str

FATHER_CHRISTMAS = '🎅'[source]

Father christmas

Type:

str

FEARFUL_FACE = '😨'[source]

Fearful face

Type:

str

FIRE = '🔥'[source]

Fire

Type:

str

GHOST = '👻'[source]

Ghost

Type:

str

GRINNING_FACE_WITH_ONE_LARGE_AND_ONE_SMALL_EYE = '🤪'[source]

Grinning face with one large and one small eye

Type:

str

GRINNING_FACE_WITH_SMILING_EYES = '😁'[source]

Grinning face with smiling eyes

Type:

str

GRINNING_FACE_WITH_STAR_EYES = '🤩'[source]

Grinning face with star eyes

Type:

str

HANDSHAKE = '🤝'[source]

Handshake

Type:

str

HEART_ON_FIRE = '❤️\u200d🔥'[source]

Heart on fire

Type:

str

HEART_WITH_ARROW = '💘'[source]

Heart with arrow

Type:

str

HEAR_NO_EVIL_MONKEY = '🙉'[source]

Hear-no-evil monkey

Type:

str

HIGH_VOLTAGE_SIGN = '⚡'[source]

High voltage sign

Type:

str

HOT_DOG = '🌭'[source]

Hot dog

Type:

str

HUGGING_FACE = '🤗'[source]

Hugging face

Type:

str

HUNDRED_POINTS_SYMBOL = '💯'[source]

Hundred points symbol

Type:

str

JACK_O_LANTERN = '🎃'[source]

Jack-o-lantern

Type:

str

KISS_MARK = '💋'[source]

Kiss mark

Type:

str

LOUDLY_CRYING_FACE = '😭'[source]

Loudly crying face

Type:

str

MAN_SHRUGGING = '🤷\u200d♂️'[source]

Man Shrugging

Type:

str

MAN_TECHNOLOGIST = '👨\u200d💻'[source]

Man Technologist

Type:

str

MOYAI = '🗿'[source]

Moyai

Type:

str

NAIL_POLISH = '💅'[source]

Nail polish

Type:

str

NERD_FACE = '🤓'[source]

Nerd face

Type:

str

NEUTRAL_FACE = '😐'[source]

Neutral face

Type:

str

NEW_MOON_WITH_FACE = '🌚'[source]

New moon with face

Type:

str

OK_HAND_SIGN = '👌'[source]

Ok hand sign

Type:

str

PARTY_POPPER = '🎉'[source]

Party popper

Type:

str

PERSON_WITH_FOLDED_HANDS = '🙏'[source]

Person with folded hands

Type:

str

PILE_OF_POO = '💩'[source]

Pile of poo

Type:

str

PILL = '💊'[source]

Pill

Type:

str

POUTING_FACE = '😡'[source]

Pouting face

Type:

str

RED_HEART = '❤'[source]

Red Heart

Type:

str

REVERSED_HAND_WITH_MIDDLE_FINGER_EXTENDED = '🖕'[source]

Reversed hand with middle finger extended

Type:

str

ROLLING_ON_THE_FLOOR_LAUGHING = '🤣'[source]

Rolling on the floor laughing

Type:

str

SALUTING_FACE = '🫡'[source]

Saluting face

Type:

str

SEE_NO_EVIL_MONKEY = '🙈'[source]

See-no-evil monkey

Type:

str

SERIOUS_FACE_WITH_SYMBOLS_COVERING_MOUTH = '🤬'[source]

Serious face with symbols covering mouth

Type:

str

SHOCKED_FACE_WITH_EXPLODING_HEAD = '🤯'[source]

Shocked face with exploding head

Type:

str

SHRUG = '🤷'[source]

Shrug

Type:

str

SLEEPING_FACE = '😴'[source]

Sleeping face

Type:

str

SMILING_FACE_WITH_HALO = '😇'[source]

Smiling face with halo

Type:

str

SMILING_FACE_WITH_HEARTS = '🥰'[source]

Smiling Face with Hearts

Type:

str

SMILING_FACE_WITH_HEART_SHAPED_EYES = '😍'[source]

Smiling face with heart-shaped eyes

Type:

str

SMILING_FACE_WITH_HORNS = '😈'[source]

Smiling face with horns

Type:

str

SMILING_FACE_WITH_SUNGLASSES = '😎'[source]

Smiling face with sunglasses

Type:

str

SNOWMAN = '☃'[source]

Snowman

Type:

str

SPEAK_NO_EVIL_MONKEY = '🙊'[source]

Speak-no-evil monkey

Type:

str

SPOUTING_WHALE = '🐳'[source]

Spouting whale

Type:

str

SQUARED_COOL = '🆒'[source]

Squared cool

Type:

str

STRAWBERRY = '🍓'[source]

Strawberry

Type:

str

THINKING_FACE = '🤔'[source]

Thinking face

Type:

str

THUMBS_DOWN = '👎'[source]

Thumbs Down

Type:

str

THUMBS_UP = '👍'[source]

Thumbs Up

Type:

str

TROPHY = '🏆'[source]

Trophy

Type:

str

UNICORN_FACE = '🦄'[source]

Unicorn face

Type:

str

WOMAN_SHRUGGING = '🤷\u200d♀️'[source]

Woman Shrugging

Type:

str

WRITING_HAND = '✍'[source]

Writing hand

Type:

str

YAWNING_FACE = '🥱'[source]

Yawning face

Type:

str

class telegram.constants.ReactionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.ReactionType. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.8.

CUSTOM_EMOJI = 'custom_emoji'[source]

A telegram.ReactionType with a custom emoji.

Type:

str

EMOJI = 'emoji'[source]

A telegram.ReactionType with a normal emoji.

Type:

str

class telegram.constants.ReplyLimit(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: enum.IntEnum

This enum contains limitations for telegram.ForceReply and telegram.ReplyKeyboardMarkup. The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.0.

MAX_INPUT_FIELD_PLACEHOLDER = 64[source]

Maximum value allowed for input_field_placeholder parameter of telegram.ForceReply and input_field_placeholder parameter of telegram.ReplyKeyboardMarkup

Type:

int

MIN_INPUT_FIELD_PLACEHOLDER = 1[source]

Minimum value allowed for input_field_placeholder parameter of telegram.ForceReply and input_field_placeholder parameter of telegram.ReplyKeyboardMarkup

Type:

int

telegram.constants.SUPPORTED_WEBHOOK_PORTS = [443, 80, 88, 8443][source]

Ports supported by telegram.Bot.set_webhook.url.

Type:

List[int]

class telegram.constants.StickerFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available formats of telegram.Sticker in the set. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.2.

ANIMATED = 'animated'[source]

Animated sticker.

Type:

str

STATIC = 'static'[source]

Static sticker.

Type:

str

VIDEO = 'video'[source]

Video sticker.

Type:

str

class telegram.constants.StickerLimit(value, names=None, *, 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 of int and can be treated as such.

New 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 of telegram.Bot.set_sticker_keywords().

New in version 20.2.

Type:

int

MAX_NAME_AND_TITLE = 64[source]

Maximum number of characters in a str passed as the name parameter or the title parameter of telegram.Bot.create_new_sticker_set().

Type:

int

MAX_SEARCH_KEYWORDS = 20[source]

Maximum number of search keywords for a sticker, passed as the keywords parameter of telegram.Bot.set_sticker_keywords().

New in version 20.2.

Type:

int

MAX_STICKER_EMOJI = 20[source]

Maximum number of emojis associated with a sticker, passed as the emoji_list parameter of telegram.Bot.set_sticker_emoji_list().

New in version 20.2.

Type:

int

MIN_NAME_AND_TITLE = 1[source]

Minimum number of characters in a str passed as the name parameter or the title parameter of telegram.Bot.create_new_sticker_set().

Type:

int

MIN_STICKER_EMOJI = 1[source]

Minimum number of emojis associated with a sticker, passed as the emoji_list parameter of telegram.Bot.set_sticker_emoji_list().

New in version 20.2.

Type:

int

class telegram.constants.StickerSetLimit(value, names=None, *, 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() and telegram.Bot.add_sticker_to_set().

The enum members of this enumeration are instances of int and can be treated as such.

New 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:

int

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:

int

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:

int

MAX_INITIAL_STICKERS = 50[source]

Maximum number of stickers allowed while creating a sticker set, passed as the stickers parameter of telegram.Bot.create_new_sticker_set().

Type:

int

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:

int

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:

int

MIN_INITIAL_STICKERS = 1[source]

Minimum number of stickers needed to create a sticker set, passed as the stickers parameter of telegram.Bot.create_new_sticker_set().

Type:

int

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:

int

class telegram.constants.StickerType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.Sticker. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

CUSTOM_EMOJI = 'custom_emoji'[source]

Custom emoji sticker.

Type:

str

MASK = 'mask'[source]

Mask sticker.

Type:

str

REGULAR = 'regular'[source]

Regular sticker.

Type:

str

class telegram.constants.UpdateType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, enum.Enum

This enum contains the available types of telegram.Update. The enum members of this enumeration are instances of str and can be treated as such.

New in version 20.0.

BUSINESS_CONNECTION = 'business_connection'[source]

Updates with telegram.Update.business_connection.

New in version 21.1.

Type:

str

BUSINESS_MESSAGE = 'business_message'[source]

Updates with telegram.Update.business_message.

New in version 21.1.

Type:

str

CALLBACK_QUERY = 'callback_query'[source]

Updates with telegram.Update.callback_query.

Type:

str

CHANNEL_POST = 'channel_post'[source]

Updates with telegram.Update.channel_post.

Type:

str

CHAT_BOOST = 'chat_boost'[source]

Updates with telegram.Update.chat_boost.

New in version 20.8.

Type:

str

CHAT_JOIN_REQUEST = 'chat_join_request'[source]

Updates with telegram.Update.chat_join_request.

Type:

str

CHAT_MEMBER = 'chat_member'[source]

Updates with telegram.Update.chat_member.

Type:

str

CHOSEN_INLINE_RESULT = 'chosen_inline_result'[source]

Updates with telegram.Update.chosen_inline_result.

Type:

str

DELETED_BUSINESS_MESSAGES = 'deleted_business_messages'[source]

Updates with telegram.Update.deleted_business_messages.

New in version 21.1.

Type:

str

EDITED_BUSINESS_MESSAGE = 'edited_business_message'[source]

Updates with telegram.Update.edited_business_message.

New in version 21.1.

Type:

str

EDITED_CHANNEL_POST = 'edited_channel_post'[source]

Updates with telegram.Update.edited_channel_post.

Type:

str

EDITED_MESSAGE = 'edited_message'[source]

Updates with telegram.Update.edited_message.

Type:

str

INLINE_QUERY = 'inline_query'[source]

Updates with telegram.Update.inline_query.

Type:

str

MESSAGE = 'message'[source]

Updates with telegram.Update.message.

Type:

str

MESSAGE_REACTION = 'message_reaction'[source]

Updates with telegram.Update.message_reaction.

New in version 20.8.

Type:

str

MESSAGE_REACTION_COUNT = 'message_reaction_count'[source]

Updates with telegram.Update.message_reaction_count.

New in version 20.8.

Type:

str

MY_CHAT_MEMBER = 'my_chat_member'[source]

Updates with telegram.Update.my_chat_member.

Type:

str

POLL = 'poll'[source]

Updates with telegram.Update.poll.

Type:

str

POLL_ANSWER = 'poll_answer'[source]

Updates with telegram.Update.poll_answer.

Type:

str

PRE_CHECKOUT_QUERY = 'pre_checkout_query'[source]

Updates with telegram.Update.pre_checkout_query.

Type:

str

REMOVED_CHAT_BOOST = 'removed_chat_boost'[source]

Updates with telegram.Update.removed_chat_boost.

New in version 20.8.

Type:

str

SHIPPING_QUERY = 'shipping_query'[source]

Updates with telegram.Update.shipping_query.

Type:

str

class telegram.constants.UserProfilePhotosLimit(value, names=None, *, 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 of int and can be treated as such.

New in version 20.0.

MAX_LIMIT = 100[source]

Maximum value allowed for limit parameter of telegram.Bot.get_user_profile_photos().

Type:

int

MIN_LIMIT = 1[source]

Minimum value allowed for limit parameter of telegram.Bot.get_user_profile_photos().

Type:

int

class telegram.constants.WebhookLimit(value, names=None, *, 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 and telegram.Bot.set_webhook.secret_token. The enum members of this enumeration are instances of int and can be treated as such.

New in version 20.0.

MAX_CONNECTIONS_LIMIT = 100[source]

Maximum value allowed for the max_connections parameter of telegram.Bot.set_webhook().

Type:

int

MAX_SECRET_TOKEN_LENGTH = 256[source]

Maximum length of the secret token for the secret_token parameter of telegram.Bot.set_webhook().

Type:

int

MIN_CONNECTIONS_LIMIT = 1[source]

Minimum value allowed for the max_connections parameter of telegram.Bot.set_webhook().

Type:

int

MIN_SECRET_TOKEN_LENGTH = 1[source]

Minimum length of the secret token for the secret_token parameter of telegram.Bot.set_webhook().

Type:

int

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 in telegram.InaccessibleMessage

New in version 20.8.