Available types

ChatFullInfo

This object contains full information about a chat.

fields

fieldtyperequireddescription
idnumberrequiredUnique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
type"private" | "group" | "supergroup" | "channel"requiredType of the chat, can be either “private”, “group”, “supergroup” or “channel”
titlestringoptionalOptional. Title, for supergroups, channels and group chats
usernamestringoptionalOptional. Username, for private chats, supergroups and channels if available
first_namestringoptionalOptional. First name of the other party in a private chat
last_namestringoptionalOptional. Last name of the other party in a private chat
is_forumbooleanoptionalOptional. True, if the supergroup chat is a forum (has topics enabled)
is_direct_messagesbooleanoptionalOptional. True, if the chat is the direct messages chat of a channel
accent_color_idnumberrequiredIdentifier 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_countnumberrequiredThe maximum number of reactions that can be set on a message in the chat
photoChatPhotooptionalOptional. Chat photo
active_usernamesstring[]optionalOptional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels
birthdateBirthdateoptionalOptional. For private chats, the date of birth of the user
business_introBusinessIntrooptionalOptional. For private chats with business accounts, the intro of the business
business_locationBusinessLocationoptionalOptional. For private chats with business accounts, the location of the business
business_opening_hoursBusinessOpeningHoursoptionalOptional. For private chats with business accounts, the opening hours of the business
personal_chatChatoptionalOptional. For private chats, the personal channel of the user
parent_chatChatoptionalOptional. Information about the corresponding channel chat; for direct messages chats only
available_reactionsReactionType[]optionalOptional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.
background_custom_emoji_idstringoptionalOptional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background
profile_accent_color_idnumberoptionalOptional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details.
profile_background_custom_emoji_idstringoptionalOptional. Custom emoji identifier of the emoji chosen by the chat for its profile background
emoji_status_custom_emoji_idstringoptionalOptional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat
emoji_status_expiration_datenumberoptionalOptional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any
biostringoptionalOptional. Bio of the other party in a private chat
has_private_forwardsbooleanoptionalOptional. 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
has_restricted_voice_and_video_messagesbooleanoptionalOptional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat
join_to_send_messagesbooleanoptionalOptional. True, if users need to join the supergroup before they can send messages
join_by_requestbooleanoptionalOptional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators
descriptionstringoptionalOptional. Description, for groups, supergroups and channel chats
invite_linkstringoptionalOptional. Primary invite link, for groups, supergroups and channel chats
pinned_messageMessageoptionalOptional. The most recent pinned message (by sending date)
permissionsChatPermissionsoptionalOptional. Default chat member permissions, for groups and supergroups
accepted_gift_typesAcceptedGiftTypesrequiredInformation about types of gifts that are accepted by the chat or by the corresponding user for private chats
can_send_paid_mediabooleanoptionalOptional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.
slow_mode_delaynumberoptionalOptional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds
unrestrict_boost_countnumberoptionalOptional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions
message_auto_delete_timenumberoptionalOptional. The time after which all messages sent to the chat will be automatically deleted; in seconds
has_aggressive_anti_spam_enabledbooleanoptionalOptional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.
has_hidden_membersbooleanoptionalOptional. True, if non-administrators can only get the list of bots and administrators in the chat
has_protected_contentbooleanoptionalOptional. True, if messages from the chat can't be forwarded to other chats
has_visible_historybooleanoptionalOptional. True, if new chat members will have access to old messages; available only to chat administrators
sticker_set_namestringoptionalOptional. For supergroups, name of the group sticker set
can_set_sticker_setbooleanoptionalOptional. True, if the bot can change the group sticker set
custom_emoji_sticker_set_namestringoptionalOptional. 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.
linked_chat_idnumberoptionalOptional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
locationChatLocationoptionalOptional. For supergroups, the location to which the supergroup is connected
ratingUserRatingoptionalOptional. For private chats, the rating of the user if any
first_profile_audioAudiooptionalOptional. For private chats, the first audio added to the profile of the user
unique_gift_colorsUniqueGiftColorsoptionalOptional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews
paid_message_star_countnumberoptionalOptional. The number of Telegram Stars a general user has to pay to send a message to the chat
guard_botUseroptionalOptional. The bot that processes join request queries in the chat. The field is only available to chat administrators.

import

types.ts
import type { ChatFullInfo } from "@yaebal/types";

used by

methods