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

    Interface Chat

    Telegram Bot API: Chat

    interface Chat {
        accent_color_id?: number;
        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_set_sticker_set?: boolean;
        custom_emoji_sticker_set_name?: string;
        description?: string;
        emoji_status_custom_emoji_id?: string;
        emoji_status_expiration_date?: number;
        first_name?: string;
        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;
        message_auto_delete_time?: number;
        permissions?: ChatPermissions;
        personal_chat?: Chat;
        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: ChatType;
        unrestrict_boost_count?: number;
        username?: string;
    }

    Hierarchy (View Summary)

    Index
    accent_color_id? active_usernames? available_reactions? background_custom_emoji_id? bio? birthdate? business_intro? business_location? business_opening_hours? 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_direct_messages? is_forum? join_by_request? join_to_send_messages? last_name? linked_chat_id? location? 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?
    accent_color_id?: number

    Identifier of the accent color for the chat name and backgrounds.

    active_usernames?: string[]

    If non-empty, the list of all active chat usernames.

    available_reactions?: ReactionType[]

    List of available reactions allowed in the chat.

    background_custom_emoji_id?: string

    Custom emoji identifier of emoji chosen for chat 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_set_sticker_set?: boolean

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

    custom_emoji_sticker_set_name?: string

    For supergroups, name of the 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.

    emoji_status_expiration_date?: number

    Expiration date of the emoji status of the chat partner in Unix time.

    first_name?: string

    First name of the other party in a private chat.

    has_aggressive_anti_spam_enabled?: boolean

    True, if aggressive anti-spam checks are enabled in the supergroup.

    has_hidden_members?: boolean

    True, if non-administrators can only see the list of bot administrators in the chat.

    has_private_forwards?: boolean

    True, if privacy settings of the other party in the private chat forbid forwarding messages.

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

    has_visible_history?: boolean

    True, if new chat members will see historical messages.

    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 new members must be approved by chat 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 discussion chat for channels.

    location?: ChatLocation

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

    message_auto_delete_time?: number

    Time in seconds after which messages are automatically deleted in the chat.

    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) in the chat.

    profile_accent_color_id?: number

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

    profile_background_custom_emoji_id?: string

    Custom emoji identifier of emoji chosen for chat profile background.

    slow_mode_delay?: number

    For supergroups, the minimum allowed interval between messages 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'.

    unrestrict_boost_count?: number

    For supergroups, the minimum number of boosts needed to bypass slow mode.

    username?: string

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

    Settings
    Member Visibility

    On This Page
    Properties