Chat

class pyrogram.types.Chat

A chat.

Parameters:

  • id (int) – Unique identifier for this chat.

  • type (ChatType) – Type of chat.

  • is_verified (bool, optional) – True, if this chat has been verified by Telegram. Supergroups, channels and bots only.

  • is_restricted (bool, optional) – True, if this chat has been restricted. Supergroups, channels and bots only. See restriction_reason for details.

  • is_creator (bool, optional) – True, if this chat owner is the current user. Supergroups, channels and groups only.

  • is_scam (bool, optional) – True, if this chat has been flagged for scam.

  • is_fake (bool, optional) – True, if this chat has been flagged for impersonation.

  • is_forum (bool, optional) – True, if the supergroup chat is a forum

  • is_support (bool) – True, if this chat is part of the Telegram support team. Users and bots only.

  • title (str, optional) – Title, for supergroups, channels and basic group chats.

  • username (str, optional) – Username, for private chats, bots, supergroups and channels if available.

  • first_name (str, optional) – First name of the other party in a private chat, for private chats and bots.

  • last_name (str, optional) – Last name of the other party in a private chat, for private chats.

  • photo (ChatPhoto, optional) – Chat photo. Suitable for downloads only.

  • bio (str, optional) – Bio of the other party in a private chat. Returned only in get_chat().

  • description (str, optional) – Description, for groups, supergroups and channel chats. Returned only in get_chat().

  • dc_id (int, optional) – The chat assigned DC (data center). Available only in case the chat has a photo. Note that this information is approximate; it is based on where Telegram stores the current chat photo. It is accurate only in case the owner has set the chat photo, otherwise the dc_id will be the one assigned to the administrator who set the current chat photo.

  • has_protected_content (bool, optional) – True, if messages from the chat can’t be forwarded to other chats.

  • has_hidden_members (bool, optional) – True, if non-administrators can only get the list of bots and administrators in the chat.

  • invite_link (str, optional) – Chat invite link, for groups, supergroups and channels. Returned only in get_chat().

  • pinned_message (Message, optional) – Pinned message, for groups, supergroups channels and own chat. Returned only in get_chat().

  • has_visible_history (bool, optional) – True, if new chat members will have access to old messages; available only to chat administrators.

  • sticker_set_name (str, optional) – For supergroups, name of group sticker set. Returned only in get_chat().

  • can_set_sticker_set (bool, optional) – True, if the group sticker set can be changed by you. Returned only in get_chat().

  • members_count (int, optional) – Chat members count, for groups, supergroups and channels only. Returned only in get_chat().

  • restrictions (List of Restriction, optional) – The list of reasons why this chat might be unavailable to some users. This field is available only in case is_restricted is True.

  • permissions (ChatPermissions optional) – Default chat member permissions, for groups and supergroups.

  • distance (int, optional) – Distance in meters of this group chat from your location. Returned only in get_nearby_chats().

  • linked_chat (Chat, optional) – The linked discussion group (in case of channels) or the linked channel (in case of supergroups). Returned only in get_chat().

  • send_as_chat (Chat, optional) – The default “send_as” chat. Returned only in get_chat().

  • available_reactions (ChatReactions, optional) – Available reactions in the chat. Returned only in get_chat().

  • usernames (List of Username, optional) – The list of chat’s collectible (and basic) usernames if availables.

  • admin_privileges (ChatPrivileges, optional) – Administrator rights available to the current user in this chat.

  • stories_hidden (bool, optional) – True, if stories from this chat are hidden for the current user.

  • stories_hidden_min (bool, optional) – True, if the chat only shows the minimum number of stories.

  • stories_unavailable (bool, optional) – True, if stories from this chat are currently unavailable.

  • signature_profiles (bool, optional) – True, if signature profiles are enabled for this chat.

  • autotranslation (bool, optional) – True, if automatic translation is enabled for this chat.

  • broadcast_messages_allowed (bool, optional) – True, if broadcast messages are allowed in this chat.

  • monoforum (bool, optional) – True, if this chat is a monoforum instance.

  • forum_tabs (bool, optional) – True, if forum tabs are enabled for this chat.

  • stories_max_id (int, optional) – Identifier of the most recent story viewed in this chat.

  • color (PeerColor, optional) – Accent color information associated with the chat.

  • profile_color (PeerColor, optional) – Profile color information associated with the chat.

  • emoji_status (EmojiStatus, optional) – Emoji status attached to the chat.

  • access_hash (int, optional) – Access hash required for MTProto requests involving this chat.

  • level (int, optional) – Current chat level, if available.

  • subscription_until_date (datetime, optional) – Expiration date of an active subscription for this chat.

  • bot_verification_icon (int, optional) – Identifier of the bot verification icon associated with this chat.

  • send_paid_messages_stars (int, optional) – Number of Stars required to send paid messages in the chat.

  • linked_monoforum_id (int, optional) – Identifier of the linked monoforum, if any.

  • restriction_reason (List of Restriction, optional) – Reasons why access to this chat may be restricted.

  • wallpaper (Wallpaper, optional) – Wallpaper of the chat.

  • birthday (Birthday, optional) – Birthday of the user.

  • business_intro (BusinessIntro, optional) – Business introduction.

  • business_location (BusinessLocation, optional) – Business location.

  • business_work_hours (BusinessWorkHours, optional) – Business work hours.

  • business_greeting_message (BusinessGreetingMessage, optional) – Business greeting message.

  • business_away_message (BusinessAwayMessage, optional) – Business away message.

  • personal_chat (Chat, optional) – Personal channel of the user.

  • stargifts_count (int, optional) – Number of Star Gifts.

  • boosts_applied (int, optional) – Number of boosts applied.

  • unrestrict_boost_count (int, optional) – Number of boosts required to unrestrict.

  • is_contact_require_premium (bool, optional) – True, if the user requires premium to contact.

  • full_name (str, property) – Full name of the other party in a private chat, for private chats and bots.