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. .. code-block:: python 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: ...``. ----- .. currentmodule:: pyrogram.types Users & Chats ------------- .. autosummary:: :nosignatures: User Chat ChatPreview ChatPhoto ChatMember ChatPermissions ChatInviteLink ChatAdminWithInviteLinks ChatEvent ChatEventFilter ChatMemberUpdated ChatJoinRequest ChatJoiner Dialog Restriction EmojiStatus Birthday BusinessConnection BusinessIntro BusinessRecipients BusinessWorkingHours BusinessWeeklyOpen ChatAdministratorRights ChatColor ChatJoinResult ChatReactions ChatSettings Folder FolderInviteLink FoundContacts GlobalPrivacySettings GroupCallMember HistoryCleared InviteLinkImporter PhoneCallEnded PhoneCallStarted PrivacyRule StoriesStealthMode UserRating AcceptedGiftTypes BotVerification BusinessBotRights ChatFolderInviteLinkInfo ChatJoinResultDeclined ChatJoinResultGuardBotApprovalRequired ChatJoinResultRequestSent ChatJoinResultSuccess FailedToAddMember Link Username VerificationStatus VideoChatEnded VideoChatMembersInvited VideoChatScheduled VideoChatStarted .. toctree:: :hidden: User Chat ChatPreview ChatPhoto ChatMember ChatPermissions ChatInviteLink ChatAdminWithInviteLinks ChatEvent ChatEventFilter ChatMemberUpdated ChatJoinRequest ChatJoiner Dialog Restriction EmojiStatus Birthday BusinessConnection BusinessIntro BusinessRecipients BusinessWorkingHours BusinessWeeklyOpen ChatAdministratorRights ChatColor ChatJoinResult ChatReactions ChatSettings Folder FolderInviteLink FoundContacts GlobalPrivacySettings GroupCallMember HistoryCleared InviteLinkImporter PhoneCallEnded PhoneCallStarted PrivacyRule StoriesStealthMode UserRating AcceptedGiftTypes BotVerification BusinessBotRights ChatFolderInviteLinkInfo ChatJoinResultDeclined ChatJoinResultGuardBotApprovalRequired ChatJoinResultRequestSent ChatJoinResultSuccess FailedToAddMember Link Username VerificationStatus VideoChatEnded VideoChatMembersInvited VideoChatScheduled VideoChatStarted Messages & Media ---------------- .. autosummary:: :nosignatures: Message MessageEntity Photo Thumbnail Audio Document Animation Video Voice VideoNote Contact Location Venue Sticker Game WebPage Poll PollOption Dice Reaction VideoChatScheduled VideoChatStarted VideoChatEnded VideoChatMembersInvited WebAppData MessageReactions ChatReactions AvailableEffect BoostsStatus BusinessMessage ChatBackground ChatBoost Checklist ChecklistTask ChecklistTasksAdded ChecklistTasksDone ContactRegistered DirectMessagePriceChanged DirectMessagesTopic ExternalReplyInfo FactCheck FormattedText ForumTopic ForumTopicClosed ForumTopicCreated ForumTopicEdited ForumTopicReopened GeneralForumTopicHidden GeneralForumTopicUnhidden Gift GiftAttribute GiftAuction GiftAuctionState GiftCollection GiftedPremium GiftedStars GiftedTon Giveaway GiveawayCompleted GiveawayCreated GiveawayPrizeStars GiveawayWinners InputChecklistTask Invoice LinkPreviewOptions LivePhoto ManagedBotCreated MaskPosition MediaArea MessageContent MessageOrigin MessageOriginChannel MessageOriginChat MessageOriginHiddenUser MessageOriginImport MessageOriginUser MyBoost PaidMediaInfo PaidMediaPreview PaidMessagesPriceChanged PaidMessagesRefunded PaidReactor PaymentForm PaymentOption PollOptionAdded PollOptionDeleted PremiumGiftCode ProximityAlertTriggered RefundedPayment ReplyParameters RestrictionReason RichBlock RichMessage RichText ScreenshotTaken StarAmount Story StoryView StrippedThumbnail SuggestedPostApprovalFailed SuggestedPostApproved SuggestedPostDeclined SuggestedPostInfo SuggestedPostPaid SuggestedPostParameters SuggestedPostPrice SuggestedPostRefunded TextQuote UpgradedGiftAttributeId UpgradedGiftAttributeIdBackdrop UpgradedGiftAttributeIdModel UpgradedGiftAttributeIdSymbol UpgradedGiftAttributeRarity UpgradedGiftOriginalDetails UpgradedGiftPurchaseOffer UpgradedGiftValueInfo WriteAccessAllowed AuctionBid AuctionRound AuctionState AuctionStateActive AuctionStateFinished ChatHasProtectedContentDisableRequested ChatHasProtectedContentToggled ChatOwnerChanged ChatOwnerLeft ChatTheme CheckedGiftCode CraftGiftResult CraftGiftResultFail CraftGiftResultSuccess GiftPurchaseLimit GiftResaleParameters GiftResalePrice GiftResalePriceStar GiftResalePriceTon GiftUpgradePreview GiftUpgradePrice GiftUpgradeVariants PaymentResult RichBlockAnchor RichBlockAnimation RichBlockAudio RichBlockBlockQuotation RichBlockCaption RichBlockCollage RichBlockDetails RichBlockDivider RichBlockFooter RichBlockList RichBlockListItem RichBlockMap RichBlockMathematicalExpression RichBlockParagraph RichBlockPhoto RichBlockPreformatted RichBlockPullQuotation RichBlockSectionHeading RichBlockSlideshow RichBlockTable RichBlockTableCell RichBlockThinking RichBlockUnsupported RichBlockVideo RichBlockVoiceNote RichTextAnchor RichTextAnchorLink RichTextBankCardNumber RichTextBold RichTextBotCommand RichTextCashtag RichTextCode RichTextCustomEmoji RichTextDateTime RichTextEmailAddress RichTextHashtag RichTextItalic RichTextMarked RichTextMathematicalExpression RichTextMention RichTextPhoneNumber RichTextReference RichTextReferenceLink RichTextSpoiler RichTextStrikethrough RichTextSubscript RichTextSuperscript RichTextTextMention RichTextUnderline RichTextUrl SavedCredentials Str SuccessfulPayment SuggestedPostPriceStar SuggestedPostPriceTon UpgradedGiftAttributeRarityEpic UpgradedGiftAttributeRarityLegendary UpgradedGiftAttributeRarityPerMille UpgradedGiftAttributeRarityRare UpgradedGiftAttributeRarityUncommon UpgradedGiftPurchaseOfferRejected .. toctree:: :hidden: Message MessageEntity Photo Thumbnail Audio Document Animation Video Voice VideoNote Contact Location Venue Sticker Game WebPage Poll PollOption Dice Reaction VideoChatScheduled VideoChatStarted VideoChatEnded VideoChatMembersInvited WebAppData MessageReactions ChatReactions AvailableEffect BoostsStatus BusinessMessage ChatBackground ChatBoost Checklist ChecklistTask ChecklistTasksAdded ChecklistTasksDone ContactRegistered DirectMessagePriceChanged DirectMessagesTopic ExternalReplyInfo FactCheck FormattedText ForumTopic ForumTopicClosed ForumTopicCreated ForumTopicEdited ForumTopicReopened GeneralForumTopicHidden GeneralForumTopicUnhidden Gift GiftAttribute GiftAuction GiftAuctionState GiftCollection GiftedPremium GiftedStars GiftedTon Giveaway GiveawayCompleted GiveawayCreated GiveawayPrizeStars GiveawayWinners InputChecklistTask Invoice LinkPreviewOptions LivePhoto ManagedBotCreated MaskPosition MediaArea MessageContent MessageOrigin MessageOriginChannel MessageOriginChat MessageOriginHiddenUser MessageOriginImport MessageOriginUser MyBoost PaidMediaInfo PaidMediaPreview PaidMessagesPriceChanged PaidMessagesRefunded PaidReactor PaymentForm PaymentOption PollOptionAdded PollOptionDeleted PremiumGiftCode ProximityAlertTriggered RefundedPayment ReplyParameters RestrictionReason RichBlock RichMessage RichText ScreenshotTaken StarAmount Story StoryView StrippedThumbnail SuggestedPostApprovalFailed SuggestedPostApproved SuggestedPostDeclined SuggestedPostInfo SuggestedPostPaid SuggestedPostParameters SuggestedPostPrice SuggestedPostRefunded TextQuote UpgradedGiftAttributeId UpgradedGiftAttributeIdBackdrop UpgradedGiftAttributeIdModel UpgradedGiftAttributeIdSymbol UpgradedGiftAttributeRarity UpgradedGiftOriginalDetails UpgradedGiftPurchaseOffer UpgradedGiftValueInfo WriteAccessAllowed AuctionBid AuctionRound AuctionState AuctionStateActive AuctionStateFinished ChatHasProtectedContentDisableRequested ChatHasProtectedContentToggled ChatOwnerChanged ChatOwnerLeft ChatTheme CheckedGiftCode CraftGiftResult CraftGiftResultFail CraftGiftResultSuccess GiftPurchaseLimit GiftResaleParameters GiftResalePrice GiftResalePriceStar GiftResalePriceTon GiftUpgradePreview GiftUpgradePrice GiftUpgradeVariants PaymentResult RichBlockAnchor RichBlockAnimation RichBlockAudio RichBlockBlockQuotation RichBlockCaption RichBlockCollage RichBlockDetails RichBlockDivider RichBlockFooter RichBlockList RichBlockListItem RichBlockMap RichBlockMathematicalExpression RichBlockParagraph RichBlockPhoto RichBlockPreformatted RichBlockPullQuotation RichBlockSectionHeading RichBlockSlideshow RichBlockTable RichBlockTableCell RichBlockThinking RichBlockUnsupported RichBlockVideo RichBlockVoiceNote RichTextAnchor RichTextAnchorLink RichTextBankCardNumber RichTextBold RichTextBotCommand RichTextCashtag RichTextCode RichTextCustomEmoji RichTextDateTime RichTextEmailAddress RichTextHashtag RichTextItalic RichTextMarked RichTextMathematicalExpression RichTextMention RichTextPhoneNumber RichTextReference RichTextReferenceLink RichTextSpoiler RichTextStrikethrough RichTextSubscript RichTextSuperscript RichTextTextMention RichTextUnderline RichTextUrl SavedCredentials Str SuccessfulPayment SuggestedPostPriceStar SuggestedPostPriceTon UpgradedGiftAttributeRarityEpic UpgradedGiftAttributeRarityLegendary UpgradedGiftAttributeRarityPerMille UpgradedGiftAttributeRarityRare UpgradedGiftAttributeRarityUncommon UpgradedGiftPurchaseOfferRejected Bot keyboards & Commands ------------------------- .. autosummary:: :nosignatures: ReplyKeyboardMarkup KeyboardButton ReplyKeyboardRemove InlineKeyboardMarkup InlineKeyboardButton LoginUrl ForceReply CallbackQuery GameHighScore CallbackGame WebAppInfo MenuButton MenuButtonCommands MenuButtonWebApp MenuButtonDefault SentWebAppMessage BotCommand BotCommandScope BotCommandScopeDefault BotCommandScopeAllPrivateChats BotCommandScopeAllGroupChats BotCommandScopeAllChatAdministrators BotCommandScopeChat BotCommandScopeChatAdministrators BotCommandScopeChatMember BotAccessSettings ChatBoostUpdated ChatShared KeyboardButtonPollType KeyboardButtonRequestChat KeyboardButtonRequestManagedBot KeyboardButtonRequestUsers LabeledPrice ManagedBotUpdated MessageReactionCountUpdated MessageReactionUpdated OrderInfo PreCheckoutQuery PurchasedPaidMedia SentGuestMessage ShippingAddress ShippingOption ShippingQuery UsersShared .. toctree:: :hidden: ReplyKeyboardMarkup KeyboardButton ReplyKeyboardRemove InlineKeyboardMarkup InlineKeyboardButton LoginUrl ForceReply CallbackQuery GameHighScore CallbackGame WebAppInfo MenuButton MenuButtonCommands MenuButtonWebApp MenuButtonDefault SentWebAppMessage BotCommand BotCommandScope BotCommandScopeDefault BotCommandScopeAllPrivateChats BotCommandScopeAllGroupChats BotCommandScopeAllChatAdministrators BotCommandScopeChat BotCommandScopeChatAdministrators BotCommandScopeChatMember BotAccessSettings ChatBoostUpdated ChatShared KeyboardButtonPollType KeyboardButtonRequestChat KeyboardButtonRequestManagedBot KeyboardButtonRequestUsers LabeledPrice ManagedBotUpdated MessageReactionCountUpdated MessageReactionUpdated OrderInfo PreCheckoutQuery PurchasedPaidMedia SentGuestMessage ShippingAddress ShippingOption ShippingQuery UsersShared Inline Mode ------------ .. autosummary:: :nosignatures: InlineQuery InlineQueryResult InlineQueryResultCachedAudio InlineQueryResultCachedDocument InlineQueryResultCachedAnimation InlineQueryResultCachedPhoto InlineQueryResultCachedSticker InlineQueryResultCachedVideo InlineQueryResultCachedVoice InlineQueryResultArticle InlineQueryResultAudio InlineQueryResultContact InlineQueryResultDocument InlineQueryResultAnimation InlineQueryResultLocation InlineQueryResultPhoto InlineQueryResultVenue InlineQueryResultVideo InlineQueryResultVoice ChosenInlineResult .. toctree:: :hidden: InlineQuery InlineQueryResult InlineQueryResultCachedAudio InlineQueryResultCachedDocument InlineQueryResultCachedAnimation InlineQueryResultCachedPhoto InlineQueryResultCachedSticker InlineQueryResultCachedVideo InlineQueryResultCachedVoice InlineQueryResultArticle InlineQueryResultAudio InlineQueryResultContact InlineQueryResultDocument InlineQueryResultAnimation InlineQueryResultLocation InlineQueryResultPhoto InlineQueryResultVenue InlineQueryResultVideo InlineQueryResultVoice ChosenInlineResult Input Content -------------- .. autosummary:: :nosignatures: InputMedia InputMediaPhoto InputMediaVideo InputMediaAudio InputMediaAnimation InputMediaDocument InputPhoneContact InputChatPhoto InputChecklist InputCredentials InputCredentialsApplePay InputCredentialsGooglePay InputCredentialsNew InputCredentialsSaved InputInvoice InputInvoiceMessage InputInvoiceMessageContent InputInvoiceName InputMediaLink InputMediaLivePhoto InputMediaLocation InputMediaSticker InputMediaVenue InputMessageContent InputPollMedia InputPollOption InputPollOptionMedia InputPrivacyRule InputPrivacyRuleAllowAll InputPrivacyRuleAllowBots InputPrivacyRuleAllowChats InputPrivacyRuleAllowCloseFriends InputPrivacyRuleAllowContacts InputPrivacyRuleAllowPremium InputPrivacyRuleAllowUsers InputPrivacyRuleDisallowAll InputPrivacyRuleDisallowBots InputPrivacyRuleDisallowChats InputPrivacyRuleDisallowContacts InputPrivacyRuleDisallowUsers InputRichMessage InputRichMessageContent InputTextMessageContent InputContactMessageContent InputLocationMessageContent InputVenueMessageContent InputChatPhotoAnimation InputChatPhotoPrevious InputChatPhotoStatic .. toctree:: :hidden: InputMedia InputMediaPhoto InputMediaVideo InputMediaAudio InputMediaAnimation InputMediaDocument InputPhoneContact InputChatPhoto InputChecklist InputCredentials InputCredentialsApplePay InputCredentialsGooglePay InputCredentialsNew InputCredentialsSaved InputInvoice InputInvoiceMessage InputInvoiceMessageContent InputInvoiceName InputMediaLink InputMediaLivePhoto InputMediaLocation InputMediaSticker InputMediaVenue InputMessageContent InputPollMedia InputPollOption InputPollOptionMedia InputPrivacyRule InputPrivacyRuleAllowAll InputPrivacyRuleAllowBots InputPrivacyRuleAllowChats InputPrivacyRuleAllowCloseFriends InputPrivacyRuleAllowContacts InputPrivacyRuleAllowPremium InputPrivacyRuleAllowUsers InputPrivacyRuleDisallowAll InputPrivacyRuleDisallowBots InputPrivacyRuleDisallowChats InputPrivacyRuleDisallowContacts InputPrivacyRuleDisallowUsers InputRichMessage InputRichMessageContent InputTextMessageContent InputContactMessageContent InputLocationMessageContent InputVenueMessageContent InputChatPhotoAnimation InputChatPhotoPrevious InputChatPhotoStatic Authorization ------------- .. autosummary:: :nosignatures: SentCode TermsOfService ActiveSession ActiveSessions FirebaseAuthenticationSettings PhoneNumberAuthenticationSettings List FirebaseAuthenticationSettingsAndroid FirebaseAuthenticationSettingsIos .. toctree:: :hidden: SentCode TermsOfService ActiveSession ActiveSessions FirebaseAuthenticationSettings PhoneNumberAuthenticationSettings List FirebaseAuthenticationSettingsAndroid FirebaseAuthenticationSettingsIos ----- Enums ===== This page lists all available enums from the ``pyrogram.enums`` package. .. code-block:: python from pyrogram.enums import ParseMode, ChatAction, ... .. currentmodule:: pyrogram.enums .. autosummary:: :nosignatures: BlockList BusinessSchedule ButtonStyle ChatAction ChatEventAction ChatJoinRequestQueryResult ChatJoinType ChatMemberStatus ChatMembersFilter ChatType ClientPlatform FolderColor GiftAttributeType GiftForResaleOrder GiftPurchaseOfferState GiftType MaskPointType MediaAreaType MessageEntityType MessageMediaType MessageOriginType MessageServiceType MessagesFilter NextCodeType PaidReactionPrivacy ParseMode PaymentFormType PhoneCallDiscardReason PhoneNumberCodeType PollType PrivacyKey PrivacyRuleType ProfileColor ProfileTab ReplyColor SentCodeType StickerType StoriesPrivacyRules SuggestedPostRefundReason SuggestedPostState TopChatCategory UpgradedGiftOrigin UserStatus .. toctree:: :hidden: BlockList BusinessSchedule ButtonStyle ChatAction ChatEventAction ChatJoinRequestQueryResult ChatJoinType ChatMemberStatus ChatMembersFilter ChatType ClientPlatform FolderColor GiftAttributeType GiftForResaleOrder GiftPurchaseOfferState GiftType MaskPointType MediaAreaType MessageEntityType MessageMediaType MessageOriginType MessageServiceType MessagesFilter NextCodeType PaidReactionPrivacy ParseMode PaymentFormType PhoneCallDiscardReason PhoneNumberCodeType PollType PrivacyKey PrivacyRuleType ProfileColor ProfileTab ReplyColor SentCodeType StickerType StoriesPrivacyRules SuggestedPostRefundReason SuggestedPostState TopChatCategory UpgradedGiftOrigin UserStatus