Interface IChat

This object represents a chat.

Hierarchy

  • IChat

Properties

active_usernames? bio? can_set_sticker_set? description? emoji_status_custom_emoji_id? first_name? has_aggressive_anti_spam_enabled? has_hidden_members? has_private_forwards? has_protected_content? has_restricted_voice_and_video_messages? id invite_link? is_forum? join_by_request? join_to_send_messages? last_name? linked_chat_id? location? message_auto_delete_time? permissions? photo? pinned_message? slow_mode_delay? sticker_set_name? title? type username?

Properties

Optional active_usernames

active_usernames?: string[]

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

Optional bio

bio?: string

Optional. Bio of the other party in a private chat. Returned only in getChat.

Optional can_set_sticker_set

can_set_sticker_set?: true

Optional. True, if the bot can change the group sticker set. Returned only in getChat.

Optional description

description?: string

Optional. Description, for groups, supergroups and channel chats. Returned only in getChat.

Optional emoji_status_custom_emoji_id

emoji_status_custom_emoji_id?: string

Optional. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.

Optional first_name

first_name?: string

Optional. First name of the other party in a private chat

Optional has_aggressive_anti_spam_enabled

has_aggressive_anti_spam_enabled?: true

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

Optional has_hidden_members

has_hidden_members?: true

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

Optional has_private_forwards

has_private_forwards?: true

Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id= links only in chats with the user. Returned only in getChat.

Optional has_protected_content

has_protected_content?: true

Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.

Optional has_restricted_voice_and_video_messages

has_restricted_voice_and_video_messages?: true

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

id

id: number

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

Optional invite_link

invite_link?: string

Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.

Optional is_forum

is_forum?: true

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

Optional join_by_request

join_by_request?: true

Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.

Optional join_to_send_messages

join_to_send_messages?: true

Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.

Optional last_name

last_name?: string

Optional. Last name of the other party in a private chat

Optional linked_chat_id

linked_chat_id?: number

Optional. 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. Returned only in getChat.

Optional location

location?: IChatLocation

Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.

Optional message_auto_delete_time

message_auto_delete_time?: number

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

Optional permissions

permissions?: IChatPermissions

Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.

Optional photo

photo?: IChatPhoto

Optional. Chat photo. Returned only in getChat.

Optional pinned_message

pinned_message?: IMessage

Optional. The most recent pinned message (by sending date). Returned only in getChat.

Optional slow_mode_delay

slow_mode_delay?: number

Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.

Optional sticker_set_name

sticker_set_name?: string

Optional. For supergroups, name of group sticker set. Returned only in getChat.

Optional title

title?: string

Optional. Title, for supergroups, channels and group chats

type

type: "channel" | "private" | "group" | "supergroup"

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

Optional username

username?: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc