GroupChat

^{ref / types / GroupChat}

Internal type for group chats

^Source

Properties

id

id: number;

Unique identifier for this chat.

^Source

type

type: "group";

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

^Source

title

title?: string;

Title, for supergroups, channels and group chats

^Source

username

username?: undefined;

Username, for private chats, supergroups and channels if available

^Source

first_name

first_name?: undefined;

First name of the other party in a private chat

^Source

last_name

last_name?: undefined;

Last name of the other party in a private chat

^Source

is_forum

is_forum?: undefined;

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

^Source

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.

^Source

max_reaction_count

max_reaction_count: number;

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

^Source

photo

photo?: ChatPhoto;

Chat photo

^Source

active_usernames

active_usernames?: undefined;

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

^Source

birthdate

birthdate?: undefined;

For private chats, the date of birth of the user

^Source

business_intro

business_intro?: undefined;

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

^Source

business_location

business_location?: undefined;

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

^Source

business_opening_hours

business_opening_hours?: undefined;

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

^Source

personal_chat

personal_chat?: undefined;

For private chats, the personal channel of the user

^Source

available_reactions

available_reactions?: ReactionType[];

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

^Source

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

^Source

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.

^Source

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

^Source

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

^Source

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

^Source

bio

bio?: undefined;

Bio of the other party in a private chat

^Source

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=<user_id> links only in chats with the user

^Source

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

^Source

join_to_send_messages

join_to_send_messages?: undefined;

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

^Source

join_by_request

join_by_request?: undefined;

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

^Source

description

description?: string;

Description, for groups, supergroups and channel chats

^Source

invite_link

invite_link?: string;

Primary invite link, for groups, supergroups and channel chats

^Source

pinned_message

pinned_message?: Message;

The most recent pinned message (by sending date)

^Source

permissions

permissions?: ChatPermissions;

Default chat member permissions, for groups and supergroups

^Source

slow_mode_delay

slow_mode_delay?: undefined;

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

^Source

unrestrict_boost_count

unrestrict_boost_count?: undefined;

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

^Source

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

^Source

has_aggressive_anti_spam_enabled

has_aggressive_anti_spam_enabled?: undefined;

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

^Source

has_hidden_members

has_hidden_members?: true;

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

^Source

has_protected_content

has_protected_content?: true;

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

^Source

has_visible_history

has_visible_history?: true;

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

^Source

sticker_set_name

sticker_set_name?: undefined;

For supergroups, name of the group sticker set

^Source

can_set_sticker_set

can_set_sticker_set?: true;

True, if the bot can change the group sticker set

^Source

custom_emoji_sticker_set_name

custom_emoji_sticker_set_name?: undefined;

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.

^Source

linked_chat_id

linked_chat_id?: undefined;

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

^Source

location

location?: undefined;

For supergroups, the location to which the supergroup is connected

^Source

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.

^Source