ChatInvite

class pyrogram.raw.types.ChatInvite

Chat invite info

Constructor of ChatInvite.

Details:

  • Layer: 223

  • ID: 5C9D3702

Parameters:

  • title (str) – Chat/supergroup/channel title

  • photo (Photo) – Chat/supergroup/channel photo

  • participants_count (int 32-bit) – Participant count

  • color (int 32-bit) – Profile color palette ID

  • channel (bool, optional) – Whether this is a channel/supergroup or a normal group

  • broadcast (bool, optional) – Whether this is a channel

  • public (bool, optional) – Whether this is a public channel/supergroup

  • megagroup (bool, optional) – Whether this is a supergroup

  • request_needed (bool, optional) – Whether the join request » must be first approved by an administrator

  • verified (bool, optional) – Is this chat or channel verified by Telegram?

  • scam (bool, optional) – This chat is probably a scam

  • fake (bool, optional) – If set, this chat was reported by many users as a fake or scam: be careful when interacting with it.

  • can_refulfill_subscription (bool, optional) – If set, indicates that the user has already paid for the associated Telegram Star subscriptions » and it hasn’t expired yet, so they may re-join the channel using messages.importChatInvite without repeating the payment.

  • about (str, optional) – Description of the group of channel

  • participants (List of User, optional) – A few of the participants that are in the group

  • subscription_pricing (StarsSubscriptionPricing, optional) – For Telegram Star subscriptions », contains the pricing of the subscription the user must activate to join the private channel.

  • subscription_form_id (int 64-bit, optional) – For Telegram Star subscriptions », the ID of the payment form for the subscription.

  • bot_verification (BotVerification, optional) – Describes a bot verification icon ».

Functions:

This object can be returned by 1 function.

messages.CheckChatInvite

Check the validity of a chat invite link and get basic info about it

TL Schema

chatInvite#5c9d3702
flags:#
channel:flags.0?true
broadcast:flags.1?true
public:flags.2?true
megagroup:flags.3?true
request_needed:flags.6?true
verified:flags.7?true
scam:flags.8?true
fake:flags.9?true
can_refulfill_subscription:flags.11?true
title:string
about:flags.5?string
photo:Photo
participants_count:int
participants:flags.4?Vector<User>
color:int
subscription_pricing:flags.10?StarsSubscriptionPricing
subscription_form_id:flags.12?long
bot_verification:flags.13?BotVerification

= ChatInvite

Parameter Tree

ChatInvite
├── channel → true (optional)
├── broadcast → true (optional)
├── public → true (optional)
├── megagroup → true (optional)
├── request_needed → true (optional)
├── verified → true (optional)
├── scam → true (optional)
├── fake → true (optional)
├── can_refulfill_subscription → true (optional)
├── title → string
├── about → string (optional)
├── photo → Photo
│ ├── PhotoEmpty
│ │ └── id → long
│ └── Photo
│ ├── has_stickers → true (optional)
│ ├── id → long
│ ├── access_hash → long
│ ├── file_reference → bytes
│ ├── date → int
│ ├── sizes → Vector < PhotoSize >
│ │ ├── 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_sizes → 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
├── participants_count → int
├── participants → Vector < User > (optional)
│ ├── 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)
├── color → int
├── subscription_pricing → StarsSubscriptionPricing (optional)
│ └── StarsSubscriptionPricing
│ ├── period → int
│ └── amount → long
├── subscription_form_id → long (optional)
└── bot_verification → BotVerification (optional)
└── BotVerification
├── bot_id → long
├── icon → long
└── description → string

Example

ChatInvite(
    title="text",
    photo=PhotoEmpty(id=0),
    participants_count=0,
    color=0,
)