Skip to main content
Deno 2 is finally here 🎉️
Learn more
Very Popular
Latest
interface ChatFullInfo.SupergroupChat
import { type ChatFullInfo } from "https://deno.land/x/grammy@v1.31.3/types.ts";
const { SupergroupChat } = ChatFullInfo;

Internal type for supergroup chats

Properties

id: number

Unique identifier for this chat.

type: "supergroup"

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

title: string

Title, for supergroups, channels and group chats

optional
username: string

Username, for private chats, supergroups and channels if available

optional
first_name: undefined

First name of the other party in a private chat

optional
last_name: undefined

Last name of the other party in a private chat

optional
is_forum: true

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

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.

max_reaction_count: number

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

optional
photo: ChatPhoto

Chat photo

optional
active_usernames: string[]

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

optional
birthdate: undefined

For private chats, the date of birth of the user

optional
business_intro: undefined

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

optional
business_location: undefined

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

optional
business_opening_hours: undefined

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

optional
personal_chat: undefined

For private chats, the personal channel of the user

optional
available_reactions: ReactionType[]

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

optional
background_custom_emoji_id: string

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

optional
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: string

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

optional
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: number

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

optional
bio: string

Bio of the other party in a private chat

optional
has_private_forwards: undefined

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

optional
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
join_to_send_messages: true

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

optional
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
description: string

Description, for groups, supergroups and channel chats

optional
pinned_message: Message

The most recent pinned message (by sending date)

optional
permissions: ChatPermissions

Default chat member permissions, for groups and supergroups

optional
slow_mode_delay: number

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

optional
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
message_auto_delete_time: number

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

optional
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: true

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

optional
has_protected_content: true

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

optional
has_visible_history: true

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

optional
sticker_set_name: string

For supergroups, name of the group sticker set

optional
can_set_sticker_set: true

True, if the bot can change the group sticker set

optional
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
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: ChatLocation

For supergroups, the location to which the supergroup is connected

optional
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.