accessPointRule
accountDaysTTL
Time to live in days of the current account
aiComposeToneDefault
aiComposeToneExample
aiComposeTone
attachMenuBotIconColor
Represents an attachment menu icon color for bot mini apps »
attachMenuBotIcon
Represents an attachment menu icon for bot mini apps »
attachMenuBot
Represents a bot mini app that can be launched from the attachment/side menu » At least one of the show_in_attach_menu or the show_in_side_menu flags will always be set.
attachMenuBotsBot
Represents a bot mini app that can be launched from the attachment menu »
attachMenuBotsNotModified
The list of bot mini apps hasn't changed
attachMenuBots
Represents a list of bot mini apps that can be launched from the attachment menu »
attachMenuPeerTypeBotPM
The bot attachment menu entry is available in private chats with other bots (excluding the bot that offers the current attachment menu)
attachMenuPeerTypeBroadcast
The bot attachment menu entry is available in channels
attachMenuPeerTypeChat
The bot attachment menu entry is available in groups and supergroups
attachMenuPeerTypePM
The bot attachment menu entry is available in private chats with other users (not bots)
attachMenuPeerTypeSameBotPM
The bot attachment menu entry is available in the chat with the bot that offers it
auctionBidLevel
Describes a bid in an auction.
authorization
Logged-in session
autoDownloadSettings
Autodownload settings
autoSaveException
Peer-specific media autosave settings
autoSaveSettings
Media autosave settings
availableEffect
Represents a message effect ». All long IDs except for id are document.ids from the containing messages availableEffects constructor. See here » for more info on how to use following fields.
availableReaction
Animations associated with a message reaction
bankCardOpenUrl
Credit card info URL provided by the bank
baseThemeArctic
Arctic theme
baseThemeClassic
Classic theme
baseThemeDay
Day theme
baseThemeNight
Night theme
baseThemeTinted
Tinted theme
birthday
Birthday information for a user. Also used to invite users to gift Telegram Premium subscriptions » to other users with birthdays within a +1/-1 day time range, related to the current day.
boolFalse
Constructor may be interpreted as a booleanfalse value.
boolTrue
The constructor can be interpreted as a booleantrue value.
boost
Info about one or more boosts applied by a specific user.
botAppNotModified
Bot app info hasn't changed.
botAppSettings
Mini app » settings
botApp
Contains information about a direct link Mini App.
botBusinessConnection
Contains info about a bot business connection.
botCommandScopeChatAdmins
The specified bot commands will be valid only for chat administrators, in all groups and supergroups.
botCommandScopeChats
The specified bot commands will be valid in all groups and supergroups.
botCommandScopeDefault
The commands will be valid in all dialogs
botCommandScopePeerAdmins
The specified bot commands will be valid for all admins of the specified group or supergroup.
botCommandScopePeerUser
The specified bot commands will be valid only for a specific user in the specified group or supergroup.
botCommandScopePeer
The specified bot commands will be valid only in a specific dialog.
botCommandScopeUsers
The specified bot commands will only be valid in all private chats with users.
botCommand
Describes a bot command that can be used in a chat
botInfo
Info about bots (available bot commands, etc)
botInlineMediaResult
Media result
botInlineMessageMediaAuto
Send whatever media is attached to the botInlineMediaResult
botInlineMessageMediaContact
Send a contact
botInlineMessageMediaGeo
Send a geolocation
botInlineMessageMediaInvoice
Send an invoice
botInlineMessageMediaVenue
Send a venue
botInlineMessageMediaWebPage
Specifies options that must be used to generate the link preview for the message, or even a standalone link preview without an attached message.
botInlineMessageRichMessage
botInlineMessageText
Send a simple text message
botInlineResult
Generic result
botMenuButtonCommands
Bot menu button that opens the bot command list when clicked.
botMenuButtonDefault
Placeholder bot menu button never returned to users: see the docs for more info.
botMenuButton
Bot menu button that opens a web app when clicked.
botPreviewMedia
Represents a Main Mini App preview media, see here » for more info.
botVerification
Describes a bot verification icon ».
botVerifierSettings
Info about the current verifier bot ».
businessAwayMessageScheduleAlways
Always send Telegram Business away messages to users writing to us in private.
businessAwayMessageScheduleCustom
Send Telegram Business away messages to users writing to us in private in the specified time span.
businessAwayMessageScheduleOutsideWorkHours
Send Telegram Business away messages to users writing to us in private outside of the configured Telegram Business working hours.
businessAwayMessage
Describes a Telegram Business away message, automatically sent to users writing to us when we're offline, during closing hours, while we're on vacation, or in some other custom time period when we cannot immediately answer to the user.
businessBotRecipients
Specifies the private chats that a connected business bot » may receive messages and interact with.
businessBotRights
Business bot rights.
businessChatLink
Contains info about a business chat deep link » created by the current account.
businessGreetingMessage
Describes a Telegram Business greeting, automatically sent to new users writing to us in private for the first time, or after a certain inactivity period.
businessIntro
Telegram Business introduction ».
businessLocation
Represents the location of a Telegram Business ».
businessRecipients
Specifies the chats that can receive Telegram Business away » and greeting » messages. If exclude_selected is set, specifies all chats that cannot receive Telegram Business away » and greeting » messages.
businessWeeklyOpen
A time interval, indicating the opening hours of a business. Note that opening hours specified by the user must be appropriately validated and transformed before uploading them to the server, as specified here ».
businessWorkHours
Specifies a set of Telegram Business opening hours.
bytes
cdnConfig
Configuration for CDN file downloads.
cdnPublicKey
Public key to use only during handshakes to CDN DCs.
channelAdminLogEventActionChangeAbout
The description was changed
channelAdminLogEventActionChangeAvailableReactions
The set of allowed message reactions » for this channel has changed
channelAdminLogEventActionChangeEmojiStatus
The emoji status was changed
channelAdminLogEventActionChangeEmojiStickerSet
The supergroup's custom emoji stickerset was changed.
channelAdminLogEventActionChangeHistoryTTL
The Time-To-Live of messages in this chat was changed
channelAdminLogEventActionChangeLinkedChat
The linked chat was changed
channelAdminLogEventActionChangeLocation
The geogroup location was changed
channelAdminLogEventActionChangePeerColor
The message accent color was changed
channelAdminLogEventActionChangePhoto
The channel/supergroup's picture was changed
channelAdminLogEventActionChangeProfilePeerColor
The profile accent color was changed
channelAdminLogEventActionChangeStickerSet
The supergroup's stickerset was changed
channelAdminLogEventActionChangeTitle
Channel/supergroup title was changed
channelAdminLogEventActionChangeUsername
Channel/supergroup username was changed
channelAdminLogEventActionChangeUsernames
The list of usernames associated with the channel was changed
channelAdminLogEventActionChangeWallpaper
The wallpaper was changed
channelAdminLogEventActionCreateTopic
A forum topic was created
channelAdminLogEventActionDefaultBannedRights
The default banned rights were modified
channelAdminLogEventActionDeleteMessage
A message was deleted
channelAdminLogEventActionDeleteTopic
A forum topic was deleted
channelAdminLogEventActionDiscardGroupCall
A group call was terminated
channelAdminLogEventActionEditMessage
A message was edited
channelAdminLogEventActionEditTopic
A forum topic was edited
channelAdminLogEventActionExportedInviteDelete
A chat invite was deleted
channelAdminLogEventActionExportedInviteEdit
A chat invite was edited
channelAdminLogEventActionExportedInviteRevoke
A specific invite link was revoked
channelAdminLogEventActionParticipantEditRank
A participant's tag » was changed.
channelAdminLogEventActionParticipantInvite
A user was invited to the group
channelAdminLogEventActionParticipantJoinByInvite
A user joined the supergroup/channel using a specific invite link
channelAdminLogEventActionParticipantJoin
A user has joined the group (in the case of big groups, info of the user that has joined isn't shown)
channelAdminLogEventActionParticipantLeave
A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown)
channelAdminLogEventActionParticipantMute
A group call participant was muted
channelAdminLogEventActionParticipantSubExtend
A paid subscriber has extended their Telegram Star subscription ».
channelAdminLogEventActionParticipantToggleAdmin
The admin rights of a user were changed
channelAdminLogEventActionParticipantToggleBan
The banned rights of a user were changed
channelAdminLogEventActionParticipantUnmute
A group call participant was unmuted
channelAdminLogEventActionParticipantVolume
channelAdminLogEvent.user_id has set the volume of participant.peer to participant volume
channelAdminLogEventActionPinTopic
A forum topic was pinned or unpinned
channelAdminLogEventActionSendMessage
A message was posted in a channel
channelAdminLogEventActionStartGroupCall
A group call was started
channelAdminLogEventActionStopPoll
A poll was stopped
channelAdminLogEventActionToggleAntiSpam
Native antispam functionality was enabled or disabled.
channelAdminLogEventActionToggleAutotranslation
Channel autotranslation was toggled ».
channelAdminLogEventActionToggleForum
Forum functionality was enabled or disabled.
channelAdminLogEventActionToggleGroupCallSetting
Group call settings were changed
channelAdminLogEventActionToggleInvites
Invites were enabled/disabled
channelAdminLogEventActionToggleNoForwards
Forwards were enabled or disabled
channelAdminLogEventActionTogglePreHistoryHidden
The hidden prehistory setting was changed
channelAdminLogEventActionToggleSignatureProfiles
Channel signature profiles were enabled/disabled.
channelAdminLogEventActionToggleSignatures
Channel signatures were enabled/disabled
channelAdminLogEventActionToggleSlowMode
Slow mode setting for supergroups was changed
channelAdminLogEventActionUpdatePinned
A message was pinned
channelAdminLogEvent
Admin log event
channelAdminLogEventsFilter
Filter only certain admin log events
channelForbidden
Indicates a channel/supergroup we can't access because we were banned, or for some other reason.
channelFull
Full info about a channel, supergroup or gigagroup. When updating the local peer database », all fields from the newly received constructor take priority over the old constructor cached locally (including by removing fields that aren't set in the new constructor).
channelLocationEmpty
No location (normal supergroup)
channelLocation
Geographical location of supergroup (geogroups)
channelMessagesFilterEmpty
No filter
channelMessagesFilter
Filter for getting only certain types of channel messages
channelParticipantAdmin
Admin
channelParticipantBanned
Banned/kicked user
channelParticipantCreator
Channel/supergroup creator
channelParticipantLeft
A participant that left the channel/supergroup
channelParticipantSelf
Myself
channelParticipant
Channel/supergroup participant
channelParticipantsAdmins
Fetch only admin participants
channelParticipantsBanned
Fetch only banned participants
channelParticipantsBots
Fetch only bot participants
channelParticipantsContacts
Fetch only participants that are also contacts
channelParticipantsKicked
Fetch only kicked participants
channelParticipantsMentions
This filter is used when looking for supergroup members to mention. This filter will automatically remove anonymous admins, and return even non-participant users that replied to a specific thread through the comment section of a channel.
channelParticipantsRecent
Fetch only recent participants
channelParticipantsSearch
Query participants by name
channel
Channel/supergroup info When updating the local peer database, all fields from the newly received constructor take priority over the old constructor cached locally (including by removing fields that aren't set in the new constructor). The only exception to the above rule is when the min flag is set, in which case only the following fields must be applied over any locally stored version: See here » for an implementation of the logic to use when updating the local user peer database.
chatAdminRights
Represents the rights of an admin in a channel/supergroup.
chatAdminWithInvites
Info about chat invites generated by admins.
chatBannedRights
Represents the rights of a normal user in a supergroup/channel/chat. In this case, the flags are inverted: if set, a flag does not allow a user to do X.
chatEmpty
Empty constructor, group doesn't exist
chatForbidden
A group to which the user has no access. E.g., because the user was kicked from the group.
chatFull
Full info about a basic group. When updating the local peer database », all fields from the newly received constructor take priority over the old constructor cached locally (including by removing fields that aren't set in the new constructor).
chatInviteAlready
The user has already joined this chat
chatInviteExported
Exported chat invite
chatInviteImporter
When and which user joined the chat using a chat invite
chatInvitePeek
A chat invitation that also allows peeking into the group to read messages without joining it.
chatInvitePublicJoinRequests
Used in updates and in the channel log to indicate when a user is requesting to join or has joined a discussion group
chatInvite
Chat invite info
chatOnlines
Number of online users in a chat
chatParticipantAdmin
Basic group admin (not usable by supergroups).
chatParticipantCreator
Represents the creator of the basic group »
chatParticipant
Basic group member (not usable by supergroups).
chatParticipantsForbidden
The full list of members of basic groups » is not available to you, because you were banned.
chatParticipants
Contains the full list of members of basic groups »; is NOT usable for supergroups/channels.
chatPhotoEmpty
Group photo is not set.
chatPhoto
Group profile photo.
chatReactionsAll
All reactions or all non-custom reactions are allowed
chatReactionsNone
No reactions are allowed
chatReactionsSome
Some reactions are allowed
chatThemeUniqueGift
A chat theme based on a collectible gift ».
chatTheme
A chat theme
chat
Info about a group. When updating the local peer database, all fields from the newly received constructor take priority over the old constructor cached locally (including by removing fields that aren't set in the new constructor). See here » for an implementation of the logic to use when updating the local user peer database.
codeSettings
Settings used by telegram servers for sending the confirm code. Example implementations: telegram for android, tdlib.
config
Current configuration
connectedBotStarRef
Info about an active affiliate program we have with a Mini App
connectedBot
Contains info about a connected business bot ».
contactBirthday
Birthday information of a contact.
contactStatus
Contact status: online / offline.
contact
A contact of the current user that is registered in the system.
dataJSON
Represents a json-encoded object
dcOption
Data center
defaultHistoryTTL
Contains info about the default value of the Time-To-Live setting, applied to all new chats.
dialogFilterChatlist
A folder imported using a chat folder deep link ».
dialogFilterDefault
Used only when reordering folders to indicate the default (all chats) folder.
dialogFilterSuggested
Suggested folders
dialogFilter
Dialog filter AKA folder
dialogFolder
Dialog in folder
dialogPeerFolder
Peer folder
dialogPeer
Peer
dialog
Chat
disallowedGiftsSettings
Disallow the reception of specific gift types.
documentAttributeAnimated
Defines an animated GIF
documentAttributeAudio
Represents an audio file
documentAttributeCustomEmoji
Info about a custom emoji
documentAttributeFilename
A simple document with a file name
documentAttributeHasStickers
Whether the current document has stickers attached
documentAttributeImageSize
Defines the width and height of an image uploaded as document
documentAttributeSticker
Defines a sticker
documentAttributeVideo
Defines a video
documentEmpty
Empty constructor, document doesn't exist.
document
Document
double
draftMessageEmpty
Empty draft
draftMessage
Represents a message draft.
emailVerificationApple
Apple ID email verification token
emailVerificationCode
Email verification code
emailVerificationGoogle
Google ID email verification token
emailVerifyPurposeLoginChange
Email verification purpose: change login email
emailVerifyPurposeLoginSetup
Email verification purpose: setup login email
emailVerifyPurposePassport
Verify an email for use in telegram passport
emojiGroupGreeting
Represents an emoji category, that should be moved to the top of the list when choosing a sticker for a business introduction
emojiGroupPremium
An emoji category, used to select all Premium-only stickers (i.e. those with a Premium effect »)/Premium-only custom emojis (i.e. those where the documentAttributeCustomEmoji.free flag is not set)
emojiGroup
Represents an emoji category.
emojiKeywordDeleted
Deleted emoji keyword
emojiKeyword
Emoji keyword
emojiKeywordsDifference
Changes to emoji keywords
emojiLanguage
Emoji language
emojiListNotModified
The list of custom emojis hasn't changed.
emojiList
Represents a list of custom emojis.
emojiStatusCollectible
An owned collectible gift » as emoji status. Cannot be passed to account.updateEmojiStatus, must be converted to an inputEmojiStatusCollectible first before passing it to that method.
emojiStatusEmpty
No emoji status is set
emojiStatus
An emoji status
emojiURL
An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation
encryptedChatDiscarded
Discarded or deleted chat.
encryptedChatEmpty
Empty constructor.
encryptedChatRequested
Request to create an encrypted chat.
encryptedChatWaiting
Chat waiting for approval of second participant.
encryptedChat
Encrypted chat
encryptedFileEmpty
Empty constructor, non-existing file.
encryptedFile
Encrypted file.
encryptedMessageService
Encrypted service message
encryptedMessage
Encrypted message.
error
Error.
exportedChatlistInvite
Exported chat folder deep link ».
exportedContactToken
Describes a temporary profile link.
exportedMessageLink
Link to a message in a supergroup/channel
exportedStoryLink
Represents a story deep link.
factCheck
Represents a fact-check » created by an independent fact-checker.
fileHash
folderPeer
Peer in a folder
folder
Folder
forumTopicDeleted
Represents a deleted forum topic.
forumTopic
Represents a forum topic.
foundStory
A story found using global story search ».
game
Indicates an already sent game
geoPointAddress
Address optionally associated to a geoPoint.
geoPointEmpty
Empty constructor.
geoPoint
GeoPoint.
globalPrivacySettings
Global privacy settings
groupCallDiscarded
An ended group call.
groupCallDonor
groupCallMessage
groupCallParticipantVideoSourceGroup
Describes a group of video synchronization source identifiers
groupCallParticipantVideo
Info about a video stream
groupCallParticipant
Info about a group call participant
groupCallStreamChannel
Info about an RTMP stream in a group call or livestream
groupCall
Info about a group call.
highScore
Game highscore
importedContact
Successfully imported contact.
inlineBotSwitchPM
The bot requested the user to message them in private
inlineBotWebView
Specifies an inline mode mini app button, shown on top of the inline query results list.
inlineQueryPeerTypeBotPM
Peer type: private chat with a bot.
inlineQueryPeerTypeBroadcast
Peer type: channel
inlineQueryPeerTypeChat
Peer type: chat
inlineQueryPeerTypeMegagroup
Peer type: supergroup
inlineQueryPeerTypePM
Peer type: private chat
inlineQueryPeerTypeSameBotPM
Peer type: private chat with the bot itself
inputAiComposeToneDefault
inputAiComposeToneID
inputAiComposeToneSlug
inputAppEvent
Event that occurred in the application.
inputBotAppID
Used to fetch information about a direct link Mini App by its ID
inputBotAppShortName
Used to fetch information about a direct link Mini App by its short name
inputBotInlineMessageGame
A game
inputBotInlineMessageID
Represents a sent inline message from the perspective of a bot (legacy constructor)
inputBotInlineMessageID64
Represents a sent inline message from the perspective of a bot
inputBotInlineMessageMediaAuto
A media
inputBotInlineMessageMediaContact
A contact
inputBotInlineMessageMediaGeo
Geolocation
inputBotInlineMessageMediaInvoice
An invoice
inputBotInlineMessageMediaVenue
Venue
inputBotInlineMessageMediaWebPage
Specifies options that will be used to generate the link preview for the message, or even a standalone link preview without an attached message.
inputBotInlineMessageRichMessage
inputBotInlineMessageText
Simple text message
inputBotInlineResultDocument
Document (media of any type except for photos)
inputBotInlineResultGame
Game
inputBotInlineResultPhoto
Photo
inputBotInlineResult
An inline bot result
inputBusinessAwayMessage
Describes a Telegram Business away message, automatically sent to users writing to us when we're offline, during closing hours, while we're on vacation, or in some other custom time period when we cannot immediately answer to the user.
inputBusinessBotRecipients
Specifies the private chats that a connected business bot » may interact with.
inputBusinessChatLink
Contains info about a business chat deep link » to be created by the current account.
inputBusinessGreetingMessage
Describes a Telegram Business greeting, automatically sent to new users writing to us in private for the first time, or after a certain inactivity period.
inputBusinessIntro
Telegram Business introduction ».
inputBusinessRecipients
Specifies the chats that can receive Telegram Business away » and greeting » messages. If exclude_selected is set, specifies all chats that cannot receive Telegram Business away » and greeting » messages.
inputChannelEmpty
Represents the absence of a channel
inputChannelFromMessage
Defines a min channel that was seen in a certain message of a certain chat.
inputChannel
Represents a channel
inputChatPhotoEmpty
Empty constructor, remove group photo.
inputChatPhoto
Existing photo to be set as a chat profile photo.
inputChatThemeEmpty
Remove any currently configured theme.
inputChatThemeUniqueGift
Set a theme based on an owned collectible gift », returned by account getUniqueGiftChatThemes.
inputChatTheme
Set an emoji-based chat theme, returned by account.getChatThemes.
inputChatUploadedPhoto
New photo to be set as group profile photo. The file, video and video_emoji_markup flags are mutually exclusive.
inputChatlistDialogFilter
Folder ID
inputCheckPasswordEmpty
There is no password
inputCheckPasswordSRP
Constructor for checking the validity of a 2FA SRP password (see SRP)
inputClientProxy
Info about an MTProxy used to connect.
inputCollectiblePhone
Represents a phone number fragment collectible
inputCollectibleUsername
Represents a username fragment collectible
inputDialogPeerFolder
All peers in a peer folder
inputDialogPeer
A peer
inputDocumentEmpty
Empty constructor.
inputDocumentFileLocation
Document location (video, voice, audio, basically every type except photo)
inputDocument
Defines a document for subsequent interaction.
inputEmojiStatusCollectible
An owned collectible gift » as emoji status: can only be used in account updateEmojiStatus, is never returned by the API. Note that once set, the status will be returned to users as a emojiStatusCollectible constructor, instead (which cannot be passed to account.updateEmojiStatus, and must be converted to an inputEmojiStatusCollectible first).
inputEncryptedChat
Creates an encrypted chat.
inputEncryptedFileBigUploaded
Assigns a new big encrypted file (over 10 MB in size), saved in parts using the method upload.saveBigFilePart.
inputEncryptedFileEmpty
Empty constructor.
inputEncryptedFileLocation
Location of encrypted secret chat file.
inputEncryptedFileUploaded
Sets new encrypted file saved by parts using upload.saveFilePart method.
inputEncryptedFile
Sets forwarded encrypted file for attachment.
inputFileBig
Assigns a big file (over 10 MB in size), saved in part using the method upload saveBigFilePart.
inputFileLocation
DEPRECATED location of a photo
inputFileStoryDocument
Used to edit the thumbnail/static preview of a story, see here » for more info on the full flow.
inputFile
Defines a file saved in parts using the method upload.saveFilePart.
inputFolderPeer
Peer in a folder
inputGameID
Indicates an already sent game
inputGameShortName
Game by short name
inputGeoPointEmpty
Empty GeoPoint constructor.
inputGeoPoint
Defines a GeoPoint by its coordinates.
inputGroupCallInviteMessage
Join a group call through a messageActionConferenceCall invitation message.
inputGroupCallSlug
Join a conference call through an invitation link ».
inputGroupCallStream
Chunk of a livestream
inputGroupCall
Points to a specific group call.
inputInvoiceBusinessBotTransferStars
Transfer stars from the balance of a user account connected to a business bot, to the balance of the business bot, see here » for more info on the full flow.
inputInvoiceChatInviteSubscription
Used to pay for a Telegram Star subscription ».
inputInvoiceMessage
An invoice contained in a messageMediaInvoice message or paid media ».
inputInvoicePremiumAuthCode
Used to pay for login codes, in case of high cost of SMS verification codes for the user's country/provider, see here » for more info.
inputInvoicePremiumGiftCode
Used if the user wishes to start a channel/supergroup giveaway or send some giftcodes to members of a channel/supergroup, in exchange for boosts.
inputInvoicePremiumGiftStars
Used to gift a Telegram Premium subscription to another user, paying with Telegram Stars.
inputInvoiceSlug
An invoice slug taken from an invoice deep link or from the premium_invoice_slug app config parameter »
inputInvoiceStarGiftAuctionBid
Used to place a bid in a collectible gift auction ».
inputInvoiceStarGiftDropOriginalDetails
Used to pay for for the removal of the starGiftAttributeOriginalDetails attribute from a collectible gift, see here » for the full flow.
inputInvoiceStarGiftPrepaidUpgrade
Separately prepay for the upgrade of a gift ».
inputInvoiceStarGiftResale
Used to buy a collectible gift currently up on resale, see here for more info on the full flow.
inputInvoiceStarGiftTransfer
Used to pay to transfer a collectible gift to another peer, see the gifts » documentation for more info.
inputInvoiceStarGiftUpgrade
Used to pay to upgrade a Gift to a collectible gift, see the collectible gifts » documentation for more info on the full flow.
inputInvoiceStarGift
Used to buy a Telegram Star Gift, see here » for more info.
inputInvoiceStars
Used to top up the Telegram Stars balance of the current account or someone else's account, or to start a Telegram Star giveaway ».
inputKeyboardButtonRequestPeer
Prompts the user to select and share one or more peers with the bot using messages sendBotRequestedPeer.
inputKeyboardButtonUrlAuth
Button to request a user to authorize via URL using Seamless Telegram Login.
inputKeyboardButtonUserProfile
Button that links directly to a user profile
inputMediaAreaChannelPost
Represents a channel post
inputMediaAreaVenue
Represents a location tag attached to a story, with additional venue information.
inputMediaContact
Phone book contact
inputMediaDice
Send a dice-based animated sticker
inputMediaDocumentExternal
Document that will be downloaded by the telegram servers
inputMediaDocument
Forwarded document
inputMediaEmpty
Empty media content of a message.
inputMediaGame
A game
inputMediaGeoLive
Live geolocation
inputMediaGeoPoint
Map.
inputMediaInvoice
Generated invoice of a bot payment
inputMediaPaidMedia
Paid media, see here » for more info.
inputMediaPhotoExternal
New photo that will be uploaded by the server using the specified URL
inputMediaPhoto
Forwarded photo
inputMediaPoll
A poll
inputMediaStakeDice
inputMediaStory
Forwarded story
inputMediaTodo
Creates a todo list ».
inputMediaUploadedDocument
New document
inputMediaUploadedPhoto
Photo
inputMediaVenue
Can be used to send a venue geolocation.
inputMediaWebPage
Specifies options that will be used to generate the link preview for the caption, or even a standalone link preview without an attached message.
inputMessageCallbackQuery
Used by bots for fetching information about the message that originated a callback query
inputMessageEntityMentionName
Message entity that can be used to create a user user mention: received mentions use the messageEntityMentionName constructor, instead.
inputMessageID
Message by ID
inputMessagePinned
Pinned message
inputMessageReadMetric
inputMessageReplyTo
Message to which the specified message replies to
inputMessagesFilterChatPhotos
Return only chat photo changes
inputMessagesFilterContacts
Return only messages containing contacts
inputMessagesFilterDocument
Filter for messages containing documents.
inputMessagesFilterEmpty
Filter is absent.
inputMessagesFilterGeo
Return only messages containing geolocations
inputMessagesFilterGif
Return only messages containing gifs
inputMessagesFilterMusic
Return only messages containing audio files
inputMessagesFilterMyMentions
Return only messages where the current user was mentioned.
inputMessagesFilterPhoneCalls
Return only phone calls
inputMessagesFilterPhotoVideo
Filter for messages containing photos or videos.
inputMessagesFilterPhotos
Filter for messages containing photos.
inputMessagesFilterPinned
Fetch only pinned messages
inputMessagesFilterPoll
inputMessagesFilterRoundVideo
Return only round videos
inputMessagesFilterRoundVoice
Return only round videos and voice notes
inputMessagesFilterUrl
Return only messages containing URLs
inputMessagesFilterVideo
Filter for messages containing videos.
inputMessagesFilterVoice
Return only messages containing voice notes
inputNotifyBroadcasts
All channels
inputNotifyChats
Notifications generated by all groups.
inputNotifyForumTopic
Notifications generated by a topic in a forum.
inputNotifyPeer
Notifications generated by a certain user or group.
inputNotifyUsers
Notifications generated by all users.
inputPageBlockMap
inputPasskeyCredentialFirebasePNV
inputPasskeyCredentialPublicKey
Public-key passkey credential used both for registration and for login, see creating a passkey » and logging in with a passkey » for the full flows.
inputPasskeyResponseLogin
WebAuthn authentication response used when logging in with a passkey, see here » for more info on the full flow. Generated from the AuthenticatorAssertionResponse object.
inputPasskeyResponseRegister
WebAuthn registration response used when registering a new passkey, see here » for more info on the full flow. Generated from the AuthenticatorAttestationResponse object.
inputPaymentCredentialsApplePay
Apple pay payment credentials
inputPaymentCredentialsGooglePay
Google Pay payment credentials
inputPaymentCredentialsSaved
Saved payment credentials
inputPaymentCredentials
Payment credentials
inputPeerChannelFromMessage
Defines a min channel that was seen in a certain message of a certain chat.
inputPeerChannel
Defines a channel for further interaction.
inputPeerChat
Defines a chat for further interaction.
inputPeerColorCollectible
Represents a color palette » associated to a collectible gift », see here » for more info.
inputPeerEmpty
An empty constructor, no user or chat is defined.
inputPeerNotifySettings
Notification settings.
inputPeerPhotoFileLocationLegacy
inputPeerPhotoFileLocation
Location of profile photo of channel/group/supergroup/user
inputPeerSelf
Defines the current user.
inputPeerUserFromMessage
Defines a min user that was seen in a certain message of a certain chat.
inputPeerUser
Defines a user for further interaction.
inputPhoneCall
Identifies a phone call.
inputPhoneContact
Phone contact.
inputPhotoEmpty
Empty constructor.
inputPhotoFileLocation
Use this object to download a photo with upload.getFile method
inputPhotoLegacyFileLocation
DEPRECATED legacy photo file location
inputPhoto
Defines a photo for further interaction.
inputPollAnswer
inputPrivacyKeyAbout
Whether people can see your bio
inputPrivacyKeyAddedByPhone
Whether people can add you to their contact list by your phone number
inputPrivacyKeyBirthday
Whether the user can see our birthday.
inputPrivacyKeyChatInvite
Whether people will be able to invite you to chats
inputPrivacyKeyForwards
Whether messages forwarded from you will be anonymous
inputPrivacyKeyNoPaidMessages
Who can send you messages without paying, if paid messages » are enabled.
inputPrivacyKeyPhoneCall
Whether you will accept phone calls
inputPrivacyKeyPhoneNumber
Whether people will be able to see your phone number
inputPrivacyKeyPhoneP2P
Whether to allow P2P communication during VoIP calls
inputPrivacyKeyProfilePhoto
Whether people will be able to see your profile picture
inputPrivacyKeySavedMusic
Whether the user can see the songs we pinned to our profile ».
inputPrivacyKeyStarGiftsAutoSave
Whether received gifts will be automatically displayed on our profile
inputPrivacyKeyStatusTimestamp
Whether people will be able to see our exact last online timestamp. Note that if we decide to hide our exact last online timestamp to someone (i.e., users A, B, C, or all users) and we do not have a Premium subscription, we won't be able to see the exact last online timestamp of those users (A, B, C, or all users), even if those users do share it with us. If those users do share their exact online status with us, but we can't see it due to the reason mentioned above, the by_me flag of userStatusRecently, userStatusLastWeek, userStatusLastMonth will be set.
inputPrivacyKeyVoiceMessages
Whether people can send you voice messages or round videos (Premium users only).
inputPrivacyValueAllowAll
Allow all users
inputPrivacyValueAllowBots
Allow bots and mini apps
inputPrivacyValueAllowChatParticipants
Allow only participants of certain chats
inputPrivacyValueAllowCloseFriends
Allow only close friends »
inputPrivacyValueAllowContacts
Allow only contacts
inputPrivacyValueAllowPremium
Allow only users with a Premium subscription », currently only usable for inputPrivacyKeyChatInvite.
inputPrivacyValueAllowUsers
Allow only certain users
inputPrivacyValueDisallowAll
Disallow all
inputPrivacyValueDisallowBots
Disallow bots and mini apps
inputPrivacyValueDisallowChatParticipants
Disallow only participants of certain chats
inputPrivacyValueDisallowContacts
Disallow only contacts
inputPrivacyValueDisallowUsers
Disallow only certain users
inputQuickReplyShortcutId
Selects a quick reply shortcut by its numeric ID.
inputQuickReplyShortcut
Selects a quick reply shortcut by name.
inputReplyToMessage
Reply to a message.
inputReplyToMonoForum
Used to send messages to a monoforum topic.
inputReplyToStory
Reply to a story.
inputReportReasonChildAbuse
Report for child abuse
inputReportReasonCopyright
Report for copyrighted content
inputReportReasonFake
Report for impersonation
inputReportReasonGeoIrrelevant
Report an irrelevant geogroup
inputReportReasonIllegalDrugs
Report for illegal drugs
inputReportReasonOther
Other
inputReportReasonPersonalDetails
Report for divulgation of personal details
inputReportReasonPornography
Report for pornography
inputReportReasonSpam
Report for spam
inputReportReasonViolence
Report for violence
inputRichFileDocument
inputRichFilePhoto
inputRichMessageHTML
inputRichMessageMarkdown
inputRichMessage
inputSavedStarGiftChat
A gift received by a channel we own.
inputSavedStarGiftSlug
Points to a collectible gift obtained from a collectible gift link ».
inputSavedStarGiftUser
A gift received in a private chat with another user.
inputSecureFileLocation
Location of encrypted telegram passport file.
inputSecureFileUploaded
Uploaded secure file, for more info see the passport docs »
inputSecureFile
Pre-uploaded passport file, for more info see the passport docs »
inputSecureValue
Secure value, for more info see the passport docs »
inputSendMessageRichMessageDraftAction
inputSingleMedia
A single media in an album or grouped media sent with messages.sendMultiMedia.
inputStarGiftAuctionSlug
Used to fetch auctions using the slug of an auction deep link ».
inputStarGiftAuction
Used to fetch auctions using the ID of the linked collectible gift.
inputStarsTransaction
Used to fetch info about a Telegram Star transaction ».
inputStickerSetAnimatedEmojiAnimations
Animated emoji reaction stickerset (contains animations to play when a user clicks on a given animated emoji)
inputStickerSetAnimatedEmoji
Animated emojis stickerset
inputStickerSetDice
Used for fetching animated dice stickers
inputStickerSetEmojiChannelDefaultStatuses
Default custom emoji status stickerset for channel statuses
inputStickerSetEmojiDefaultStatuses
Default custom emoji status stickerset
inputStickerSetEmojiDefaultTopicIcons
Default custom emoji stickerset for forum topic icons
inputStickerSetEmojiGenericAnimations
Generic animation stickerset containing animations to play when reacting to messages using a normal emoji without a custom animation
inputStickerSetEmpty
Empty constructor
inputStickerSetID
Stickerset by ID
inputStickerSetItem
Sticker in a stickerset
inputStickerSetPremiumGifts
Stickers to show when receiving a gifted Telegram Premium subscription
inputStickerSetShortName
Stickerset by short name, from a stickerset deep link »
inputStickerSetThumbLegacy
inputStickerSetThumb
Location of stickerset thumbnail (see files)
inputStickerSetTonGifts
TON gifts stickerset.
inputStickeredMediaDocument
A document with stickers attached
inputStickeredMediaPhoto
A photo with stickers attached
inputStorePaymentAuthCode
Indicates payment for a login code.
inputStorePaymentGiftPremium
Info about a gifted Telegram Premium purchase
inputStorePaymentPremiumGiftCode
Used to gift Telegram Premium subscriptions only to some specific subscribers of a channel/supergroup or to some of our contacts, see here » for more info on giveaways and gifts.
inputStorePaymentPremiumGiveaway
Used to pay for a giveaway, see here » for more info.
inputStorePaymentPremiumSubscription
Info about a Telegram Premium purchase
inputStorePaymentStarsGift
Used to gift Telegram Stars to a friend.
inputStorePaymentStarsGiveaway
Used to pay for a star giveaway, see here » for more info.
inputStorePaymentStarsTopup
Used to top up the Telegram Stars balance of the current account.
inputTakeoutFileLocation
Used to download a JSON file that will contain all personal data related to features that do not have a specialized takeout method yet, see here » for more info on the takeout API.
inputThemeSettings
Theme settings
inputThemeSlug
Theme by theme ID
inputTheme
Theme
inputUserEmpty
Empty constructor, does not define a user.
inputUserFromMessage
Defines a min user that was seen in a certain message of a certain chat.
inputUserSelf
Defines the current user.
inputUser
Defines a user for further interaction.
inputWallPaperNoFile
Wallpaper with no file access hash, used for example when deleting (unsave=true) wallpapers using account.saveWallPaper, specifying just the wallpaper ID.
inputWallPaperSlug
Wallpaper by slug (a unique ID, obtained from a wallpaper link »)
inputWallPaper
Wallpaper
inputWebDocument
The document
inputWebFileAudioAlbumThumbLocation
Used to download an album cover for any music file using upload.getWebFile, see the webfile docs for more info ».
inputWebFileGeoPointLocation
Used to download a server-generated image with the map preview from a geoPoint, see the webfile docs for more info ».
inputWebFileLocation
Location of a remote HTTP(s) file
int
invoice
Invoice
ipPortSecret
ipPort
joinChatBotResultApproved
joinChatBotResultDeclined
joinChatBotResultQueued
joinChatBotResultWebView
jsonArray
JSON array
jsonBool
JSON boolean value
jsonNull
null JSON value
jsonNumber
JSON numeric value
jsonObjectValue
JSON key: value pair
jsonObject
JSON object value
jsonString
JSON string
keyboardButtonBuy
Button to buy a product
keyboardButtonCallback
Callback button
keyboardButtonCopy
Clipboard button: when clicked, the attached text must be copied to the clipboard.
keyboardButtonGame
Button to start a game
keyboardButtonRequestGeoLocation
Button to request a user's geolocation
keyboardButtonRequestPeer
Prompts the user to select and share one or more peers with the bot using messages sendBotRequestedPeer
keyboardButtonRequestPhone
Button to request a user's phone number
keyboardButtonRequestPoll
A button that allows the user to create and send a poll when pressed; available only in private
keyboardButtonRow
Inline keyboard row
keyboardButtonSimpleWebView
Button to open a bot mini app using messages.requestSimpleWebView, without sending user information to the web app. Can only be sent or received as part of a reply keyboard, use keyboardButtonWebView for inline keyboards.
keyboardButtonStyle
This constructor allows setting a custom background color and custom emoji label for a button, see here » for more info.
keyboardButtonSwitchInline
Button to force a user to switch to inline mode: pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field.
keyboardButtonUrlAuth
Button to request a user to authorize via URL using Seamless Telegram Login. When the user clicks on such a button, messages.requestUrlAuth should be called, providing the button_id and the ID of the container message. The returned urlAuthResultRequest object will contain more details about the authorization request (request_write_access if the bot would like to send messages to the user along with the username of the bot which will be used for user authorization). Finally, the user can choose to call messages.acceptUrlAuth to get a urlAuthResultAccepted with the URL to open instead of the url of this constructor, or a urlAuthResultDefault, in which case the url of this constructor must be opened, instead. If the user refuses the authorization request but still wants to open the link, the url of this constructor must be used.
keyboardButtonUrl
URL button
keyboardButtonUserProfile
Button that links directly to a user profile
keyboardButtonWebView
Button to open a bot mini app using messages.requestWebView, sending over user information after user confirmation. Can only be sent or received as part of an inline keyboard, use keyboardButtonSimpleWebView for reply keyboards.
keyboardButton
Bot keyboard button
labeledPrice
This object represents a portion of the price for goods or services.
langPackDifference
Changes to the app's localization pack
langPackLanguage
Identifies a localization pack
langPackStringDeleted
Deleted localization string
langPackStringPluralized
A language pack string which has different forms based on the number of some object it mentions. See https://www.unicode org/cldr/charts/latest/supplemental/language_plural_rules.html for more info
langPackString
Translated localization string
long
maskCoords
Position on a photo where a mask should be placed when attaching stickers to media » The n position indicates where the mask should be placed:
mediaAreaChannelPost
Represents a channel post.
mediaAreaCoordinates
Coordinates and size of a clickable rectangular area on top of a story.
mediaAreaGeoPoint
Represents a geolocation tag attached to a story.
mediaAreaStarGift
Represents a collectible gift ».
mediaAreaSuggestedReaction
Represents a reaction bubble.
mediaAreaUrl
Represents a URL media area.
mediaAreaVenue
Represents a location tag attached to a story, with additional venue information.
mediaAreaWeather
Represents a weather widget ».
messageActionBoostApply
Some boosts » were applied to the channel or supergroup.
messageActionBotAllowed
We have given the bot permission to send us direct messages. The optional fields specify how did we authorize the bot to send us messages.
messageActionChangeCreator
Service message: emitted to a supergroup when ownership transfer completes after the old owner left the group » (7 days after the old owner left without rejoining), indicating that ownership has been transferred to a new owner. Sent from the user ID of the old owner.
messageActionChannelCreate
The channel was created
messageActionChannelMigrateFrom
Indicates the channel was migrated from the specified chat
messageActionChatAddUser
New member in the group
messageActionChatCreate
Group created
messageActionChatDeletePhoto
Group profile photo removed.
messageActionChatDeleteUser
User left the group.
messageActionChatEditPhoto
Group profile changed
messageActionChatEditTitle
Group name changed.
messageActionChatJoinedByLink
A user joined the chat via an invite link
messageActionChatMigrateTo
Indicates the chat was migrated to the specified supergroup
messageActionConferenceCall
Represents a conference call (or an invitation to a conference call, if neither the missed nor active flags are set). If call_requests_disabled is not set or false, an incoming messageActionConferenceCall with the missed and active flags not set should trigger ringing and an incoming call screen, just like for one-on-one calls.
messageActionContactSignUp
A contact just signed up to telegram
messageActionCustomAction
Custom action (most likely not supported by the current layer, an upgrade might be needed)
messageActionEmpty
Empty constructor.
messageActionGameScore
Someone scored in a game
messageActionGeoProximityReached
A user of the chat is now in proximity of another user
messageActionGiftCode
Contains a Telegram Premium giftcode link.
messageActionGiftPremium
Info about a gifted Telegram Premium subscription This service message should be displayed below the appropriate sticker from the inputStickerSetPremiumGifts » stickerset »:
messageActionGiftStars
You gifted or were gifted some Telegram Stars. This service message should be displayed below the appropriate sticker from the inputStickerSetPremiumGifts » stickerset »:
messageActionGiftTon
You were gifted some toncoins. This service message should be displayed below the appropriate sticker from the inputStickerSetTonGifts » stickerset »:
messageActionGiveawayLaunch
A giveaway was started.
messageActionGiveawayResults
A giveaway has ended.
messageActionGroupCallScheduled
A video chat/livestream was scheduled.
messageActionGroupCall
A video chat/livestream was started or terminated.
messageActionHistoryClear
Chat history was cleared
messageActionInviteToGroupCall
A set of users was invited to a group call.
messageActionManagedBotCreated
messageActionNewCreatorPending
Service message: emitted to a supergroup when the group/channel creator leaves the group », indicating that ownership transfer is pending. The new_creator_id user will become the new owner after 7 days if the old owner does not rejoin. Sent from the user ID of the old owner.
messageActionNoForwardsToggle
Emitted only in private chats when enabling or disabling content protection ».
messageActionPaidMessagesPrice
The price of paid messages » in this chat was changed.
messageActionPaidMessagesRefunded
Sent from peer A to B, indicates that A refunded all stars B previously paid to send messages to A, see here » for more info on paid messages.
messageActionPaymentRefunded
Describes a payment refund (service message received by both users and bots).
messageActionPaymentSentMe
A user just sent a payment to me (a bot)
messageActionPaymentSent
A payment was sent
messageActionPhoneCall
A phone call
messageActionPinMessage
A message was pinned
messageActionPollAppendAnswer
messageActionPollDeleteAnswer
messageActionPrizeStars
You won some Telegram Stars in a Telegram Star giveaway ». This service message should be displayed below the appropriate sticker from the inputStickerSetPremiumGifts » stickerset »:
messageActionRequestedPeerSentMe
Contains info about one or more peers that the a user shared with the me (the bot) after clicking on a keyboardButtonRequestPeer button (service message received by the bot).
messageActionRequestedPeer
Contains info about one or more peers that the we (the user) shared with the bot after clicking on a keyboardButtonRequestPeer button (service message sent by the user).
messageActionScreenshotTaken
A screenshot of the chat was taken
messageActionSecureValuesSentMe
Secure telegram passport values were received
messageActionSecureValuesSent
Request for secure telegram passport values was sent
messageActionSetChatTheme
The chat theme was changed
messageActionSetChatWallPaper
The wallpaper » of the current chat was changed.
messageActionSetMessagesTTL
The Time-To-Live of messages in this chat was changed.
messageActionStarGiftPurchaseOfferDeclined
A collectible gift purchase offer » was declined, or the offer expired, see here » for the full flow.
messageActionStarGiftPurchaseOffer
Contains an offer to purchase a collectible gift », see here » for the full flow.
messageActionStarGiftUnique
A gift » was upgraded to a collectible gift ».
messageActionStarGift
You received a gift, see here » for more info.
messageActionSuggestBirthday
A new birthday was suggested using users.suggestBirthday, see here » for more info on birthdays in the API.
messageActionSuggestProfilePhoto
A new profile picture was suggested using photos.uploadContactProfilePhoto.
messageActionSuggestedPostApproval
A suggested post » was approved or rejected.
messageActionSuggestedPostRefund
A suggested post » was accepted and posted or scheduled, but either the channel deleted the posted/scheduled post before stars_suggested_post_age_min seconds have elapsed, or the user refunded the payment for the stars used to pay for the suggested post.
messageActionSuggestedPostSuccess
A suggested post » was successfully posted, and payment for it was successfully received.
messageActionTodoAppendTasks
Items were appended to the todo list ».
messageActionTodoCompletions
Items were marked as completed or not completed in a todo list ».
messageActionTopicCreate
A forum topic was created.
messageActionTopicEdit
Forum topic information was edited.
messageActionWebViewDataSentMe
Data from an opened reply keyboard bot mini app was relayed to the bot that owns it (bot side service message).
messageActionWebViewDataSent
Data from an opened reply keyboard bot mini app was relayed to the bot that owns it (user side service message). Clients should display a service message with the text Data from the «$text» button was transferred to the bot.
messageEmpty
Empty constructor, non-existent message.
messageEntityBankCard
Indicates a credit card number
messageEntityBlockquote
Message entity representing a block quote.
messageEntityBold
Message entity representing bold text.
messageEntityBotCommand
Message entity representing a bot /command
messageEntityCashtag
Message entity representing a $cashtag.
messageEntityCode
Message entity representing a codeblock.
messageEntityCustomEmoji
Represents a custom emoji. Note that this entity must wrap exactly one regular emoji (the one contained in documentAttributeCustomEmoji.alt) in the related text, otherwise the server will ignore it.
messageEntityDiffDelete
messageEntityDiffInsert
messageEntityDiffReplace
messageEntityEmail
Message entity representing an [email protected].
messageEntityFormattedDate
Represents a specific point in time, rendered as specified here » All flags are optional, with the following limitations: If any of the flags are combined, their rendering order in the text is the following:
messageEntityHashtag
#hashtag message entity
messageEntityItalic
Message entity representing italic text.
messageEntityMentionName
Message entity representing a user mention: for creating a mention use inputMessageEntityMentionName.
messageEntityMention
Message entity mentioning a user by @username; messageEntityMentionName can also be used to mention users by their ID.
messageEntityPhone
Message entity representing a phone number.
messageEntityPre
Message entity representing a preformatted codeblock, allowing the user to specify a programming language for the codeblock.
messageEntitySpoiler
Message entity representing a spoiler
messageEntityStrike
Message entity representing strikethrough text.
messageEntityTextUrl
Message entity representing a text url: for in-text urls like https://google.com use messageEntityUrl. Note that an additional confirmation popup with the full URL must be displayed to the user before opening this link, unless the domain satisfies the conditions specified in the domain whitelist documentation ».
messageEntityUnderline
Message entity representing underlined text.
messageEntityUnknown
Unknown message entity
messageEntityUrl
Message entity representing an in-text url: https://google.com; for text urls, use messageEntityTextUrl.
messageExtendedMediaPreview
Paid media preview for not yet purchased paid media, see here » for more info.
messageExtendedMedia
Already purchased paid media, see here » for more info.
messageFwdHeader
Info about a forwarded message
messageMediaContact
Attached contact.
messageMediaDice
Dice-based animated sticker
messageMediaDocument
Document (video, audio, voice, sticker, any media type except photo)
messageMediaEmpty
Empty constructor.
messageMediaGame
Telegram game
messageMediaGeoLive
Indicates a live geolocation
messageMediaGeo
Attached map.
messageMediaGiveawayResults
A giveaway with public winners has finished, this constructor contains info about the winners.
messageMediaGiveaway
Contains info about a giveaway, see here » for more info.
messageMediaInvoice
Invoice
messageMediaPaidMedia
Paid media, see here » for more info.
messageMediaPhoto
Attached photo.
messageMediaPoll
Poll
messageMediaStory
Represents a forwarded story or a story mention.
messageMediaToDo
Represents a todo list ».
messageMediaUnsupported
Current version of the client does not support this media type.
messageMediaVenue
Venue
messageMediaVideoStream
messageMediaWebPage
Preview of webpage
messagePeerReaction
How a certain peer reacted to the message
messagePeerVoteInputOption
How a peer voted in a poll (reduced constructor, returned if an option was provided to messages.getPollVotes)
messagePeerVoteMultiple
How a peer voted in a multiple-choice poll
messagePeerVote
How a peer voted in a poll
messageRange
Indicates a range of chat messages
messageReactions
Message reactions »
messageReactor
Info about a user in the paid Star reactions leaderboard for a message.
messageReplies
Info about the comment section of a channel post, a simple message thread, a forum topic, or a direct messages topic (all features ultimately based on message threads).
messageReplyHeader
Message replies and thread information
messageReplyStoryHeader
Represents a reply to a story
messageReportOption
Report menu option
messageService
Indicates a service message
messageViews
View, forward counter + info about replies of a specific message
message
A message
missingInvitee
Info about why a specific user could not be invited ».
monoForumDialog
Represents a monoforum topic ».
myBoost
Contains information about a single boost slot ».
nearestDc
Nearest data center, according to geo-ip.
notificationSoundDefault
Indicates the default notification sound should be used
notificationSoundLocal
Indicates a specific local notification sound should be used
notificationSoundNone
No notification sound should be used
notificationSoundRingtone
A specific previously uploaded notification sound should be used
notifyBroadcasts
Channel notification settings
notifyChats
Notifications generated by all groups.
notifyForumTopic
Notifications generated by a topic in a forum.
notifyPeer
Notifications generated by a certain user or group.
notifyUsers
Notifications generated by all users.
null
Corresponds to an arbitrary empty object.
outboxReadDate
Exact read date of a private message we sent to another user.
pageBlockAnchor
Link to section within the page itself (like <a href="#target">anchor</a>)
pageBlockAudio
Audio
pageBlockAuthorDate
Author and date of creation of article
pageBlockBlockquoteBlocks
pageBlockBlockquote
Quote (equivalent to the HTML <blockquote>)
pageBlockChannel
Reference to a telegram channel
pageBlockCollage
Collage of media
pageBlockCover
A page cover
pageBlockDetails
A collapsible details block
pageBlockDivider
An empty block separating a page
pageBlockEmbedPost
An embedded post
pageBlockEmbed
An embedded webpage
pageBlockFooter
Page footer
pageBlockHeader
Page header
pageBlockHeading1
pageBlockHeading2
pageBlockHeading3
pageBlockHeading4
pageBlockHeading5
pageBlockHeading6
pageBlockKicker
Kicker
pageBlockList
Unordered list of IV blocks
pageBlockMap
A map
pageBlockMath
pageBlockOrderedList
Ordered list of IV blocks
pageBlockParagraph
A paragraph
pageBlockPhoto
A photo
pageBlockPreformatted
Preformatted (<pre> text)
pageBlockPullquote
Pullquote
pageBlockRelatedArticles
Related articles
pageBlockSlideshow
Slideshow
pageBlockSubheader
Subheader
pageBlockSubtitle
Subtitle
pageBlockTable
Table
pageBlockThinking
pageBlockTitle
Title
pageBlockUnsupported
Unsupported IV element
pageBlockVideo
Video
pageCaption
Page caption
pageListItemBlocks
List item
pageListItemText
List item
pageListOrderedItemBlocks
Ordered list of IV blocks
pageListOrderedItemText
Ordered list of text items
pageRelatedArticle
Related article
pageTableCell
Table cell
pageTableRow
Table row
page
Instant view page
paidReactionPrivacyAnonymous
Send paid reactions anonymously.
paidReactionPrivacyDefault
Uses the default reaction privacy, set using messages.togglePaidReactionPrivacy.
paidReactionPrivacyPeer
Send paid reactions as the specified peer, fetched using channels.getSendAs with the for_paid_reactions flag set.
passkey
Human-readable info about a passkey associated to an account, returned when creating a passkey » or listing passkeys ».
passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow
This key derivation algorithm defines that SRP 2FA login must be used
passwordKdfAlgoUnknown
Unknown KDF (most likely, the client is outdated and does not support the specified KDF algorithm)
paymentCharge
Payment identifier
paymentFormMethod
Represents an additional payment method
paymentRequestedInfo
Order info provided by the user
paymentSavedCredentialsCard
Saved credit card
peerBlocked
Information about a blocked peer
peerChannel
Channel/supergroup
peerChat
Group.
peerColorCollectible
Represents a color palette » associated to a collectible gift », see here » for more info.
peerColor
Represents a color palette ».
peerLocated
Peer geolocated nearby
peerNotifySettings
Notification settings.
peerSelfLocated
Current peer
peerSettings
List of actions that are possible when interacting with this user, to be shown as suggested actions in the chat action bar », see here » for more info.
peerStories
Stories associated to a peer
peerUser
Chat partner
pendingSuggestion
Represents a custom pending suggestion ».
phoneCallAccepted
An accepted phone call, see here » for more info on the full flow.
phoneCallDiscardReasonBusy
The phone call was discarded because the user is busy in another call, see here » for more info.
phoneCallDiscardReasonDisconnect
The phone call was disconnected, see here » for more info.
phoneCallDiscardReasonHangup
The phone call was ended normally, see here » for more info.
phoneCallDiscardReasonMigrateConferenceCall
This phone call was migrated to a conference call.
phoneCallDiscardReasonMissed
The phone call was missed, see here » for more info.
phoneCallDiscarded
Indicates a discarded phone call, see here » for more info on the full flow.
phoneCallEmpty
Empty constructor
phoneCallProtocol
Protocol info for the VoIP library, see here » for details on how to populate it.
phoneCallRequested
Requested phone call, see here » for more info on the full flow.
phoneCallWaiting
Incoming phone call, see here » for more info on the full flow.
phoneCall
Phone call, see here » for more info on the full flow.
phoneConnectionWebrtc
WebRTC connection parameters for a phone call.
phoneConnection
DEPRECATED (libtgvoip): Identifies an endpoint that can be used to connect to the other user in a phone call
photoCachedSize
Description of an image and its content.
photoEmpty
Empty constructor, non-existent photo
photoPathSize
Messages with animated stickers can have a compressed svg (< 300 bytes) to show the outline of the sticker before fetching the actual lottie animation.
photoSizeEmpty
Empty constructor. Image with this thumbnail is unavailable.
photoSizeProgressive
Progressively encoded photosize
photoSize
Image description.
photoStrippedSize
A low-resolution compressed JPG payload
photo
Photo
pollAnswerVoters
A poll answer, and how users voted on it
pollAnswer
A possible answer of a poll
pollResults
Results of poll
poll
Poll
popularContact
Popular contact
postAddress
Shipping address
postInteractionCountersMessage
Interaction counters for a message.
postInteractionCountersStory
Interaction counters for a story.
premiumGiftCodeOption
Contains info about a giveaway/gift option.
premiumSubscriptionOption
Describes a Telegram Premium subscription option
prepaidGiveaway
Contains info about a prepaid giveaway ».
prepaidStarsGiveaway
Contains info about a prepaid Telegram Star giveaway ».
privacyKeyAbout
Whether people can see your bio
privacyKeyAddedByPhone
Whether this user can be added to our contact list by their phone number
privacyKeyBirthday
Whether the user can see our birthday.
privacyKeyChatInvite
Whether the user can be invited to chats
privacyKeyForwards
Whether messages forwarded from the user will be anonymously forwarded
privacyKeyNoPaidMessages
Who can send you messages without paying, if paid messages » are enabled.
privacyKeyPhoneCall
Whether the user accepts phone calls
privacyKeyPhoneNumber
Whether the user allows us to see his phone number
privacyKeyPhoneP2P
Whether P2P connections in phone calls with this user are allowed
privacyKeyProfilePhoto
Whether the profile picture of the user is visible
privacyKeySavedMusic
Whether the user can see the songs we pinned to our profile ».
privacyKeyStarGiftsAutoSave
Whether received gifts will be automatically displayed on our profile
privacyKeyStatusTimestamp
Whether we can see the last online timestamp of this user. Note that if we decide to hide our exact last online timestamp to someone (i.e., users A, B, C, or all users) and we do not have a Premium subscription, we won't be able to see the exact last online timestamp of those users (A, B, C, or all users), even if those users do share it with us. If those users do share their exact online status with us, but we can't see it due to the reason mentioned above, the by_me flag of userStatusRecently, userStatusLastWeek, userStatusLastMonth will be set.
privacyKeyVoiceMessages
Whether the user accepts voice messages
privacyValueAllowAll
Allow all users
privacyValueAllowBots
Allow bots and mini apps
privacyValueAllowChatParticipants
Allow all participants of certain chats
privacyValueAllowCloseFriends
Allow only close friends »
privacyValueAllowContacts
Allow all contacts
privacyValueAllowPremium
Allow only users with a Premium subscription », currently only usable for inputPrivacyKeyChatInvite.
privacyValueAllowUsers
Allow only certain users
privacyValueDisallowAll
Disallow all users
privacyValueDisallowBots
Disallow bots and mini apps
privacyValueDisallowChatParticipants
Disallow only participants of certain chats
privacyValueDisallowContacts
Disallow only contacts
privacyValueDisallowUsers
Disallow only certain users
profileTabFiles
Represents the shared files tab of a profile.
profileTabGifs
Represents the gifs tab of a profile page.
profileTabGifts
Represents the gifts tab of a profile page.
profileTabLinks
Represents the shared links tab of a profile page.
profileTabMedia
Represents the media tab of a profile page.
profileTabMusic
Represents the music tab of a profile page.
profileTabPosts
Represents the stories tab of a profile page.
profileTabVoice
Represents the voice messages tab of a profile page.
publicForwardMessage
Contains info about a forward of a story as a message.
publicForwardStory
Contains info about a forward of a story as a repost by a public channel.
quickReply
A quick reply shortcut.
reactionCount
Reactions
reactionCustomEmoji
Custom emoji message reaction
reactionEmoji
Normal emoji message reaction
reactionEmpty
No reaction
reactionNotificationsFromAll
Receive notifications about reactions made by any user.
reactionNotificationsFromContacts
Receive notifications about reactions made only by our contacts.
reactionPaid
Represents a paid Telegram Star reaction ».
reactionsNotifySettings
Reaction notification settings, see here » for more info.
readParticipantDate
Contains info about when a certain participant has read a message
receivedNotifyMessage
Message ID, for which PUSH-notifications were cancelled.
recentMeUrlChatInvite
Recent t.me invite link to a chat
recentMeUrlChat
Recent t.me link to a chat
recentMeUrlStickerSet
Recent t.me stickerset installation URL
recentMeUrlUnknown
Unknown t.me url
recentMeUrlUser
Recent t.me link to a user
recentStory
replyInlineMarkup
Bot or inline keyboard
replyKeyboardForceReply
Force the user to send a reply
replyKeyboardHide
Hide sent bot keyboard
replyKeyboardMarkup
Bot keyboard
reportResultAddComment
The user should enter an additional comment for the moderators, and then messages report must be re-invoked, passing the comment to messages.report.message.
reportResultChooseOption
The user must choose one of the following options, and then messages.report must be re-invoked, passing the option's option identifier to messages.report.option.
reportResultReported
The report was sent successfully, no further actions are required.
requestPeerTypeBroadcast
Choose a channel
requestPeerTypeChat
Choose a chat or supergroup
requestPeerTypeCreateBot
requestPeerTypeUser
Choose a user.
requestedPeerChannel
Info about a channel/supergroup, shared by a user with the currently logged in bot using messages.sendBotRequestedPeer. All fields except the ID are optional, and will be populated if present on the chosen channel/supergroup, according to the parameters of the requesting inputKeyboardButtonRequestPeer.
requestedPeerChat
Info about a chat, shared by a user with the currently logged in bot using messages sendBotRequestedPeer. All fields except the ID are optional, and will be populated if present on the chosen chat, according to the parameters of the requesting inputKeyboardButtonRequestPeer.
requestedPeerUser
Info about a user, shared by a user with the currently logged in bot using messages sendBotRequestedPeer. All fields except the ID are optional, and will be populated if present on the chosen user, according to the parameters of the requesting inputKeyboardButtonRequestPeer.
requirementToContactEmpty
This user can be freely contacted.
requirementToContactPaidMessages
This user requires us to pay the specified amount of Telegram Stars to send them a message, see here » for the full flow.
requirementToContactPremium
This user requires us to buy a Premium subscription in order to contact them.
restrictionReason
Restriction reason. See here » for the full flow to use for restricted or age-gated content.
richMessage
savedDialog
Represents a saved dialog ».
savedPhoneContact
Saved contact
savedReactionTag
Info about a saved message reaction tag ».
savedStarGift
Represents a gift owned by a peer.
searchPostsFlood
Indicates if the specified global post search » requires payment.
searchResultPosition
Information about a message in a specific position
searchResultsCalendarPeriod
Information about found messages sent on a specific day, used to split the messages in messages.searchResultsCalendar constructors by days. Multiple searchResultsCalendarPeriod constructors are returned in messages searchResultsCalendar, each containing information about the first, last and total number of messages matching the filter that were sent on a specific day.
secureCredentialsEncrypted
Encrypted credentials required to decrypt telegram passport data.
secureData
Secure passport data, for more info see the passport docs »
secureFileEmpty
Empty constructor
secureFile
Secure passport file, for more info see the passport docs »
securePasswordKdfAlgoPBKDF2HMACSHA512iter100000
PBKDF2 with SHA512 and 100000 iterations KDF algo
securePasswordKdfAlgoSHA512
SHA512 KDF algo
securePasswordKdfAlgoUnknown
Unknown KDF algo (most likely the client has to be updated)
securePlainEmail
Email address to use in telegram passport: it must be verified, first ».
securePlainPhone
Phone number to use in telegram passport: it must be verified, first ».
secureRequiredTypeOneOf
One of
secureRequiredType
Required type
secureSecretSettings
Secure settings
secureValueErrorData
Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
secureValueErrorFile
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
secureValueErrorFiles
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
secureValueErrorFrontSide
Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
secureValueErrorReverseSide
Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
secureValueErrorSelfie
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
secureValueErrorTranslationFile
Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
secureValueErrorTranslationFiles
Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes.
secureValueError
Secure value error
secureValueHash
Secure value hash
secureValueTypeAddress
Address
secureValueTypeBankStatement
Bank statement
secureValueTypeDriverLicense
Driver's license
secureValueTypeEmail
secureValueTypeIdentityCard
Identity card
secureValueTypeInternalPassport
Internal passport
secureValueTypePassportRegistration
Internal registration passport
secureValueTypePassport
Passport
secureValueTypePersonalDetails
Personal details
secureValueTypePhone
Phone
secureValueTypeRentalAgreement
Rental agreement
secureValueTypeTemporaryRegistration
Temporary registration
secureValueTypeUtilityBill
Utility bill
secureValue
Secure value
sendAsPeer
Indicates a peer that can be used to send messages
sendMessageCancelAction
Invalidate all previous action updates. E.g. when user deletes entered text or aborts a video upload.
sendMessageChooseContactAction
User is selecting a contact to share.
sendMessageChooseStickerAction
User is choosing a sticker
sendMessageEmojiInteractionSeen
User is watching an animated emoji reaction triggered by another user, click here for more info ».
sendMessageEmojiInteraction
User has clicked on an animated emoji triggering a reaction, click here for more info ».
sendMessageGamePlayAction
User is playing a game
sendMessageGeoLocationAction
User is selecting a location to share.
sendMessageHistoryImportAction
Chat history is being imported
sendMessageRecordAudioAction
User is recording a voice message.
sendMessageRecordRoundAction
User is recording a round video to share
sendMessageRecordVideoAction
User is recording a video.
sendMessageRichMessageDraftAction
sendMessageTextDraftAction
Used by bots to implement live message streaming ».
sendMessageTypingAction
User is typing.
sendMessageUploadAudioAction
User is uploading a voice message.
sendMessageUploadDocumentAction
User is uploading a file.
sendMessageUploadPhotoAction
User is uploading a photo.
sendMessageUploadRoundAction
User is uploading a round video
sendMessageUploadVideoAction
User is uploading a video.
shippingOption
Shipping option
smsJob
Info about an SMS job.
speakingInGroupCallAction
User is currently speaking in the group call
sponsoredMessageReportOption
A report option for a sponsored message ».
sponsoredMessage
A sponsored message.
sponsoredPeer
A sponsored peer.
starGiftActiveAuctionState
Contains info about an auction where the user has placed a bid ».
starGiftAttributeBackdrop
The backdrop of a collectible gift ».
starGiftAttributeCounter
Indicates the total number of gifts that have the specified attribute.
starGiftAttributeIdBackdrop
The ID of a backdrop of a collectible gift ».
starGiftAttributeIdModel
The ID of a model of a collectible gift ».
starGiftAttributeIdPattern
The ID of a pattern of a collectible gift ».
starGiftAttributeModel
The model of a collectible gift ».
starGiftAttributeOriginalDetails
Info about the sender, receiver and message attached to the original gift », before it was upgraded to a collectible gift ».
starGiftAttributePattern
A sticker applied on the backdrop of a collectible gift » using a repeating pattern.
starGiftAttributeRarityEpic
Represents epic collectible gift attribute rarity.
starGiftAttributeRarityLegendary
Represents legendary collectible gift attribute rarity.
starGiftAttributeRarityRare
Represents rare collectible gift attribute rarity.
starGiftAttributeRarityUncommon
Represents uncommon collectible gift attribute rarity.
starGiftAttributeRarity
Exact rarity value for a collectible gift attribute.
starGiftAuctionAcquiredGift
Describes a gift that the current user won in an auction.
starGiftAuctionRoundExtendable
Describes one or more extendable collectible gift auction rounds ».
starGiftAuctionRound
Describes one or more collectible gift auction rounds ».
starGiftAuctionStateFinished
Represents a finished auction ».
starGiftAuctionStateNotModified
Returned only by auction methods (never by updates) if the passed version is equal to the remote auction ».version, meaning auction information hasn't changed over the locally cached version.
starGiftAuctionState
Represents an active or pending auction ».
starGiftAuctionUserState
Contains information about the current user's state in an auction ». The bid_amount, bid_date, bid_peer and min_bid_amount flags of starGiftAuctionUserState will all be set if the user placed a bid in the auction.
starGiftBackground
Contains the default background palette of a gift type ».
starGiftCollection
Represents a star gift collection ».
starGiftUnique
Represents a collectible star gift, see here » for more info. The sticker that represents the gift is contained in a starGiftAttributeModel object in attributes.
starGiftUpgradePrice
Indicates the price for a gift upgrade » starting from a specific point in time.
starGift
Represents a star gift, see here » for more info.
starRefProgram
Info about an affiliate program offered by a bot
starsAmount
Describes a real (i.e. possibly decimal) amount of Telegram Stars.
starsGiftOption
Telegram Stars gift option.
starsGiveawayOption
Contains info about a Telegram Star giveaway option.
starsGiveawayWinnersOption
Allowed options for the number of giveaway winners.
starsRating
Represents the profile's star rating, see here » for more info.
starsRevenueStatus
Describes Telegram Star revenue balances ».
starsSubscriptionPricing
Pricing of a Telegram Star subscription ».
starsSubscription
Represents a Telegram Star subscription ».
starsTonAmount
Describes an amount of toncoin in nanotons (i.e. 1/1_000_000_000 of a toncoin).
starsTopupOption
Telegram Stars topup option.
starsTransactionPeerAPI
Describes a Telegram Star transaction used to pay for paid API usage, such as paid bot broadcasts.
starsTransactionPeerAds
Describes a Telegram Star transaction used to pay for Telegram ads as specified here ».
starsTransactionPeerAppStore
Describes a Telegram Star transaction with the App Store, used when purchasing Telegram Stars through the App Store.
starsTransactionPeerFragment
Describes a Telegram Star transaction with Fragment, used when purchasing Telegram Stars through Fragment.
starsTransactionPeerPlayMarket
Describes a Telegram Star transaction with the Play Store, used when purchasing Telegram Stars through the Play Store.
starsTransactionPeerPremiumBot
Describes a Telegram Star transaction made using @PremiumBot (i.e. using the inputInvoiceStars flow described here »).
starsTransactionPeerUnsupported
Describes a Telegram Star transaction that cannot be described using the current layer.
starsTransactionPeer
Describes a Telegram Star transaction with another peer.
starsTransaction
Represents a Telegram Stars or TON transaction ».
statsAbsValueAndPrev
Statistics value couple; initial and final value for period of time currently in consideration
statsDateRangeDays
Channel statistics date range
statsGraphAsync
This channel statistics graph must be generated asynchronously using stats loadAsyncGraph to reduce server load
statsGraphError
An error occurred while generating the statistics graph
statsGraph
Channel statistics graph
statsGroupTopAdmin
Information about an active admin in a supergroup
statsGroupTopInviter
Information about an active supergroup inviter
statsGroupTopPoster
Information about an active user in a supergroup
statsPercentValue
Channel statistics percentage. Compute the percentage simply by doing part * total / 100
statsURL
URL with chat statistics
stickerKeyword
Keywords for a certain sticker
stickerPack
A stickerpack is a group of stickers associated to the same emoji. It is not a sticker pack the way it is usually intended, you may be looking for a StickerSet.
stickerSetCovered
Stickerset with a single sticker as preview
stickerSetFullCovered
Stickerset preview with all stickers of the stickerset included. Currently used only for custom emoji stickersets, to avoid a further call to messages.getStickerSet.
stickerSetMultiCovered
Stickerset, with multiple stickers as preview
stickerSetNoCovered
Just the stickerset information, with no previews.
stickerSet
Represents a stickerset (stickerpack)
storiesStealthMode
Information about the current stealth mode session.
storyAlbum
Represents a story album ».
storyFwdHeader
Contains info about the original poster of a reposted story.
storyItemDeleted
Represents a previously active story, that was deleted
storyItemSkipped
Represents an active story, whose full information was omitted for space and performance reasons; use stories.getStoriesByID to fetch full info about the skipped story when and if needed.
storyItem
Represents a story.
storyReactionPublicForward
A certain peer has forwarded the story as a message to a public chat or channel.
storyReactionPublicRepost
A certain peer has reposted the story.
storyReaction
How a certain peer reacted to a story
storyViewPublicForward
A certain peer has forwarded the story as a message to a public chat or channel.
storyViewPublicRepost
A certain peer has reposted the story.
storyView
Story view date and reaction information
storyViews
Aggregated view and reaction information of a story.
string
suggestedPost
Contains info about a suggested post ».
textAnchor
Text linking to another section of the page
textAutoEmail
textAutoPhone
textAutoUrl
textBankCard
textBold
Bold text
textBotCommand
textCashtag
textConcat
Concatenation of rich texts
textCustomEmoji
textDate
textEmail
Rich text email link
textEmpty
Empty rich text element
textFixed
fixed-width rich text
textHashtag
textImage
Inline image
textItalic
Italic text
textMarked
Highlighted text
textMath
textMentionName
textMention
textPhone
Rich text linked to a phone number
textPlain
Plain text
textSpoiler
textStrike
Strikethrough text
textSubscript
Subscript text
textSuperscript
Superscript text
textUnderline
Underlined text
textUrl
Link
textWithEntities
Styled text with message entities
themeSettings
Theme settings
theme
Theme
timezone
Timezone information.
todoCompletion
A completed todo list » item.
todoItem
An item of a todo list ».
todoList
Represents a todo list ».
topPeerCategoryBotsApp
Most frequently used Main Mini Bot Apps.
topPeerCategoryBotsGuestChat
topPeerCategoryBotsInline
Most used inline bots
topPeerCategoryBotsPM
Most used bots
topPeerCategoryChannels
Most frequently visited channels
topPeerCategoryCorrespondents
Users we've chatted most frequently with
topPeerCategoryForwardChats
Chats to which the users often forwards messages to
topPeerCategoryForwardUsers
Users to which the users often forwards messages to
topPeerCategoryGroups
Often-opened groups and supergroups
topPeerCategoryPeers
Top peer category
topPeerCategoryPhoneCalls
Most frequently called users
topPeer
Top peer
true
See predefined identifiers.
updateAiComposeTones
updateAttachMenuBots
The list of installed attachment menu entries » has changed, use messages getAttachMenuBots to fetch the updated list.
updateAutoSaveSettings
Media autosave settings have changed and must be refetched using account getAutoSaveSettings.
updateBotBusinessConnect
Connecting or disconnecting a business bot or changing the connection settings will emit an updateBotBusinessConnect update to the bot, with the new settings and a connection_id that will be used by the bot to handle updates from and send messages as the user.
updateBotCallbackQuery
A callback button was pressed, and the button data was sent to the bot that created the button
updateBotChatBoost
A channel/supergroup boost has changed (bots only)
updateBotChatInviteRequester
Someone has requested to join a chat or channel (bots only, users will receive an updatePendingJoinRequests, instead)
updateBotCommands
The command set of a certain bot in a certain chat has changed.
updateBotDeleteBusinessMessage
A message was deleted in a connected business chat ».
updateBotEditBusinessMessage
A message was edited in a connected business chat ».
updateBotGuestChatQuery
updateBotInlineQuery
An incoming inline query
updateBotInlineSend
The result of an inline query that was chosen by a user and sent to their chat partner Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.
updateBotMenuButton
The menu button behavior for the specified bot has changed
updateBotMessageReaction
Bots only: a user has changed their reactions on a message with public reactions.
updateBotMessageReactions
Bots only: the number of reactions on a message with anonymous reactions has changed.
updateBotNewBusinessMessage
A message was received via a connected business chat ».
updateBotPrecheckoutQuery
This object contains information about an incoming pre-checkout query.
updateBotPurchasedPaidMedia
Bots only: a user has purchased a paid media.
updateBotShippingQuery
This object contains information about an incoming shipping query.
updateBotStopped
A bot was stopped or re-started.
updateBotWebhookJSONQuery
A new incoming query; for bots only
updateBotWebhookJSON
A new incoming event; for bots only
updateBusinessBotCallbackQuery
A callback button sent via a business connection was pressed, and the button data was sent to the bot that created the button.
updateChannelAvailableMessages
The history of a channel/supergroup was hidden.
updateChannelMessageForwards
The forward counter of a message in a channel has changed
updateChannelMessageViews
The view counter of a message in a channel has changed
updateChannelParticipant
A participant has left, joined, was banned or admined in a channel or supergroup.
updateChannelReadMessagesContents
The specified channel/supergroup messages were read (emitted specifically for messages like voice messages or video, only once the media is watched and marked as read using channels.readMessageContents)
updateChannelTooLong
There are new updates in the specified channel, the client must fetch them manually by invoking updates.getChannelDifference as specified in the documentation ». If the channel's PTS isn't currently stored in the database (i.e. we joined this channel on another client while the current client was offline), start fetching from the specified pts. Does not necessarily indicate the channel message box size limit was reached, it simply indicates that the number of queued updates in a message box is too large to be delivered passively through the socket.
updateChannelUserTyping
A user is typing in a supergroup, channel or message thread
updateChannelViewForumAsMessages
Users may also choose to display messages from all topics as if they were sent to a normal group, using a "View as messages" setting in the local client. This setting only affects the current account, and is synced to other logged in sessions using the channels.toggleViewForumAsMessages method; invoking this method will update the value of the view_forum_as_messages flag of channelFull or dialog and emit an updateChannelViewForumAsMessages.
updateChannelWebPage
A webpage preview of a link in a channel/supergroup message was generated
updateChannel
Channel/supergroup (channel and/or channelFull) information was updated. This update can only be received through getDifference or in updates/updatesCombined constructors, so it will always come bundled with the updated channel, that should be applied as usual », without re-fetching the info manually. However, full peer information will not come bundled in updates, so the full peer cache (channelFull) must be invalidated for channel_id when receiving this update.
updateChatDefaultBannedRights
Default banned rights in a basic group were updated
updateChatParticipantAdd
New group member.
updateChatParticipantAdmin
Admin permissions of a user in a basic group were changed
updateChatParticipantDelete
A member has left the basic group.
updateChatParticipantRank
The tag » of a participant of a basic group » has changed.
updateChatParticipant
A user has joined or left a specific basic group »
updateChatParticipants
The participants of a basic group » changed.
updateChatUserTyping
The user is preparing a message in a group; typing, recording, uploading, etc. This update is valid for 6 seconds. If no further updates of this kind are received after 6 seconds, it should be considered that the user stopped doing whatever they were doing
updateChat
Chat (chat and/or chatFull) information was updated. This update can only be received through getDifference or in updates/updatesCombined constructors, so it will always come bundled with the updated chat, that should be applied as usual », without re-fetching the info manually. However, full peer information will not come bundled in updates, so the full peer cache (chatFull) must be invalidated for chat_id when receiving this update.
updateConfig
The server-side configuration has changed; the client should re-fetch the config using help.getConfig and help.getAppConfig.
updateContactsReset
All contacts were deleted
updateDcOptions
Changes in the data center configuration options.
updateDeleteChannelMessages
Some messages in a supergroup/channel were deleted
updateDeleteGroupCallMessages
updateDeleteMessages
Messages were deleted.
updateDeleteQuickReplyMessages
One or more messages in a quick reply shortcut » were deleted.
updateDeleteQuickReply
A quick reply shortcut » was deleted. This will not emit updateDeleteQuickReplyMessages updates, even if all the messages in the shortcut are also deleted by this update.
updateDeleteScheduledMessages
Some scheduled messages were deleted (or sent) from the schedule queue of a chat
updateDialogFilterOrder
New folder order
updateDialogFilter
A new folder was added
updateDialogFilters
Clients should update folder info
updateDialogPinned
A dialog was pinned/unpinned
updateDialogUnreadMark
The manual unread mark of a chat was changed
updateDraftMessage
Notifies a change of a message draft.
updateEditChannelMessage
A message was edited in a channel/supergroup
updateEditMessage
A message was edited
updateEmojiGameInfo
updateEncryptedChatTyping
Interlocutor is typing a message in an encrypted chat. Update period is 6 second. If upon this time there is no repeated update, it shall be considered that the interlocutor stopped typing.
updateEncryptedMessagesRead
Communication history in an encrypted chat was marked as read.
updateEncryption
Change of state in an encrypted chat.
updateFavedStickers
The list of favorited stickers was changed, the client should call messages getFavedStickers to refetch the new list
updateFolderPeers
The peer list of a peer folder was updated
updateGeoLiveViewed
Live geoposition message was viewed
updateGroupCallChainBlocks
Contains updates to the blockchain of a conference call, see here » for more info.
updateGroupCallConnection
New WebRTC connection parameters for the currently joined group call.
updateGroupCallEncryptedMessage
A new E2E-encrypted message was received in a conference call, sent using phone sendGroupCallEncryptedMessage.
updateGroupCallMessage
A new in-call message was received in a group call or livestream, sent using phone sendGroupCallMessage.
updateGroupCallParticipants
The participant list of a group call has changed.
updateGroupCall
Info about a group call was updated.
updateInlineBotCallbackQuery
This notification is received by bots when a button is pressed
updateJoinChatWebViewDecision
updateLangPackTooLong
A language pack has changed, the client should manually fetch the changed strings using langpack.getDifference
updateLangPack
Language pack updated
updateLoginToken
A login token (for login via QR code) was accepted.
updateManagedBot
updateMessageExtendedMedia
You bought a paid media »: this update contains the revealed media.
updateMessageID
Sent message with random_id client identifier was assigned an identifier.
updateMessagePollVote
A specific peer has voted in a poll
updateMessagePoll
The results of a poll have changed
updateMessageReactions
New message reactions » are available
updateMonoForumNoPaidException
An admin has (un)exempted this monoforum topic » from payment to send messages using account.toggleNoPaidMessagesException.
updateMoveStickerSetToTop
A stickerset was just moved to top, see here for more info »
updateNewAuthorization
A new session logged into the current user's account through an unknown device.
updateNewBotConnection
updateNewChannelMessage
A new message was sent in a channel/supergroup
updateNewEncryptedMessage
New encrypted message.
updateNewMessage
New message in a private chat or in a basic group.
updateNewQuickReply
A new quick reply shortcut » was created.
updateNewScheduledMessage
A message was added to the schedule queue of a chat
updateNewStickerSet
A new stickerset was installed
updateNewStoryReaction
Represents a new reaction to a story.
updateNotifySettings
Changes in notification settings.
updatePaidReactionPrivacy
Contains the current default paid reaction privacy, see here » for more info. Clients should invoke messages.getPaidReactionPrivacy on startup to fetch the current default reaction privacy because this update is only sent to currently online sessions and cannot be fetched using getDifference on client startup.
updatePeerBlocked
We blocked a peer, see here » for more info on blocklists.
updatePeerHistoryTTL
The Time-To-Live for messages sent by the current user in a specific chat has changed
updatePeerLocated
List of peers near you was updated
updatePeerSettings
Settings of a certain peer have changed
updatePeerWallpaper
The wallpaper » of a given peer has changed.
updatePendingJoinRequests
Someone has requested to join a chat or channel
updatePhoneCallSignalingData
Incoming phone call signaling payload
updatePhoneCall
An incoming phone call
updatePinnedChannelMessages
Messages were pinned/unpinned in a channel/supergroup
updatePinnedDialogs
Pinned dialogs were updated
updatePinnedForumTopic
A forum topic » was pinned or unpinned.
updatePinnedForumTopics
The pinned topics of a forum have changed.
updatePinnedMessages
Some messages were pinned in a chat
updatePinnedSavedDialogs
Pinned saved dialogs » were updated
updatePrivacy
Privacy rules were changed
updatePtsChanged
Common message box sequence PTS has changed, state has to be refetched using updates getState
updateQuickReplies
Info about or the order of quick reply shortcuts » was changed.
updateQuickReplyMessage
A new message was added to a quick reply shortcut ».
updateReadChannelDiscussionInbox
Incoming comments in a discussion thread were marked as read
updateReadChannelDiscussionOutbox
Outgoing comments in a discussion thread were marked as read
updateReadChannelInbox
Incoming messages in a channel/supergroup were read
updateReadChannelOutbox
Outgoing messages in a channel/supergroup were read
updateReadFeaturedEmojiStickers
Some featured custom emoji stickers were marked as read
updateReadFeaturedStickers
Some featured stickers were marked as read
updateReadHistoryInbox
Incoming messages were read
updateReadHistoryOutbox
Outgoing messages were read
updateReadMessagesContents
Contents of messages in the common message box were read (emitted specifically for messages like voice messages or video, only once the media is watched and marked as read using messages.readMessageContents).
updateReadMonoForumInbox
Incoming messages in a monoforum topic were read
updateReadMonoForumOutbox
Outgoing messages in a monoforum were read.
updateReadStories
Stories of a specific peer were marked as read.
updateRecentEmojiStatuses
The list of recent emoji statuses has changed
updateRecentReactions
The list of recent message reactions has changed
updateRecentStickers
The recent sticker list was updated
updateSavedDialogPinned
A saved message dialog was pinned/unpinned
updateSavedGifs
The saved gif list has changed, the client should refetch it using messages getSavedGifs
updateSavedReactionTags
The list of reaction tag » names assigned by the user has changed and should be refetched using messages.getSavedReactionTags ».
updateSavedRingtones
The list of saved notification sounds has changed, use account.getSavedRingtones to fetch the new list.
updateSentPhoneCode
A paid login SMS code was successfully sent.
updateSentStoryReaction
Indicates we reacted to a story ».
updateServiceNotification
A service message for the user. The app must show the message to the user upon receiving this update. In case the popup parameter was passed, the text message must be displayed in a popup alert immediately upon receipt. It is recommended to handle the text as you would an ordinary message in terms of highlighting links, etc. The message must also be stored locally as part of the message history with the user id 777000 (Telegram Notifications).
updateShortChatMessage
Shortened constructor containing info on one new incoming text message from a chat
updateShortMessage
Info about a message sent to (received from) another user
updateShortSentMessage
Shortened constructor containing info on one outgoing message to a contact (the destination chat has to be extracted from the method call that returned this object).
updateShort
Shortened constructor containing info on one update not requiring auxiliary data
updateSmsJob
A new SMS job was received
updateStarGiftAuctionState
Contains updates to auction state, see here » for more info on how to enable these updates.
updateStarGiftAuctionUserState
Contains updates to auction state related to the current user, see here » for more info on how to enable these updates.
updateStarGiftCraftFail
Indicates that a crafting » attempt did not produce a new collectible gift.
updateStarsBalance
The current account's Telegram Stars balance » has changed.
updateStarsRevenueStatus
The Telegram Star balance of a channel/bot we own has changed ».
updateStickerSetsOrder
The order of stickersets was changed
updateStickerSets
Installed stickersets have changed, the client should refetch them as described in the docs.
updateStoriesStealthMode
Indicates that stories stealth mode was activated.
updateStoryID
A story was successfully uploaded. Once a story is successfully uploaded, an updateStoryID will be returned, indicating the story ID (id) that was attributed to the story (like for messages, random_id indicates the random_id that was passed to stories.sendStory: this way, you can tell which story was assigned a specific id by checking which stories.sendStory call has the returned random_id).
updateStory
A new story was posted.
updateTheme
A cloud theme was updated
updateTranscribedAudio
A pending voice message transcription » initiated with messages.transcribeAudio was updated.
updateUserEmojiStatus
The emoji status of a certain user has changed
updateUserName
Changes the user's first name, last name and username.
updateUserPhone
A user's phone number was changed
updateUserStatus
Contact status update.
updateUserTyping
The user is preparing a message; typing, recording, uploading, etc. This update is valid for 6 seconds. If no further updates of this kind are received after 6 seconds, it should be considered that the user stopped doing whatever they were doing
updateUser
User (user and/or userFull) information was updated. This update can only be received through getDifference or in updates/updatesCombined constructors, so it will always come bundled with the updated user, that should be applied as usual », without re-fetching the info manually. However, full peer information will not come bundled in updates, so the full peer cache (userFull) must be invalidated for user_id when receiving this update.
updateWebBrowserException
updateWebBrowserSettings
updateWebPage
An instant view webpage preview was generated
updateWebViewResultSent
Indicates to a bot that a webview was closed and an inline message was sent on behalf of the user using messages.sendWebViewResultMessage
updatesCombined
Constructor for a group of updates.
updatesTooLong
The number of queued updates in the common message box is too large to be delivered passively through the socket, invoke updates.getDifference to fetch the difference as specified in the documentation ». Does not necessarily indicate the message box size limit was reached, it simply indicates that the number of queued updates in a message box is too large to be delivered passively through the socket.
updates
urlAuthResultAccepted
Details about an accepted authorization request, for more info click here »
urlAuthResultDefault
Details about an accepted authorization request, for more info click here »
userEmpty
Empty constructor, non-existent user.
userFull
Extended user info When updating the local peer database », all fields from the newly received constructor take priority over the old constructor cached locally (including by removing fields that aren't set in the new constructor).
userProfilePhotoEmpty
Profile photo has not been set, or was hidden.
userProfilePhoto
User profile photo.
userStatusEmpty
User status has not been set yet.
userStatusLastMonth
Online status: last seen last month
userStatusLastWeek
Online status: last seen last week
userStatusOffline
The user's offline status.
userStatusOnline
Online status of the user.
userStatusRecently
Online status: last seen recently
user
Indicates info about a certain user. Unless specified otherwise, when updating the local peer database, all fields from the newly received constructor take priority over the old constructor cached locally (including by removing fields that aren't set in the new constructor). See here » for an implementation of the logic to use when updating the local user peer database.
username
Contains information about a username.
videoSizeEmojiMarkup
An animated profile picture based on a custom emoji sticker.
videoSizeStickerMarkup
An animated profile picture based on a sticker.
videoSize
An animated profile picture in MPEG4 format
wallPaperNoFile
Represents a wallpaper only based on colors/gradients.
wallPaperSettings
Wallpaper rendering information.
wallPaper
Represents a wallpaper based on an image.
webAuthorization
Represents a bot logged in using the Telegram login widget
webDocumentNoProxy
Remote document that can be downloaded without proxying through telegram
webDocument
Remote document
webDomainException
webPageAttributeAiComposeTone
webPageAttributeStarGiftAuction
Contains info about a collectible gift auction » for a webPage preview of an auction » (the webPage will have a type of telegram_auction).
webPageAttributeStarGiftCollection
Contains info about a gift collection » for a webPage preview of a gift collection » (the webPage will have a type of telegram_collection).
webPageAttributeStickerSet
Contains info about a stickerset », for a webPage preview of a stickerset deep link » (the webPage will have a type of telegram_stickerset).
webPageAttributeStory
Webpage preview of a Telegram story
webPageAttributeTheme
Page theme
webPageAttributeUniqueStarGift
Contains info about collectible gift » for a webPage preview of a collectible gift » (the webPage will have a type of telegram_nft).
webPageEmpty
No preview is available for the webpage
webPageNotModified
The preview of the webpage hasn't changed
webPagePending
A preview of the webpage is currently being generated
webPage
Webpage preview
webViewMessageSent
Info about a sent inline webview message
webViewResultUrl
Contains the webview URL with appropriate theme and user info parameters added