help.PremiumPromo

class pyrogram.raw.types.help.PremiumPromo

Telegram Premium promotion information

Constructor of PremiumPromo.

Details:

  • Layer: 223

  • ID: 5334759C

Parameters:

  • status_text (str) – Description of the current state of the user’s Telegram Premium subscription

  • status_entities (List of MessageEntity) – Message entities for styled text

  • video_sections (List of str) – A list of premium feature identifiers », associated to each video

  • videos (List of Document) – A list of videos

  • period_options (List of PremiumSubscriptionOption) – Telegram Premium subscription options

  • users (List of User) – Related user information

Functions:

This object can be returned by 1 function.

help.GetPremiumPromo

Get Telegram Premium promotion information

TL Schema

help.premiumPromo#5334759c
status_text:string
status_entities:Vector<MessageEntity>
video_sections:Vector<string>
videos:Vector<Document>
period_options:Vector<PremiumSubscriptionOption>
users:Vector<User>

= help.PremiumPromo

Parameter Tree

PremiumPromo
├── status_text → string
├── status_entities → Vector < MessageEntity >
│ ├── MessageEntityUnknown
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityMention
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityHashtag
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBotCommand
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityUrl
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityEmail
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBold
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityItalic
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCode
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityPre
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── language → string
│ ├── MessageEntityTextUrl
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── url → string
│ ├── MessageEntityMentionName
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── user_id → long
│ ├── InputMessageEntityMentionName
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── user_id → InputUser
│ │ ├── InputUserEmpty
│ │ ├── InputUserSelf
│ │ ├── InputUser
│ │ └── InputUserFromMessage
│ ├── MessageEntityPhone
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCashtag
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityUnderline
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityStrike
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityBankCard
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntitySpoiler
│ │ ├── offset → int
│ │ └── length → int
│ ├── MessageEntityCustomEmoji
│ │ ├── offset → int
│ │ ├── length → int
│ │ └── document_id → long
│ ├── MessageEntityBlockquote
│ │ ├── collapsed → true (optional)
│ │ ├── offset → int
│ │ └── length → int
│ └── MessageEntityFormattedDate
│ ├── relative → true (optional)
│ ├── short_time → true (optional)
│ ├── long_time → true (optional)
│ ├── short_date → true (optional)
│ ├── long_date → true (optional)
│ ├── day_of_week → true (optional)
│ ├── offset → int
│ ├── length → int
│ └── date → int
├── video_sections → Vector < string >
├── videos → Vector < Document >
│ ├── DocumentEmpty
│ │ └── id → long
│ └── Document
│ ├── id → long
│ ├── access_hash → long
│ ├── file_reference → bytes
│ ├── date → int
│ ├── mime_type → string
│ ├── size → long
│ ├── thumbs → Vector < PhotoSize > (optional)
│ │ ├── PhotoSizeEmpty
│ │ │ └── type → string
│ │ ├── PhotoSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── size → int
│ │ ├── PhotoCachedSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── bytes → bytes
│ │ ├── PhotoStrippedSize
│ │ │ ├── type → string
│ │ │ └── bytes → bytes
│ │ ├── PhotoSizeProgressive
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── sizes → Vector < int >
│ │ └── PhotoPathSize
│ │ ├── type → string
│ │ └── bytes → bytes
│ ├── video_thumbs → Vector < VideoSize > (optional)
│ │ ├── VideoSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ ├── size → int
│ │ │ └── video_start_ts → double (optional)
│ │ ├── VideoSizeEmojiMarkup
│ │ │ ├── emoji_id → long
│ │ │ └── background_colors → Vector < int >
│ │ └── VideoSizeStickerMarkup
│ │ ├── stickerset → InputStickerSet
│ │ │ ├── InputStickerSetEmpty
│ │ │ ├── InputStickerSetID
│ │ │ ├── InputStickerSetShortName
│ │ │ ├── InputStickerSetAnimatedEmoji
│ │ │ ├── InputStickerSetDice
│ │ │ ├── InputStickerSetAnimatedEmojiAnimations
│ │ │ ├── InputStickerSetPremiumGifts
│ │ │ ├── InputStickerSetEmojiGenericAnimations
│ │ │ ├── InputStickerSetEmojiDefaultStatuses
│ │ │ ├── InputStickerSetEmojiDefaultTopicIcons
│ │ │ ├── InputStickerSetEmojiChannelDefaultStatuses
│ │ │ └── InputStickerSetTonGifts
│ │ ├── sticker_id → long
│ │ └── background_colors → Vector < int >
│ ├── dc_id → int
│ └── attributes → Vector < DocumentAttribute >
│ ├── DocumentAttributeImageSize
│ │ ├── w → int
│ │ └── h → int
│ ├── DocumentAttributeAnimated
│ ├── DocumentAttributeSticker
│ │ ├── mask → true (optional)
│ │ ├── alt → string
│ │ ├── stickerset → InputStickerSet
│ │ │ ├── InputStickerSetEmpty
│ │ │ ├── InputStickerSetID
│ │ │ ├── InputStickerSetShortName
│ │ │ ├── InputStickerSetAnimatedEmoji
│ │ │ ├── InputStickerSetDice
│ │ │ ├── InputStickerSetAnimatedEmojiAnimations
│ │ │ ├── InputStickerSetPremiumGifts
│ │ │ ├── InputStickerSetEmojiGenericAnimations
│ │ │ ├── InputStickerSetEmojiDefaultStatuses
│ │ │ ├── InputStickerSetEmojiDefaultTopicIcons
│ │ │ ├── InputStickerSetEmojiChannelDefaultStatuses
│ │ │ └── InputStickerSetTonGifts
│ │ └── mask_coords → MaskCoords (optional)
│ │ └── MaskCoords
│ ├── DocumentAttributeVideo
│ │ ├── round_message → true (optional)
│ │ ├── supports_streaming → true (optional)
│ │ ├── nosound → true (optional)
│ │ ├── duration → double
│ │ ├── w → int
│ │ ├── h → int
│ │ ├── preload_prefix_size → int (optional)
│ │ ├── video_start_ts → double (optional)
│ │ └── video_codec → string (optional)
│ ├── DocumentAttributeAudio
│ │ ├── voice → true (optional)
│ │ ├── duration → int
│ │ ├── title → string (optional)
│ │ ├── performer → string (optional)
│ │ └── waveform → bytes (optional)
│ ├── DocumentAttributeFilename
│ │ └── file_name → string
│ ├── DocumentAttributeHasStickers
│ └── DocumentAttributeCustomEmoji
│ ├── free → true (optional)
│ ├── text_color → true (optional)
│ ├── alt → string
│ └── stickerset → InputStickerSet
│ ├── InputStickerSetEmpty
│ ├── InputStickerSetID
│ ├── InputStickerSetShortName
│ ├── InputStickerSetAnimatedEmoji
│ ├── InputStickerSetDice
│ ├── InputStickerSetAnimatedEmojiAnimations
│ ├── InputStickerSetPremiumGifts
│ ├── InputStickerSetEmojiGenericAnimations
│ ├── InputStickerSetEmojiDefaultStatuses
│ ├── InputStickerSetEmojiDefaultTopicIcons
│ ├── InputStickerSetEmojiChannelDefaultStatuses
│ └── InputStickerSetTonGifts
├── period_options → Vector < PremiumSubscriptionOption >
│ └── PremiumSubscriptionOption
│ ├── current → true (optional)
│ ├── can_purchase_upgrade → true (optional)
│ ├── transaction → string (optional)
│ ├── months → int
│ ├── currency → string
│ ├── amount → long
│ ├── bot_url → string
│ └── store_product → string (optional)
└── users → Vector < User >
├── UserEmpty
│ └── id → long
└── User
├── is_self → true (optional)
├── contact → true (optional)
├── mutual_contact → true (optional)
├── deleted → true (optional)
├── bot → true (optional)
├── bot_chat_history → true (optional)
├── bot_nochats → true (optional)
├── verified → true (optional)
├── restricted → true (optional)
├── min → true (optional)
├── bot_inline_geo → true (optional)
├── support → true (optional)
├── scam → true (optional)
├── apply_min_photo → true (optional)
├── fake → true (optional)
├── bot_attach_menu → true (optional)
├── premium → true (optional)
├── attach_menu_enabled → true (optional)
├── bot_can_edit → true (optional)
├── close_friend → true (optional)
├── stories_hidden → true (optional)
├── stories_unavailable → true (optional)
├── contact_require_premium → true (optional)
├── bot_business → true (optional)
├── bot_has_main_app → true (optional)
├── bot_forum_view → true (optional)
├── bot_forum_can_manage_topics → true (optional)
├── id → long
├── access_hash → long (optional)
├── first_name → string (optional)
├── last_name → string (optional)
├── username → string (optional)
├── phone → string (optional)
├── photo → UserProfilePhoto (optional)
│ ├── UserProfilePhotoEmpty
│ └── UserProfilePhoto
│ ├── has_video → true (optional)
│ ├── personal → true (optional)
│ ├── photo_id → long
│ ├── stripped_thumb → bytes (optional)
│ └── dc_id → int
├── status → UserStatus (optional)
│ ├── UserStatusEmpty
│ ├── UserStatusOnline
│ │ └── expires → int
│ ├── UserStatusOffline
│ │ └── was_online → int
│ ├── UserStatusRecently
│ │ └── by_me → true (optional)
│ ├── UserStatusLastWeek
│ │ └── by_me → true (optional)
│ └── UserStatusLastMonth
│ └── by_me → true (optional)
├── bot_info_version → int (optional)
├── restriction_reason → Vector < RestrictionReason > (optional)
│ └── RestrictionReason
│ ├── platform → string
│ ├── reason → string
│ └── text → string
├── bot_inline_placeholder → string (optional)
├── lang_code → string (optional)
├── emoji_status → EmojiStatus (optional)
│ ├── EmojiStatusEmpty
│ ├── EmojiStatus
│ │ ├── document_id → long
│ │ └── until → int (optional)
│ ├── EmojiStatusCollectible
│ │ ├── collectible_id → long
│ │ ├── document_id → long
│ │ ├── title → string
│ │ ├── slug → string
│ │ ├── pattern_document_id → long
│ │ ├── center_color → int
│ │ ├── edge_color → int
│ │ ├── pattern_color → int
│ │ ├── text_color → int
│ │ └── until → int (optional)
│ └── InputEmojiStatusCollectible
│ ├── collectible_id → long
│ └── until → int (optional)
├── usernames → Vector < Username > (optional)
│ └── Username
│ ├── editable → true (optional)
│ ├── active → true (optional)
│ └── username → string
├── stories_max_id → RecentStory (optional)
│ └── RecentStory
│ ├── live → true (optional)
│ └── max_id → int (optional)
├── color → PeerColor (optional)
│ ├── PeerColor
│ │ ├── color → int (optional)
│ │ └── background_emoji_id → long (optional)
│ ├── PeerColorCollectible
│ │ ├── collectible_id → long
│ │ ├── gift_emoji_id → long
│ │ ├── background_emoji_id → long
│ │ ├── accent_color → int
│ │ ├── colors → Vector < int >
│ │ ├── dark_accent_color → int (optional)
│ │ └── dark_colors → Vector < int > (optional)
│ └── InputPeerColorCollectible
│ └── collectible_id → long
├── profile_color → PeerColor (optional)
│ ├── PeerColor
│ │ ├── color → int (optional)
│ │ └── background_emoji_id → long (optional)
│ ├── PeerColorCollectible
│ │ ├── collectible_id → long
│ │ ├── gift_emoji_id → long
│ │ ├── background_emoji_id → long
│ │ ├── accent_color → int
│ │ ├── colors → Vector < int >
│ │ ├── dark_accent_color → int (optional)
│ │ └── dark_colors → Vector < int > (optional)
│ └── InputPeerColorCollectible
│ └── collectible_id → long
├── bot_active_users → int (optional)
├── bot_verification_icon → long (optional)
└── send_paid_messages_stars → long (optional)

Example

PremiumPromo(
    status_text="text",
    status_entities=[
            MessageEntityUnknown(
                offset=0,
                length=0
            )
        ],
    video_sections=["text"],
    videos=[
            DocumentEmpty(id=0)
        ],
    period_options=[
            PremiumSubscriptionOption(
                months=0,
                currency="text",
                amount=0,
                bot_url="text"
            )
        ],
    users=[
            UserEmpty(id=0)
        ],
)