Interface SupergroupChat

Internal type for supergroup chats

interface SupergroupChat {
    accent_color_id: number;
    active_usernames?: string[];
    available_reactions?: ReactionType[];
    background_custom_emoji_id?: string;
    bio?: string;
    birthdate?: undefined;
    business_intro?: undefined;
    business_location?: undefined;
    business_opening_hours?: undefined;
    can_send_paid_media?: undefined;
    can_set_sticker_set?: true;
    custom_emoji_sticker_set_name?: string;
    description?: string;
    emoji_status_custom_emoji_id?: string;
    emoji_status_expiration_date?: number;
    first_name?: undefined;
    has_aggressive_anti_spam_enabled?: true;
    has_hidden_members?: true;
    has_private_forwards?: undefined;
    has_protected_content?: true;
    has_restricted_voice_and_video_messages?: undefined;
    has_visible_history?: true;
    id: number;
    invite_link?: string;
    is_forum?: true;
    join_by_request?: true;
    join_to_send_messages?: true;
    last_name?: undefined;
    linked_chat_id?: number;
    location?: ChatLocation;
    max_reaction_count: number;
    message_auto_delete_time?: number;
    permissions?: ChatPermissions;
    personal_chat?: undefined;
    photo?: ChatPhoto;
    pinned_message?: Message;
    profile_accent_color_id?: number;
    profile_background_custom_emoji_id?: string;
    slow_mode_delay?: number;
    sticker_set_name?: string;
    title: string;
    type: "supergroup";
    unrestrict_boost_count?: number;
    username?: string;
}

Properties

accent_color_id active_usernames? available_reactions? background_custom_emoji_id? bio? birthdate? business_intro? business_location? business_opening_hours? can_send_paid_media? can_set_sticker_set? custom_emoji_sticker_set_name? description? emoji_status_custom_emoji_id? emoji_status_expiration_date? first_name? has_aggressive_anti_spam_enabled? has_hidden_members? has_private_forwards? has_protected_content? has_restricted_voice_and_video_messages? has_visible_history? id invite_link? is_forum? join_by_request? join_to_send_messages? last_name? linked_chat_id? location? max_reaction_count message_auto_delete_time? permissions? personal_chat? photo? pinned_message? profile_accent_color_id? profile_background_custom_emoji_id? slow_mode_delay? sticker_set_name? title type unrestrict_boost_count? username?

Properties

accent_color_id

accent_color_id: number

Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.

Optional active_usernames

active_usernames?: string[]

If non-empty, the list of all active chat usernames; for private chats, supergroups and channels

Optional available_reactions

available_reactions?: ReactionType[]

List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.

Optional background_custom_emoji_id

background_custom_emoji_id?: string

Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background

Optional bio

bio?: string

Bio of the other party in a private chat

Optional birthdate

birthdate?: undefined

For private chats, the date of birth of the user

Optional business_intro

business_intro?: undefined

For private chats with business accounts, the intro of the business

Optional business_location

business_location?: undefined

For private chats with business accounts, the location of the business

Optional business_opening_hours

business_opening_hours?: undefined

For private chats with business accounts, the opening hours of the business

Optional can_send_paid_media

can_send_paid_media?: undefined

True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.

Optional can_set_sticker_set

can_set_sticker_set?: true

True, if the bot can change the group sticker set

Optional custom_emoji_sticker_set_name

custom_emoji_sticker_set_name?: string

For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.

Optional description

description?: string

Description, for groups, supergroups and channel chats

Optional emoji_status_custom_emoji_id

emoji_status_custom_emoji_id?: string

Custom emoji identifier of the emoji status of the chat or the other party in a private chat

Optional emoji_status_expiration_date

emoji_status_expiration_date?: number

Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any

Optional first_name

first_name?: undefined

First name of the other party in a private chat

Optional has_aggressive_anti_spam_enabled

has_aggressive_anti_spam_enabled?: true

True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.

Optional has_hidden_members

has_hidden_members?: true

True, if non-administrators can only get the list of bots and administrators in the chat

Optional has_private_forwards

has_private_forwards?: undefined

True, if privacy settings of the other party in the private chat allows to use tg://user?id= links only in chats with the user

Optional has_protected_content

has_protected_content?: true

True, if messages from the chat can't be forwarded to other chats

Optional has_restricted_voice_and_video_messages

has_restricted_voice_and_video_messages?: undefined

True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat

Optional has_visible_history

has_visible_history?: true

True, if new chat members will have access to old messages; available only to chat administrators

id

id: number

Unique identifier for this chat.

Optional invite_link

invite_link?: string

Primary invite link, for groups, supergroups and channel chats

Optional is_forum

is_forum?: true

True, if the supergroup chat is a forum (has topics enabled)

Optional join_by_request

join_by_request?: true

True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators

Optional join_to_send_messages

join_to_send_messages?: true

True, if users need to join the supergroup before they can send messages

Optional last_name

last_name?: undefined

Last name of the other party in a private chat

Optional linked_chat_id

linked_chat_id?: number

Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats.

Optional location

location?: ChatLocation

For supergroups, the location to which the supergroup is connected

max_reaction_count

max_reaction_count: number

The maximum number of reactions that can be set on a message in the chat

Optional message_auto_delete_time

message_auto_delete_time?: number

The time after which all messages sent to the chat will be automatically deleted; in seconds

Optional permissions

permissions?: ChatPermissions

Default chat member permissions, for groups and supergroups

Optional personal_chat

personal_chat?: undefined

For private chats, the personal channel of the user

Optional photo

photo?: ChatPhoto

Chat photo

Optional pinned_message

pinned_message?: Message

The most recent pinned message (by sending date)

Optional profile_accent_color_id

profile_accent_color_id?: number

Identifier of the accent color for the chat's profile background. See profile accent colors for more details.

Optional profile_background_custom_emoji_id

profile_background_custom_emoji_id?: string

Custom emoji identifier of the emoji chosen by the chat for its profile background

Optional slow_mode_delay

slow_mode_delay?: number

For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds

Optional sticker_set_name

sticker_set_name?: string

For supergroups, name of the group sticker set

title

title: string

Title, for supergroups, channels and group chats

type

type: "supergroup"

Type of the chat, can be either “private”, “group”, “supergroup” or “channel”

Optional unrestrict_boost_count

unrestrict_boost_count?: number

For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions

Optional username

username?: string

Username, for private chats, supergroups and channels if available

Settings

Member Visibility

Theme

On This Page

accent_color_idactive_usernamesavailable_reactionsbackground_custom_emoji_idbiobirthdatebusiness_introbusiness_locationbusiness_opening_hourscan_send_paid_mediacan_set_sticker_setcustom_emoji_sticker_set_namedescriptionemoji_status_custom_emoji_idemoji_status_expiration_datefirst_namehas_aggressive_anti_spam_enabledhas_hidden_membershas_private_forwardshas_protected_contenthas_restricted_voice_and_video_messageshas_visible_historyidinvite_linkis_forumjoin_by_requestjoin_to_send_messageslast_namelinked_chat_idlocationmax_reaction_countmessage_auto_delete_timepermissionspersonal_chatphotopinned_messageprofile_accent_color_idprofile_background_custom_emoji_idslow_mode_delaysticker_set_nametitletypeunrestrict_boost_countusername