Interface Supergroup

Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers.

interface Supergroup {
    @type: "supergroup";
    boost_level: number;
    date: number;
    has_active_stories?: boolean;
    has_linked_chat?: boolean;
    has_location?: boolean;
    has_sensitive_content?: boolean;
    has_unread_active_stories?: boolean;
    id: number;
    is_broadcast_group?: boolean;
    is_channel?: boolean;
    is_fake?: boolean;
    is_forum?: boolean;
    is_scam?: boolean;
    is_slow_mode_enabled?: boolean;
    is_verified?: boolean;
    join_by_request?: boolean;
    join_to_send_messages?: boolean;
    member_count: number;
    restriction_reason: string;
    show_message_sender?: boolean;
    sign_messages?: boolean;
    status: ChatMemberStatus;
    usernames: Usernames;
}

Properties

@type: "supergroup"
boost_level: number

Approximate boost level for the chat.

date: number

Point in time (Unix timestamp) when the current user joined, or the point in time when the supergroup or channel was created, in case the user is not a member.

has_active_stories?: boolean

True, if the supergroup or channel has non-expired stories available to the current user.

has_linked_chat?: boolean

True, if the channel has a discussion group, or the supergroup is the designated discussion group for a channel.

has_location?: boolean

True, if the supergroup is connected to a location, i.e. the supergroup is a location-based supergroup.

has_sensitive_content?: boolean

True, if content of media messages in the supergroup or channel chat must be hidden with 18+ spoiler.

has_unread_active_stories?: boolean

True, if the supergroup or channel has unread non-expired stories available to the current user.

id: number

Supergroup or channel identifier.

is_broadcast_group?: boolean

True, if the supergroup is a broadcast group, i.e. only administrators can send messages and there is no limit on the number of members.

is_channel?: boolean

True, if the supergroup is a channel.

is_fake?: boolean

True, if many users reported this supergroup or channel as a fake account.

is_forum?: boolean

True, if the supergroup is a forum with topics.

is_scam?: boolean

True, if many users reported this supergroup or channel as a scam.

is_slow_mode_enabled?: boolean

True, if the slow mode is enabled in the supergroup.

is_verified?: boolean

True, if the supergroup or channel is verified.

join_by_request?: boolean

True, if all users directly joining the supergroup need to be approved by supergroup administrators. Always false for channels and supergroups without username, location, or a linked chat.

join_to_send_messages?: boolean

True, if users need to join the supergroup before they can send messages. Always true for channels and non-discussion supergroups.

member_count: number

Number of members in the supergroup or channel; 0 if unknown. Currently, it is guaranteed to be known only if the supergroup or channel was received through getChatSimilarChats, getChatsToSendStories, getCreatedPublicChats, getGroupsInCommon, getInactiveSupergroupChats, getRecommendedChats, getSuitableDiscussionChats, getUserPrivacySettingRules, getVideoChatAvailableParticipants, searchPublicChats, or in chatFolderInviteLinkInfo.missing_chat_ids, or in userFullInfo.personal_chat_id, or for chats with messages or stories from publicForwards and foundStories.

restriction_reason: string

If non-empty, contains a human-readable description of the reason why access to this supergroup or channel must be restricted.

show_message_sender?: boolean

True, if messages sent to the channel have information about the sender user. This field is only applicable to channels.

sign_messages?: boolean

True, if messages sent to the channel contains name of the sender. This field is only applicable to channels.

Status of the current user in the supergroup or channel; custom title will always be empty.

usernames: Usernames

Usernames of the supergroup or channel; may be null.