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.

Changed in version 20.0: Since v20.0, most of the constants in this module are grouped into enums.

telegram.constants.BOT_API_VERSION

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

[443, 80, 88, 8443]

Type

List[int]

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.

class telegram.constants.BotCommandScopeType(value)

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'

The type of telegram.BotCommandScopeAllChatAdministrators.

Type

str

ALL_GROUP_CHATS = 'all_group_chats'

The type of telegram.BotCommandScopeAllGroupChats.

Type

str

ALL_PRIVATE_CHATS = 'all_private_chats'

The type of telegram.BotCommandScopeAllPrivateChats.

Type

str

CHAT = 'chat'

The type of telegram.BotCommandScopeChat.

Type

str

CHAT_ADMINISTRATORS = 'chat_administrators'

The type of telegram.BotCommandScopeChatAdministrators.

Type

str

CHAT_MEMBER = 'chat_member'

The type of telegram.BotCommandScopeChatMember.

Type

str

DEFAULT = 'default'

The type of telegram.BotCommandScopeDefault.

Type

str

class telegram.constants.CallbackQueryLimit(value)

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

Maximum number of characters for the text parameter of telegram.Bot.answer_callback_query().

Type

int

class telegram.constants.ChatAction(value)

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'

Chat action indicating that the bot is selecting a sticker.

Type

str

FIND_LOCATION = 'find_location'

Chat action indicating that the bot is selecting a location.

Type

str

RECORD_VIDEO = 'record_video'

Chat action indicating that the bot is recording a video.

Type

str

RECORD_VIDEO_NOTE = 'record_video_note'

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

Type

str

RECORD_VOICE = 'record_voice'

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

Type

str

TYPING = 'typing'

A chat indicating the bot is typing.

Type

str

UPLOAD_DOCUMENT = 'upload_document'

Chat action indicating that the bot is uploading a document.

Type

str

UPLOAD_PHOTO = 'upload_photo'

Chat action indicating that the bot is uploading a photo.

Type

str

UPLOAD_VIDEO = 'upload_video'

Chat action indicating that the bot is uploading a video.

Type

str

UPLOAD_VIDEO_NOTE = 'upload_video_note'

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

Type

str

UPLOAD_VOICE = 'upload_voice'

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

Type

str

class telegram.constants.ChatID(value)

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

User ID in groups for messages sent by anonymous admins.

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

User ID in groups when message is sent on behalf of a channel.

Note

• telegram.Message.from_user will contain this ID for backwards compatibility only. It’s recommended to use telegram.Message.sender_chat instead.

• This value is undocumented and might be changed by Telegram.

Type

int

SERVICE_CHAT = 777000

Telegram service chat, that also acts as sender of channel posts forwarded to discussion groups.

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)

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.

MEMBER_LIMIT = 99999

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

Type

int

NAME_LENGTH = 32

Maximum number of characters allowed for the name parameter of telegram.Bot.create_chat_invite_link() and telegram.Bot.edit_chat_invite_link().

Type

int

class telegram.constants.ChatMemberStatus(value)

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'

A telegram.ChatMember who is administrator of the chat.

Type

str

BANNED = 'kicked'

A telegram.ChatMember who was banned in the chat.

Type

str

LEFT = 'left'

A telegram.ChatMember who has left the chat.

Type

str

MEMBER = 'member'

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

Type

str

OWNER = 'creator'

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

Type

str

RESTRICTED = 'restricted'

A telegram.ChatMember who was restricted in this chat.

Type

str

class telegram.constants.ChatType(value)

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'

A telegram.Chat that is a channel.

Type

str

GROUP = 'group'

A telegram.Chat that is a group.

Type

str

PRIVATE = 'private'

A telegram.Chat that is private.

Type

str

SENDER = 'sender'

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

Type

str

SUPERGROUP = 'supergroup'

A telegram.Chat that is a supergroup.

Type

str

class telegram.constants.DiceEmoji(value)

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 = '🏀'

A telegram.Dice with the emoji 🏀.

Type

str

BOWLING = '🎳'

A telegram.Dice with the emoji 🎳.

Type

str

DARTS = '🎯'

A telegram.Dice with the emoji 🎯.

Type

str

DICE = '🎲'

A telegram.Dice with the emoji 🎲.

Type

str

FOOTBALL = '⚽'

A telegram.Dice with the emoji ⚽.

Type

str

SLOT_MACHINE = '🎰'

A telegram.Dice with the emoji 🎰.

Type

str

class telegram.constants.FileSizeLimit(value)

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

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

Type

int

FILESIZE_UPLOAD = 50000000

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

Type

int

PHOTOSIZE_UPLOAD = 10000000

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

Type

int

class telegram.constants.FloodLimit(value)

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

The number of messages that can roughly be sent to a particular group within one minute.

Type

int

MESSAGES_PER_SECOND = 30

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

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.InlineKeyboardMarkupLimit(value)

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

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

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)

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.

RESULTS = 50

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

Type

int

SWITCH_PM_TEXT_LENGTH = 64

Maximum number of characters for the switch_pm_text parameter of telegram.Bot.answer_inline_query().

Type

int

class telegram.constants.InlineQueryResultType(value)

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'

Type of telegram.InlineQueryResultArticle.

Type

str

AUDIO = 'audio'

Type of telegram.InlineQueryResultAudio and telegram.InlineQueryResultCachedAudio.

Type

str

CONTACT = 'contact'

Type of telegram.InlineQueryResultContact.

Type

str

DOCUMENT = 'document'

Type of telegram.InlineQueryResultDocument and telegram.InlineQueryResultCachedDocument.

Type

str

GAME = 'game'

Type of telegram.InlineQueryResultGame.

Type

str

GIF = 'gif'

Type of telegram.InlineQueryResultGif and telegram.InlineQueryResultCachedGif.

Type

str

LOCATION = 'location'

Type of telegram.InlineQueryResultLocation.

Type

str

MPEG4GIF = 'mpeg4_gif'

Type of telegram.InlineQueryResultMpeg4Gif and telegram.InlineQueryResultCachedMpeg4Gif.

Type

str

PHOTO = 'photo'

Type of telegram.InlineQueryResultPhoto and telegram.InlineQueryResultCachedPhoto.

Type

str

STICKER = 'sticker'

Type of and telegram.InlineQueryResultCachedSticker.

Type

str

VENUE = 'venue'

Type of telegram.InlineQueryResultVenue.

Type

str

VIDEO = 'video'

Type of telegram.InlineQueryResultVideo and telegram.InlineQueryResultCachedVideo.

Type

str

VOICE = 'voice'

Type of telegram.InlineQueryResultVoice and telegram.InlineQueryResultCachedVoice.

Type

str

class telegram.constants.InputMediaType(value)

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'

Type of telegram.InputMediaAnimation.

Type

str

AUDIO = 'audio'

Type of telegram.InputMediaAudio.

Type

str

DOCUMENT = 'document'

Type of telegram.InputMediaDocument.

Type

str

PHOTO = 'photo'

Type of telegram.InputMediaPhoto.

Type

str

VIDEO = 'video'

Type of telegram.InputMediaVideo.

Type

str

class telegram.constants.LocationLimit(value)

Bases: enum.IntEnum

This enum contains limitations for telegram.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.

HEADING = 360

Maximum value allowed for the direction in which the user is moving, in degrees.

Type

int

HORIZONTAL_ACCURACY = 1500

Maximum radius of uncertainty for the location, measured in meters.

Type

int

PROXIMITY_ALERT_RADIUS = 100000

Maximum distance for proximity alerts about approaching another chat member, in meters.

Type

int

class telegram.constants.MaskPosition(value)

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'

Mask position for a sticker on the chin.

Type

str

EYES = 'eyes'

Mask position for a sticker on the eyes.

Type

str

FOREHEAD = 'forehead'

Mask position for a sticker on the forehead.

Type

str

MOUTH = 'mouth'

Mask position for a sticker on the mouth.

Type

str

class telegram.constants.MenuButtonType(value)

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'

The type of telegram.MenuButtonCommands.

Type

str

DEFAULT = 'default'

The type of telegram.MenuButtonDefault.

Type

str

WEB_APP = 'web_app'

The type of telegram.MenuButtonWebApp.

Type

str

class telegram.constants.MessageAttachmentType(value)

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'

Messages with telegram.Message.animation.

Type

str

AUDIO = 'audio'

Messages with telegram.Message.audio.

Type

str

CONTACT = 'contact'

Messages with telegram.Message.contact.

Type

str

DICE = 'dice'

Messages with telegram.Message.dice.

Type

str

DOCUMENT = 'document'

Messages with telegram.Message.document.

Type

str

GAME = 'game'

Messages with telegram.Message.game.

Type

str

INVOICE = 'invoice'

Messages with telegram.Message.invoice.

Type

str

LOCATION = 'location'

Messages with telegram.Message.location.

Type

str

PASSPORT_DATA = 'passport_data'

Messages with telegram.Message.passport_data.

Type

str

PHOTO = 'photo'

Messages with telegram.Message.photo.

Type

str

POLL = 'poll'

Messages with telegram.Message.poll.

Type

str

STICKER = 'sticker'

Messages with telegram.Message.sticker.

Type

str

SUCCESSFUL_PAYMENT = 'successful_payment'

Messages with telegram.Message.successful_payment.

Type

str

VENUE = 'venue'

Messages with telegram.Message.venue.

Type

str

VIDEO = 'video'

Messages with telegram.Message.video.

Type

str

VIDEO_NOTE = 'video_note'

Messages with telegram.Message.video_note.

Type

str

VOICE = 'voice'

Messages with telegram.Message.voice.

Type

str

class telegram.constants.MessageEntityType(value)

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.

BOLD = 'bold'

Message entities representing bold text.

Type

str

BOT_COMMAND = 'bot_command'

Message entities representing a bot command.

Type

str

CASHTAG = 'cashtag'

Message entities representing a cashtag.

Type

str

CODE = 'code'

Message entities representing monowidth string.

Type

str

EMAIL = 'email'

Message entities representing a email.

Type

str

HASHTAG = 'hashtag'

Message entities representing a hashtag.

Type

str

ITALIC = 'italic'

Message entities representing italic text.

Type

str

MENTION = 'mention'

Message entities representing a mention.

Type

str

PHONE_NUMBER = 'phone_number'

Message entities representing a phone number.

Type

str

PRE = 'pre'

Message entities representing monowidth block.

Type

str

SPOILER = 'spoiler'

Message entities representing spoiler text.

Type

str

STRIKETHROUGH = 'strikethrough'

Message entities representing strikethrough text.

Type

str

TEXT_LINK = 'text_link'

Message entities representing clickable text URLs.

Type

str

TEXT_MENTION = 'text_mention'

Message entities representing text mention for users without usernames.

Type

str

UNDERLINE = 'underline'

Message entities representing underline text.

Type

str

URL = 'url'

Message entities representing a url.

Type

str

class telegram.constants.MessageLimit(value)

Bases: enum.IntEnum

This enum contains limitations for telegram.Message/ 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

Maximum number of characters for a message caption.

Type

int

MESSAGE_ENTITIES = 100

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

TEXT_LENGTH = 4096

Maximum number of characters for a text message.

Type

int

class telegram.constants.MessageType(value)

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'

Messages with telegram.Message.animation.

Type

str

AUDIO = 'audio'

Messages with telegram.Message.audio.

Type

str

CHANNEL_CHAT_CREATED = 'channel_chat_created'

Messages with telegram.Message.channel_chat_created.

Type

str

CONTACT = 'contact'

Messages with telegram.Message.contact.

Type

str

DELETE_CHAT_PHOTO = 'delete_chat_photo'

Messages with telegram.Message.delete_chat_photo.

Type

str

DICE = 'dice'

Messages with telegram.Message.dice.

Type

str

DOCUMENT = 'document'

Messages with telegram.Message.document.

Type

str

GAME = 'game'

Messages with telegram.Message.game.

Type

str

GROUP_CHAT_CREATED = 'group_chat_created'

Messages with telegram.Message.group_chat_created.

Type

str

INVOICE = 'invoice'

Messages with telegram.Message.invoice.

Type

str

LEFT_CHAT_MEMBER = 'left_chat_member'

Messages with telegram.Message.left_chat_member.

Type

str

LOCATION = 'location'

Messages with telegram.Message.location.

Type

str

MESSAGE_AUTO_DELETE_TIMER_CHANGED = 'message_auto_delete_timer_changed'

Messages with telegram.Message.message_auto_delete_timer_changed.

Type

str

MIGRATE_FROM_CHAT_ID = 'migrate_from_chat_id'

Messages with telegram.Message.migrate_from_chat_id.

Type

str

MIGRATE_TO_CHAT_ID = 'migrate_to_chat_id'

Messages with telegram.Message.migrate_to_chat_id.

Type

str

NEW_CHAT_MEMBERS = 'new_chat_members'

Messages with telegram.Message.new_chat_members.

Type

str

NEW_CHAT_PHOTO = 'new_chat_photo'

Messages with telegram.Message.new_chat_photo.

Type

str

NEW_CHAT_TITLE = 'new_chat_title'

Messages with telegram.Message.new_chat_title.

Type

str

PASSPORT_DATA = 'passport_data'

Messages with telegram.Message.passport_data.

Type

str

PHOTO = 'photo'

Messages with telegram.Message.photo.

Type

str

PINNED_MESSAGE = 'pinned_message'

Messages with telegram.Message.pinned_message.

Type

str

POLL = 'poll'

Messages with telegram.Message.poll.

Type

str

PROXIMITY_ALERT_TRIGGERED = 'proximity_alert_triggered'

Messages with telegram.Message.proximity_alert_triggered.

Type

str

STICKER = 'sticker'

Messages with telegram.Message.sticker.

Type

str

SUCCESSFUL_PAYMENT = 'successful_payment'

Messages with telegram.Message.successful_payment.

Type

str

SUPERGROUP_CHAT_CREATED = 'supergroup_chat_created'

Messages with telegram.Message.supergroup_chat_created.

Type

str

TEXT = 'text'

Messages with telegram.Message.text.

Type

str

VENUE = 'venue'

Messages with telegram.Message.venue.

Type

str

VIDEO = 'video'

Messages with telegram.Message.video.

Type

str

VIDEO_CHAT_ENDED = 'video_chat_ended'

Messages with telegram.Message.video_chat_ended.

Type

str

VIDEO_CHAT_PARTICIPANTS_INVITED = 'video_chat_participants_invited'

Messages with telegram.Message.video_chat_participants_invited.

Type

str

VIDEO_CHAT_SCHEDULED = 'video_chat_scheduled'

Messages with telegram.Message.video_chat_scheduled.

Type

str

VIDEO_CHAT_STARTED = 'video_chat_started'

Messages with telegram.Message.video_chat_started.

Type

str

VIDEO_NOTE = 'video_note'

Messages with telegram.Message.video_note.

Type

str

VOICE = 'voice'

Messages with telegram.Message.voice.

Type

str

class telegram.constants.ParseMode(value)

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'

HTML parse mode.

Type

str

MARKDOWN = 'Markdown'

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'

Markdown parse mode version 2.

Type

str

class telegram.constants.PollLimit(value)

Bases: enum.IntEnum

This enum contains limitations for telegram.Poll/ 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.

OPTION_LENGTH = 100

Maximum number of characters for each option for the poll.

Type

str

OPTION_NUMBER = 10

Maximum number of available options for the poll.

Type

str

QUESTION_LENGTH = 300

Maximum number of characters of the polls question.

Type

str

class telegram.constants.PollType(value)

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'

quiz polls.

Type

str

REGULAR = 'regular'

regular polls.

Type

str

class telegram.constants.UpdateType(value)

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.

CALLBACK_QUERY = 'callback_query'

Updates with telegram.Update.callback_query.

Type

str

CHANNEL_POST = 'channel_post'

Updates with telegram.Update.channel_post.

Type

str

CHAT_JOIN_REQUEST = 'chat_join_request'

Updates with telegram.Update.chat_join_request.

Type

str

CHAT_MEMBER = 'chat_member'

Updates with telegram.Update.chat_member.

Type

str

CHOSEN_INLINE_RESULT = 'chosen_inline_result'

Updates with telegram.Update.chosen_inline_result.

Type

str

EDITED_CHANNEL_POST = 'edited_channel_post'

Updates with telegram.Update.edited_channel_post.

Type

str

EDITED_MESSAGE = 'edited_message'

Updates with telegram.Update.edited_message.

Type

str

INLINE_QUERY = 'inline_query'

Updates with telegram.Update.inline_query.

Type

str

MESSAGE = 'message'

Updates with telegram.Update.message.

Type

str

MY_CHAT_MEMBER = 'my_chat_member'

Updates with telegram.Update.my_chat_member.

Type

str

POLL = 'poll'

Updates with telegram.Update.poll.

Type

str

POLL_ANSWER = 'poll_answer'

Updates with telegram.Update.poll_answer.

Type

str

PRE_CHECKOUT_QUERY = 'pre_checkout_query'

Updates with telegram.Update.pre_checkout_query.

Type

str

SHIPPING_QUERY = 'shipping_query'

Updates with telegram.Update.shipping_query.

Type

str