telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface ChatFullInfo

    Represents full information about a chat.

    The docs define ChatFullInfo as repeating every field of Chat, so this interface extends Chat (node's Chat field set is a strict subset of the documented ChatFullInfo field set, verified against the docs oracle) and re-declares the inherited fields to pin down the documented requiredness: accent_color_id, max_reaction_count and accepted_gift_types are always present on a ChatFullInfo even though the narrower Chat declares them optional. Extending Chat also keeps every ChatFullInfo assignable anywhere a Chat is expected, so callers that previously consumed getChat() as a Chat keep compiling.

    This is the object returned by the getChat Bot API method.

    Telegram Bot API: ChatFullInfo

    interface ChatFullInfo {
        accent_color_id: number;
        accepted_gift_types: AcceptedGiftTypes;
        active_usernames?: string[];
        available_reactions?: ReactionType[];
        background_custom_emoji_id?: string;
        bio?: string;
        birthdate?: Birthdate;
        business_intro?: BusinessIntro;
        business_location?: BusinessLocation;
        business_opening_hours?: BusinessOpeningHours;
        can_send_paid_media?: boolean;
        can_set_sticker_set?: boolean;
        community?: Community;
        custom_emoji_sticker_set_name?: string;
        description?: string;
        emoji_status_custom_emoji_id?: string;
        emoji_status_expiration_date?: number;
        first_name?: string;
        first_profile_audio?: Audio;
        guard_bot?: User;
        has_aggressive_anti_spam_enabled?: boolean;
        has_hidden_members?: boolean;
        has_private_forwards?: boolean;
        has_protected_content?: boolean;
        has_restricted_voice_and_video_messages?: boolean;
        has_visible_history?: boolean;
        id: string | number;
        invite_link?: string;
        is_direct_messages?: boolean;
        is_forum?: boolean;
        join_by_request?: boolean;
        join_to_send_messages?: boolean;
        last_name?: string;
        linked_chat_id?: number;
        location?: ChatLocation;
        max_reaction_count: number;
        message_auto_delete_time?: number;
        paid_message_star_count?: number;
        parent_chat?: Chat;
        permissions?: ChatPermissions;
        personal_chat?: Chat;
        photo?: ChatPhoto;
        pinned_message?: Message;
        profile_accent_color_id?: number;
        profile_background_custom_emoji_id?: string;
        rating?: UserRating;
        slow_mode_delay?: number;
        sticker_set_name?: string;
        title?: string;
        type: ChatType;
        unique_gift_colors?: UniqueGiftColors;
        unrestrict_boost_count?: number;
        username?: string;
    }

    Hierarchy (View Summary)

    Index
    accent_color_id accepted_gift_types 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? community? custom_emoji_sticker_set_name? description? emoji_status_custom_emoji_id? emoji_status_expiration_date? first_name? first_profile_audio? guard_bot? 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_direct_messages? is_forum? join_by_request? join_to_send_messages? last_name? linked_chat_id? location? max_reaction_count message_auto_delete_time? paid_message_star_count? parent_chat? permissions? personal_chat? photo? pinned_message? profile_accent_color_id? profile_background_custom_emoji_id? rating? slow_mode_delay? sticker_set_name? title? type unique_gift_colors? unrestrict_boost_count? username?
    accent_color_id: number

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

    accepted_gift_types: AcceptedGiftTypes

    Information about types of gifts that are accepted by the chat or by the corresponding user for private chats.

    active_usernames?: string[]

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

    available_reactions?: ReactionType[]

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

    background_custom_emoji_id?: string

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

    bio?: string

    Bio of the other party in a private chat.

    birthdate?: Birthdate

    For private chats, the date of birth of the user.

    business_intro?: BusinessIntro

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

    business_location?: BusinessLocation

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

    business_opening_hours?: BusinessOpeningHours

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

    can_send_paid_media?: boolean

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

    can_set_sticker_set?: boolean

    True, if the bot can change the group sticker set.

    community?: Community

    The community to which the chat belongs.

    custom_emoji_sticker_set_name?: string

    For supergroups, the name of the group's custom emoji sticker set.

    description?: string

    Description, for groups, supergroups and channel chats.

    emoji_status_custom_emoji_id?: string

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

    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.

    first_name?: string

    First name of the other party in a private chat.

    first_profile_audio?: Audio

    For private chats, the first audio added to the profile of the user.

    guard_bot?: User

    The bot that processes join request queries in the chat. The field is only available to chat administrators.

    has_aggressive_anti_spam_enabled?: boolean

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

    has_hidden_members?: boolean

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

    has_private_forwards?: boolean

    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.

    Optionalhas_protected_content

    has_protected_content?: boolean

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

    has_restricted_voice_and_video_messages?: boolean

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

    has_visible_history?: boolean

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

    id: string | number

    Unique identifier for this chat (integer or channel username string).

    invite_link?: string

    Primary invite link, for groups, supergroups and channel chats.

    is_direct_messages?: boolean

    True, if the chat is the direct messages chat of a channel.

    is_forum?: boolean

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

    join_by_request?: boolean

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

    join_to_send_messages?: boolean

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

    last_name?: string

    Last name of the other party in a private chat.

    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.

    location?: ChatLocation

    For supergroups, the location to which the supergroup is connected.

    max_reaction_count: number

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

    message_auto_delete_time?: number

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

    paid_message_star_count?: number

    The number of Telegram Stars a general user has to pay to send a message to the chat.

    parent_chat?: Chat

    Information about the corresponding channel chat; for direct messages chats only.

    permissions?: ChatPermissions

    Default chat member permissions, for groups and supergroups.

    personal_chat?: Chat

    For private chats, the personal channel of the user.

    photo?: ChatPhoto

    Chat photo.

    pinned_message?: Message

    The most recent pinned message (by sending date).

    profile_accent_color_id?: number

    Identifier of the accent color for the chat's profile background.

    profile_background_custom_emoji_id?: string

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

    rating?: UserRating

    For private chats, the rating of the user if any.

    slow_mode_delay?: number

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

    sticker_set_name?: string

    For supergroups, name of the group sticker set.

    title?: string

    Title, for supergroups, channels and group chats.

    type: ChatType

    Type of the chat, can be 'private', 'group', 'supergroup', or 'channel'.

    unique_gift_colors?: UniqueGiftColors

    The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews.

    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.

    username?: string

    Username, for private chats, supergroups and channels if available.

    Settings
    Member Visibility

    On This Page
    Properties
    accent_color_idaccepted_gift_typesactive_usernamesavailable_reactionsbackground_custom_emoji_idbiobirthdatebusiness_introbusiness_locationbusiness_opening_hourscan_send_paid_mediacan_set_sticker_setcommunitycustom_emoji_sticker_set_namedescriptionemoji_status_custom_emoji_idemoji_status_expiration_datefirst_namefirst_profile_audioguard_bothas_aggressive_anti_spam_enabledhas_hidden_membershas_private_forwardshas_protected_contenthas_restricted_voice_and_video_messageshas_visible_historyidinvite_linkis_direct_messagesis_forumjoin_by_requestjoin_to_send_messageslast_namelinked_chat_idlocationmax_reaction_countmessage_auto_delete_timepaid_message_star_countparent_chatpermissionspersonal_chatphotopinned_messageprofile_accent_color_idprofile_background_custom_emoji_idratingslow_mode_delaysticker_set_nametitletypeunique_gift_colorsunrestrict_boost_countusername