Available Types

This page is about Pyrogram Types. All types listed here are available through the pyrogram.types package. Unless required as argument to a client method, most of the types don’t need to be manually instantiated because they are only returned by other methods. You also don’t need to import them, unless you want to type-hint your variables.

from pyrogram.types import User, Message, ...

Note

Optional fields always exist inside the object, but they could be empty and contain the value of None. Empty fields aren’t shown when, for example, using print(message) and this means that hasattr(message, "photo") always returns True.

To tell whether a field is set or not, do a simple boolean check: if message.photo: ....

---

Users & Chats

Birthday	Birthday information of a user.
BusinessConnection	Business information of a user.
BusinessInfo	Business information of a user.
BusinessIntro	Information about intro of this user.
BusinessMessage	A Business message.
BusinessRecipients	Business recipients.
BusinessWeeklyOpen	Business weekly open hours.
BusinessWorkingHours	Business working hours.
User	A Telegram user or bot.
Username	A Telegram user's or chat's username.
Chat	A chat.
ChatPhoto	A chat photo.
ChatMember	Contains information about one member of a chat.
ChatPermissions	Describes actions that a non-administrator user is allowed to take in a chat.
ChatPrivileges	Describes privileged actions an administrator is able to take in a chat.
ChatInviteLink	An invite link for a chat.
ChatAdminWithInviteLinks	Represents a chat administrator that has created invite links in a chat.
ChatEvent	A chat event from the recent actions log (also known as admin log).
ChatEventFilter	Set of filters used to obtain a chat event log.
ChatMemberUpdated	Represents changes in the status of a chat member.
ChatJoinRequest	Represents a join request sent to a chat.
ChatJoiner	Contains information about a joiner member of a chat.
Dialog	A user's dialog.
Restriction	A restriction applied to bots or chats.
EmojiStatus	A user emoji status.
Folder	A user's folder.
GroupCallMember	Contains information about one member of a group call.
ChatColor	Reply or profile color status.
FoundContacts	Chats found by name substring and auxiliary data.
PrivacyRule	A privacy rule.

Messages & Media

Message	A message.
MessageEntity	One special entity in a text message.
Photo	A Photo.
Thumbnail	One size of a photo or a file/sticker thumbnail.
Audio	An audio file to be treated as music by the Telegram clients.
AvailableEffect	Contains information about available effect.
Document	A generic file (as opposed to photos, voice messages, audio files, ...).
Animation	An animation file (GIF or H.264/MPEG-4 AVC video without sound).
Video	A video file.
Voice	A voice note.
VideoNote	A video note.
Contact	A phone contact.
Location	A point on the map.
Venue	A venue.
Sticker	A sticker.
Game	A game.
WebPage	A webpage preview
Poll	A Poll.
PollOption	Contains information about one answer option in a poll.
Dice	A dice with a random value from 1 to 6 for currently supported base emoji.
Reaction	Contains information about a reaction.
VideoChatScheduled	A service message about a voice chat scheduled in the chat.
VideoChatStarted	A service message about a voice chat started in the chat.
VideoChatEnded	A service message about a voice chat ended in the chat.
VideoChatMembersInvited	A service message about new members invited to a voice chat.
WebAppData	Contains data sent from a Web App to the bot.
MessageReactions	Contains information about a message reactions.
ChatReactions	A chat reactions
Story	A story.
MyBoost	Contains information about boost.
BoostsStatus	Contains information about boost.
Giveaway	An giveaway.
GiveawayResult	An giveaway result.
Invoice	This object contains basic information about an invoice.
GiftCode	Contains gift code data.
CheckedGiftCode	Contains checked gift code data.
SuccessfulPayment	A service message about a new successful payment.
PaidMediaInfo	Describes the paid media added to a message.
PaidMediaPreview	The paid media isn't available before the payment.
PaymentForm	This object contains basic information about an payment form.
ChatBoost	Contains information about one or more boosts applied by a specific user.

Bot keyboards

ReplyKeyboardMarkup	A custom keyboard with reply options.
KeyboardButton	One button of the reply keyboard.
ReplyKeyboardRemove	Object used to tell clients to remove a bot keyboard.
InlineKeyboardMarkup	An inline keyboard that appears right next to the message it belongs to.
InlineKeyboardButton	One button of an inline keyboard.
LoginUrl	Represents a parameter of the inline keyboard button used to automatically authorize a user.
ForceReply	Object used to force clients to show a reply interface.
CallbackQuery	An incoming callback query from a callback button in an inline keyboard.
GameHighScore	One row of the high scores table for a game.
CallbackGame	Placeholder, currently holds no information.
WebAppInfo	Contains information about a Web App.
MenuButton	Describes the bot's menu button in a private chat.
MenuButtonCommands	A menu button, which opens the bot's list of commands.
MenuButtonWebApp	A menu button, which launches a Web App.
MenuButtonDefault	Describes that no specific value for the menu button was set.
SentWebAppMessage	Contains information about an inline message sent by a Web App on behalf of a user.
ForumTopic	A forum topic.
RequestChannelInfo	Contains information about a channel peer type.
RequestChatInfo	Contains information about a chat peer type.
RequestUserInfo	Contains information about a user peer type.
RequestPollInfo	Contains information about a poll type.
OrderInfo	This object represents information about an order.
PreCheckoutQuery	This object contains information about an incoming pre-checkout query.
ShippingAddress	Contains information about a shipping address.
ShippingQuery	This object contains information about an incoming shipping query.
MessageReactionUpdated	This object represents a change of a reaction on a message performed by a user.
MessageReactionCountUpdated	Reactions to a message with anonymous reactions were changed.
ChatBoostUpdated	A channel/supergroup boost has changed (bots only).
ShippingOption	This object represents one shipping option.
PurchasedPaidMedia	This object represents information about purchased paid media.

Bot commands

BotCommand	A bot command with the standard slash "/" prefix.
BotCommandScope	Represents the scope to which bot commands are applied.
BotCommandScopeDefault	Represents the default scope of bot commands.
BotCommandScopeAllPrivateChats	Represents the scope of bot commands, covering all private chats.
BotCommandScopeAllGroupChats	Represents the scope of bot commands, covering all group and supergroup chats.
BotCommandScopeAllChatAdministrators	Represents the scope of bot commands, covering all group and supergroup chat administrators.
BotCommandScopeChat	Represents the scope of bot commands, covering a specific chat.
BotCommandScopeChatAdministrators	Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
BotCommandScopeChatMember	Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

Input Media

InputMedia	Content of a media message to be sent.
InputMediaPhoto	A photo to be sent inside an album.
InputMediaVideo	A video to be sent inside an album.
InputMediaAudio	An audio to be sent inside an album.
InputMediaAnimation	An animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent inside an album.
InputMediaDocument	A generic file to be sent inside an album.
InputPhoneContact	A Phone Contact to be added in your Telegram address book.

Inline Mode

InlineQuery	An incoming inline query.
InlineQueryResult	One result of an inline query.
InlineQueryResultCachedAudio	A link to an MP3 audio file stored on the Telegram servers
InlineQueryResultCachedDocument	A link to a file stored on the Telegram servers.
InlineQueryResultCachedAnimation	A link to an animation file stored on the Telegram servers.
InlineQueryResultCachedPhoto	A link to a photo stored on the Telegram servers.
InlineQueryResultCachedSticker	A link to a sticker stored on the Telegram servers
InlineQueryResultCachedVideo	A link to a video file stored on the Telegram servers.
InlineQueryResultCachedVoice	A link to a voice message stored on the Telegram servers.
InlineQueryResultArticle	Link to an article or web page.
InlineQueryResultAudio	Link to an audio file.
InlineQueryResultContact	Contact with a phone number
InlineQueryResultDocument	Link to a file.
InlineQueryResultAnimation	Link to an animated GIF file.
InlineQueryResultLocation	A location on a map.
InlineQueryResultPhoto	Link to a photo.
InlineQueryResultVenue	A venue.
InlineQueryResultVideo	Link to a page containing an embedded video player or a video file.
InlineQueryResultVoice	Link to a voice recording in an .OGG container encoded with OPUS.
ChosenInlineResult	A result of an inline query chosen by the user and sent to their chat partner.

InputMessageContent

InputMessageContent	Content of a message to be sent as a result of an inline query.
InputTextMessageContent	Content of a text message to be sent as the result of an inline query.

Authorization

ActiveSession	Contains information about one session in a Telegram application used by the current user.
ActiveSessions	Contains a list of currently active sessions
SentCode	Contains info on a sent confirmation code.
TermsOfService	Telegram's Terms of Service returned by sign_in().

InputPrivacyRule

InputPrivacyRuleAllowAll	Allow all users.
InputPrivacyRuleAllowContacts	Allow contacts only.
InputPrivacyRuleAllowPremium	Allow only users with a Premium subscription, currently only usable for CHAT_INVITE.
InputPrivacyRuleAllowUsers	Allow only participants of certain users.
InputPrivacyRuleAllowChats	Allow only participants of certain chats.
InputPrivacyRuleDisallowAll	Disallow all users.
InputPrivacyRuleDisallowContacts	Disallow contacts only.
InputPrivacyRuleDisallowUsers	Disallow only participants of certain users.
InputPrivacyRuleDisallowChats	Disallow only participants of certain chats.