ChatFull Class

accentColorId number

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

See the code

activeUsernames

The list of all active chat usernames; for private chats, supergroups and channels.

See the code

availableReactions

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

See the code

backgroundCustomEmojiId string

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

See the code

bio string

Bio of the other party in a private chat.

See the code

birthdate Birthdate

For private chats, the date of birth of the user

See the code

businessIntro BusinessIntro

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

See the code

businessLocation BusinessLocation

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

See the code

businessOpeningHours BusinessOpeningHours

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

See the code

canSendPaidMedia boolean

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

See the code

canSetStickerSet boolean

*true*, if the bot can change the group sticker set.

See the code

client Client

See the code

customEmojiStickerSetName string

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.

See the code

description string

Description, for groups, supergroups and channel chats.

See the code

emojiStatusCustomEmojiId string

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

See the code

emojiStatusExpirationDate Date

Expiration date of the emoji status of the chat or the other party in a private chat

See the code

firstName string

First name of the other party in a private chat

See the code

hasAggresiveAntiSpamEnabled boolean

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

See the code

hasHiddenMembers boolean

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

See the code

hasPrivateForwards boolean

*true*, if privacy settings of the other party in the private chat allows to use

See the code

hasProtectedContent boolean

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

See the code

hasRestrictedVoiceAndVideoMessages boolean

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

See the code

hasVisibleHistory boolean

*true*, if messages from the chat can't be forwarded to other chats

See the code

id number

Unique identifier for this chat

See the code

inviteLink string

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

See the code

isForum boolean

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

See the code

joinByRequest boolean

*true*, if all users directly joining the supergroup need to be approved by supergroup administrators.

See the code

joinToSendMessages boolean

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

See the code

lastName string

Last name of the other party in a private chat

See the code

linkedChatId number

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

See the code

location ChatLocation

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

See the code

maxReactionCount number

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

See the code

messageAutoDeleteTime number

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

See the code

permissions ChatPermissions

Default chat member permissions, for groups and supergroups.

See the code

personalChat Chat

For private chats, the personal channel of the user

See the code

photo ChatPhoto

Chat photo.

See the code

pinnedMessage Message

The most recent pinned message (by sending date).

See the code

profileAccentColorId number

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

See the code

profileBackgroundCustomEmojiId string

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

See the code

slowModeDelay number

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

See the code

stickerSetName string

For supergroups, name of group sticker set.

See the code

title string

Title, for supergroups, channels and group chats

See the code

type ChatType

Type of chat

See the code

unrestrictBoostCount 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

See the code

username string

Username, for private chats, supergroups and channels if available

See the code

approveJoinRequest(userId: number): Promise

See the code

banMember(userId: number, options: ChatMemberBanOptions): Promise

See the code

banSenderChat(senderChatId: number): Promise

See the code

closeForumTopic(forumTopicId: number): Promise

See the code

closeGeneralForumTopic(): Promise

See the code

createForumTopic(name: string, options: ForumTopicCreateOptions): Promise

See the code

createInviteLink(options: ChatInviteLinkCreateOptions): Promise

See the code

declineJoinRequest(userId: number): Promise

See the code

deleteForumTopic(forumTopicId: number): Promise

See the code

deleteMyCommands(options: Omit): Promise

See the code

deletePhoto(): Promise

See the code

deleteStickerSet(): Promise

See the code

editForumTopic(forumTopicId: number, options: ForumTopicEditOptions): Promise

See the code

editGeneralForumTopic(options: GeneralForumTopicEditOptions): Promise

See the code

editInviteLink(inviteLink: string, options: ChatInviteLinkEditOptions): Promise

See the code

exportInviteLink(): Promise

See the code

getAdministrators(): Promise

See the code

getMember(userId: number): Promise

See the code

getMemberCount(): Promise

See the code

getMenuButton(): Promise

See the code

getMyCommands(options: Omit): Promise

See the code

hideGeneralForumTopic(): Promise

See the code

leave(): Promise

See the code

pinMessage(messageId: number, options: ChatMessagePinOptions): Promise

See the code

promoteMember(userId: number, options: ChatMemberPromoteOptions): Promise

See the code

reopenForumTopic(forumTopicId: number): Promise

See the code

reopenGeneralForumTopic(): Promise

See the code

restrictMember(userId: number, permissions: ChatPermissions, options: ChatMemberRestrictOptions): Promise

See the code

revokeInviteLink(inviteLink: string): Promise

See the code

sendAnimation(animation: string, options: AnimationMessageSendOptions): Promise

See the code

sendAudio(audio: string, options: AudioMessageSendOptions): Promise

See the code

sendChatAction(action: ChatAction): Promise

See the code

sendContact(contact: ContactOptions, options: ContactMessageSendOptions): Promise

See the code

sendDice(emoji: DiceEmoji, options: DiceMessageSendOptions): Promise

See the code

sendDocument(document: string, options: DocumentMessageSendOptions): Promise

See the code

sendInvoice(options: InvoiceSendOptions): Promise

See the code

sendLocation(latitude: number, longitude: number, options: LocationMessageSendOptions): Promise

See the code

sendMediaGroup(media: undefined, options: MediaGroupMessageSendOptions): Promise

See the code

sendMessage(text: string, options: TextMessageSendOptions): Promise

See the code

sendPhoto(photo: string, options: PhotoMessageSendOptions): Promise

See the code

sendPoll(poll: PollOptions, options: PollMessageSendOptions): Promise

See the code

sendSticker(sticker: string, options: StickerSendOptions): Promise

See the code

sendVenue(venue: VenueOptions, options: VenueMessageSendOptions): Promise

See the code

sendVideo(video: string, options: VideoMessageSendOptions): Promise

See the code

sendVideoNote(videoNote: string, options: AudioMessageSendOptions): Promise

See the code

sendVoice(voice: string, options: AudioMessageSendOptions): Promise

See the code

setAdministratorCustomTitle(userId: number, customTitle: string): Promise

See the code

setDescription(description: string): Promise

See the code

setMenuButton(menuButton: MenuButton): Promise

See the code

setMyCommands(commands: undefined, options: Omit): Promise

See the code

setPermissions(permissions: ChatPermissions): Promise

See the code

setPhoto(photo: string): Promise

See the code

setStickerSet(stickerSetName: string): Promise

See the code

setTitle(title: string): Promise

See the code

unbanMember(userId: number, options: ChatMemberUnbanOptions): Promise

See the code

unbanSenderChat(senderChatId: number): Promise

See the code

unhideGeneralForumTopic(): Promise

See the code

unpinAllForumTopicMessages(forumTopicId: number): Promise

See the code

unpinAllMessages(): Promise

See the code

unpinMessage(messageId: number): Promise

See the code