Types¶
A B C D E F G H I J K L M N O P Q R S T U V W
A¶
AccentColor— Contains information about supported accent color for user/chat name, background of empty chat photo, replies to mess...AcceptedGiftTypes— Describes gift types that are accepted by a userAccountInfo— Contains basic information about another user who started a chat with the current userAccountTtl— Contains information about the period of inactivity after which the current user's account will automatically be deletedActiveStoryStateLive— The chat has an active live storyActiveStoryStateRead— The chat has active stories, all of which were readActiveStoryStateUnread— The chat has some unread active storiesAddedProxies— Represents a list of added proxy serversAddedProxy— Contains information about a proxy server added to the list of proxiesAddedReaction— Represents a reaction applied to a messageAddedReactions— Represents a list of reactions added to a messageAddress— Describes an addressAdvertisementSponsor— Information about the sponsor of an advertisementAffiliateInfo— Contains information about an affiliate that received commission from a Telegram Star transactionAffiliateProgramInfo— Contains information about an active affiliate programAffiliateProgramParameters— Describes parameters of an affiliate programAffiliateProgramSortOrderCreationDate— The affiliate programs must be sorted by creation dateAffiliateProgramSortOrderProfitability— The affiliate programs must be sorted by the profitabilityAffiliateProgramSortOrderRevenue— The affiliate programs must be sorted by the expected revenueAffiliateTypeBot— The affiliate is a bot owned by the current userAffiliateTypeChannel— The affiliate is a channel chat where the current user has can_post_messages administrator rightAffiliateTypeCurrentUser— The affiliate is the current userAgeVerificationParameters— Describes parameters for age verification of the current userAlternativeVideo— Describes an alternative re-encoded quality of a video fileAnimatedChatPhoto— Animated variant of a chat photo in MPEG4 formatAnimatedEmoji— Describes an animated or custom representation of an emojiAnimation— Describes an animation file. The animation must be encoded in GIF or MPEG4 formatAnimations— Represents a list of animationsArchiveChatListSettings— Contains settings for automatic moving of chats to and from the Archive chat listsAttachmentMenuBot— Represents a bot, which can be added to attachment or side menuAttachmentMenuBotColor— Describes a color to highlight a bot added to attachment menuAttributeCraftPersistenceProbability— Describes chance of the crafted gift to have the backdrop or symbol of one of the original giftsAuctionBid— Describes a bid in an auctionAuctionRound— Describes a round of an auctionAuctionStateActive— Contains information about an ongoing or scheduled auctionAuctionStateFinished— Contains information about a finished auctionAudio— Describes an audio file. Audio is usually in MP3 or M4A formatAudios— Contains a list of audio filesAuthenticationCodeInfo— Information about the authentication code that was sentAuthenticationCodeTypeCall— A digit-only authentication code is delivered via a phone call to the specified phone numberAuthenticationCodeTypeFirebaseAndroid— A digit-only authentication code is delivered via Firebase Authentication to the official Android applicationAuthenticationCodeTypeFirebaseIos— A digit-only authentication code is delivered via Firebase Authentication to the official iOS applicationAuthenticationCodeTypeFlashCall— An authentication code is delivered by an immediately canceled call to the specified phone number. The phone number t...AuthenticationCodeTypeFragment— A digit-only authentication code is delivered to https://fragment.com. The user must be logged in there via a wallet ...AuthenticationCodeTypeMissedCall— An authentication code is delivered by an immediately canceled call to the specified phone number. The last digits of...AuthenticationCodeTypeSms— A digit-only authentication code is delivered via an SMS message to the specified phone number; non-official applicat...AuthenticationCodeTypeSmsPhrase— An authentication code is a phrase from multiple words delivered via an SMS message to the specified phone number; no...AuthenticationCodeTypeSmsWord— An authentication code is a word delivered via an SMS message to the specified phone number; non-official application...AuthenticationCodeTypeTelegramMessage— A digit-only authentication code is delivered via a private Telegram message, which can be viewed from another active...AuthorizationStateClosed— TDLib client is in its final state. All databases are closed and all resources are released. No other updates will be...AuthorizationStateClosing— TDLib is closing, all subsequent queries will be answered with the error 500. Note that closing TDLib can take a whil...AuthorizationStateLoggingOut— The user is currently logging outAuthorizationStateReady— The user has been successfully authorized. TDLib is now ready to answer general requestsAuthorizationStateWaitCode— TDLib needs the user's authentication code to authorize. Call checkAuthenticationCode to check the codeAuthorizationStateWaitEmailAddress— TDLib needs the user's email address to authorize. Call setAuthenticationEmailAddress to provide the email address, o...AuthorizationStateWaitEmailCode— TDLib needs the user's authentication code sent to an email address to authorize. Call checkAuthenticationEmailCode t...AuthorizationStateWaitOtherDeviceConfirmation— The user needs to confirm authorization on another logged in device by scanning a QR code with the provided linkAuthorizationStateWaitPassword— The user has been authorized, but needs to enter a 2-step verification password to start using the application. Call ...AuthorizationStateWaitPhoneNumber— TDLib needs the user's phone number to authorize. Call setAuthenticationPhoneNumber to provide the phone number, or u...AuthorizationStateWaitPremiumPurchase— The user must buy Telegram Premium as an in-store purchase to log in. Call checkAuthenticationPremiumPurchase and the...AuthorizationStateWaitRegistration— The user is unregistered and needs to accept terms of service and enter their first name and last name to finish regi...AuthorizationStateWaitTdlibParameters— Initialization parameters are needed. Call setTdlibParameters to provide themAutoDownloadSettings— Contains auto-download settingsAutoDownloadSettingsPresets— Contains auto-download settings presets for the current userAutosaveSettings— Describes autosave settingsAutosaveSettingsException— Contains autosave settings for a chat, which overrides default settings for the corresponding scopeAutosaveSettingsScopeChannelChats— Autosave settings applied to all channel chats without chat-specific settingsAutosaveSettingsScopeChat— Autosave settings applied to a chatAutosaveSettingsScopeGroupChats— Autosave settings applied to all basic group and supergroup chats without chat-specific settingsAutosaveSettingsScopePrivateChats— Autosave settings applied to all private chats without chat-specific settingsAvailableGift— Describes a gift that is available for purchaseAvailableGifts— Contains a list of gifts that can be sent to another user or channel chatAvailableReaction— Represents an available reactionAvailableReactions— Represents a list of reactions that can be added to a message
B¶
Background— Describes a chat backgroundBackgroundFillFreeformGradient— Describes a freeform gradient fill of a backgroundBackgroundFillGradient— Describes a gradient fill of a backgroundBackgroundFillSolid— Describes a solid fill of a backgroundBackgrounds— Contains a list of backgroundsBackgroundTypeChatTheme— A background from a chat theme based on an emoji; can be used only as a chat background in channelsBackgroundTypeFill— A filled backgroundBackgroundTypePattern— A PNG or TGV (gzipped subset of SVG with MIME type "application/x-tgwallpattern") pattern to be combined with the bac...BackgroundTypeWallpaper— A wallpaper in JPEG formatBankCardActionOpenUrl— Describes an action associated with a bank card numberBankCardInfo— Information about a bank cardBasicGroup— Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users)BasicGroupFullInfo— Contains full information about a basic groupBirthdate— Represents a birthdate of a userBlockListMain— The main block list that disallows writing messages to the current user, receiving their status and photo, viewing of...BlockListStories— The block list that disallows viewing of stories of the current userBotAccessSettings— Describes users that have access to a botBotCommand— Represents a command supported by a botBotCommands— Contains a list of bot commandsBotCommandScopeAllChatAdministrators— A scope covering all group and supergroup chat administratorsBotCommandScopeAllGroupChats— A scope covering all group and supergroup chatsBotCommandScopeAllPrivateChats— A scope covering all private chatsBotCommandScopeChat— A scope covering all members of a chatBotCommandScopeChatAdministrators— A scope covering all administrators of a chatBotCommandScopeChatMember— A scope covering a member of a chatBotCommandScopeDefault— A scope covering all usersBotInfo— Contains information about a botBotMediaPreview— Describes media previews of a botBotMediaPreviewInfo— Contains a list of media previews of a bot for the given language and the list of languages for which the bot has ded...BotMediaPreviews— Contains a list of media previews of a botBotMenuButton— Describes a button to be shown instead of bot commands menu buttonBotVerification— Describes verification status provided by a botBotVerificationParameters— Describes parameters of verification that is provided by a botBotWriteAccessAllowReasonAcceptedRequest— The user accepted bot's request to send messages with allowBotToSendMessagesBotWriteAccessAllowReasonAddedToAttachmentMenu— The user added the bot to attachment or side menu using toggleBotIsAddedToAttachmentMenuBotWriteAccessAllowReasonConnectedWebsite— The user connected a website by logging in using Telegram Login Widget on itBotWriteAccessAllowReasonLaunchedWebApp— The user launched a Web App using getWebAppLinkUrlBuiltInThemeArctic— Arctic light themeBuiltInThemeClassic— Classic light themeBuiltInThemeDay— Regular light themeBuiltInThemeNight— Regular dark themeBuiltInThemeTinted— Tinted dark themeBusinessAwayMessageScheduleAlways— Send away messages alwaysBusinessAwayMessageScheduleCustom— Send away messages only in the specified time spanBusinessAwayMessageScheduleOutsideOfOpeningHours— Send away messages outside of the business opening hoursBusinessAwayMessageSettings— Describes settings for messages that are automatically sent by a Telegram Business account when it is awayBusinessBotManageBar— Contains information about a business bot that manages the chatBusinessBotRights— Describes rights of a business botBusinessChatLink— Contains information about a business chat linkBusinessChatLinkInfo— Contains information about a business chat linkBusinessChatLinks— Contains a list of business chat links created by the userBusinessConnectedBot— Describes a business bot connected to an accountBusinessConnectedBotInfo— Describes a connection of a bot to an accountBusinessConnection— Describes a connection of the bot with a business accountBusinessFeatureAccountLinks— The ability to create links to the business account with predefined message textBusinessFeatureAwayMessage— The ability to set up an away messageBusinessFeatureBots— The ability to connect a bot to the accountBusinessFeatureChatFolderTags— The ability to display folder names for each chat in the chat listBusinessFeatureEmojiStatus— The ability to show an emoji status along with the business nameBusinessFeatureGreetingMessage— The ability to set up a greeting messageBusinessFeatureLocation— The ability to set locationBusinessFeatureOpeningHours— The ability to set opening hoursBusinessFeaturePromotionAnimation— Describes a promotion animation for a Business featureBusinessFeatureQuickReplies— The ability to use quick repliesBusinessFeatures— Contains information about features, available to Business user accountsBusinessFeatureStartPage— The ability to customize start pageBusinessFeatureUpgradedStories— Allowed to use many additional features for storiesBusinessGreetingMessageSettings— Describes settings for greeting messages that are automatically sent by a Telegram Business account as response to in...BusinessInfo— Contains information about a Telegram Business accountBusinessLocation— Represents a location of a businessBusinessMessage— Describes a message from a business account as received by a botBusinessMessages— Contains a list of messages from a business account as received by a botBusinessOpeningHours— Describes opening hours of a businessBusinessOpeningHoursInterval— Describes an interval of time when the business is openBusinessRecipients— Describes private chats chosen for automatic interaction with a businessBusinessStartPage— Describes settings for a business account start pageButtonStyleDanger— The button has red colorButtonStyleDefault— The button has default styleButtonStyleLink— The button must be shown as a link. The style is allowed only for callback buttons in inlineButtonButtonStylePrimary— The button has dark blue colorButtonStyleSuccess— The button has green color
C¶
Call— Describes a callCallbackQueryAnswer— Contains a bot's answer to a callback queryCallbackQueryPayloadData— The payload for a general callback buttonCallbackQueryPayloadDataWithPassword— The payload for a callback button requiring passwordCallbackQueryPayloadGame— The payload for a game callback buttonCallDiscardReasonDeclined— The call was ended before the conversation started. It was declined by the other partyCallDiscardReasonDisconnected— The call was ended during the conversation because the users were disconnectedCallDiscardReasonEmpty— The call wasn't discarded, or the reason is unknownCallDiscardReasonHungUp— The call was ended because one of the parties hung upCallDiscardReasonMissed— The call was ended before the conversation started. It was canceled by the caller or missed by the other partyCallDiscardReasonUpgradeToGroupCall— The call was ended because it has been upgraded to a group callCallId— Contains the call identifierCallProblemDistortedSpeech— The speech was distortedCallProblemDistortedVideo— The video was distortedCallProblemDropped— The call ended unexpectedlyCallProblemEcho— The user heard their own voiceCallProblemInterruptions— The other side kept disappearingCallProblemNoise— The user heard background noiseCallProblemPixelatedVideo— The video was pixelatedCallProblemSilentLocal— The user couldn't hear the other sideCallProblemSilentRemote— The other side couldn't hear the userCallProtocol— Specifies the supported call protocolsCallServer— Describes a server for relaying call dataCallServerTypeTelegramReflector— A Telegram call reflectorCallServerTypeWebrtc— A WebRTC serverCallStateDiscarded— The call has ended successfullyCallStateError— The call has ended with an errorCallStateExchangingKeys— The call has been answered and encryption keys are being exchangedCallStateHangingUp— The call is hanging up after discardCall has been calledCallStatePending— The call is pending, waiting to be accepted by a userCallStateReady— The call is ready to useCanPostStoryResultActiveStoryLimitExceeded— The limit for the number of active stories exceeded. The user can buy Telegram Premium, delete an active story, or wa...CanPostStoryResultBoostNeeded— The chat must be boosted first by Telegram Premium subscribers to post more stories. Call getChatBoostStatus to get c...CanPostStoryResultLiveStoryIsActive— The user or the chat has an active live story. The live story must be deleted firstCanPostStoryResultMonthlyLimitExceeded— The monthly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait specified...CanPostStoryResultOk— A story can be sentCanPostStoryResultPremiumNeeded— The user must subscribe to Telegram Premium to be able to post storiesCanPostStoryResultWeeklyLimitExceeded— The weekly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait specified ...CanSendGiftResultFail— The gift can't be sent now by the current userCanSendGiftResultOk— The gift can be sent now by the current userCanSendMessageToUserResultOk— The user can be messagedCanSendMessageToUserResultUserHasPaidMessages— The user can be messaged, but the messages are paidCanSendMessageToUserResultUserIsDeleted— The user can't be messaged, because they are deleted or unknownCanSendMessageToUserResultUserRestrictsNewChats— The user can't be messaged, because they restrict new chats with non-contactsCanTransferOwnershipResultOk— The session can be usedCanTransferOwnershipResultPasswordNeeded— The 2-step verification needs to be enabled firstCanTransferOwnershipResultPasswordTooFresh— The 2-step verification was enabled recently, user needs to waitCanTransferOwnershipResultSessionTooFresh— The session was created recently, user needs to waitChat— A chat. (Can be a private chat, basic group, supergroup, or secret chat)ChatActionBarAddContact— The chat is a private or secret chat and the other user can be added to the contact list using the method addContactChatActionBarInviteMembers— The chat is a recently created group chat to which new members can be invitedChatActionBarJoinRequest— The chat is a private chat with an administrator of a chat to which the user sent join requestChatActionBarReportAddBlock— The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be blo...ChatActionBarReportSpam— The chat can be reported as spam using the method reportChat with an empty option_id and message_ids. If the chat is ...ChatActionBarSharePhoneNumber— The chat is a private or secret chat with a mutual contact and the user's phone number can be shared with the other u...ChatActionCancel— The user has canceled the previous actionChatActionChoosingContact— The user is picking a contact to sendChatActionChoosingLocation— The user is picking a location or venue to sendChatActionChoosingSticker— The user is picking a sticker to sendChatActionRecordingVideo— The user is recording a videoChatActionRecordingVideoNote— The user is recording a video noteChatActionRecordingVoiceNote— The user is recording a voice noteChatActionStartPlayingGame— The user has started to play a gameChatActionTyping— The user is typing a messageChatActionUploadingDocument— The user is uploading a documentChatActionUploadingPhoto— The user is uploading a photoChatActionUploadingVideo— The user is uploading a videoChatActionUploadingVideoNote— The user is uploading a video noteChatActionUploadingVoiceNote— The user is uploading a voice noteChatActionWatchingAnimations— The user is watching animations sent by the other party by clicking on an animated emojiChatActiveStories— Describes active stories posted by a chatChatAdministrator— Contains information about a chat administratorChatAdministratorRights— Describes rights of the administratorChatAdministrators— Represents a list of chat administratorsChatAvailableReactionsAll— All reactions are available in the chat, excluding the paid reaction and custom reactions in channel chatsChatAvailableReactionsSome— Only specific reactions are available in the chatChatBackground— Describes a background set for a specific chatChatBoost— Describes a boost applied to a chatChatBoostFeatures— Contains a list of features available on the first chat boost levelsChatBoostLevelFeatures— Contains a list of features available on a specific chat boost levelChatBoostLink— Contains an HTTPS link to boost a chatChatBoostLinkInfo— Contains information about a link to boost a chatChatBoostSlot— Describes a slot for chat boostChatBoostSlots— Contains a list of chat boost slotsChatBoostSourceGiftCode— The chat created a Telegram Premium gift code for a userChatBoostSourceGiveaway— The chat created a giveawayChatBoostSourcePremium— A user with Telegram Premium subscription or gifted Telegram Premium boosted the chatChatBoostStatus— Describes current boost status of a chatChatEvent— Represents a chat eventChatEventAccentColorChanged— The chat accent color or background custom emoji were changedChatEventActiveUsernamesChanged— The chat active usernames were changedChatEventAutomaticTranslationToggled— The has_automatic_translation setting of a channel was toggledChatEventAvailableReactionsChanged— The chat available reactions were changedChatEventBackgroundChanged— The chat background was changedChatEventCustomEmojiStickerSetChanged— The supergroup sticker set with allowed custom emoji was changedChatEventDescriptionChanged— The chat description was changedChatEventEmojiStatusChanged— The chat emoji status was changedChatEventForumTopicCreated— A new forum topic was createdChatEventForumTopicDeleted— A forum topic was deletedChatEventForumTopicEdited— A forum topic was editedChatEventForumTopicPinned— A pinned forum topic was changedChatEventForumTopicToggleIsClosed— A forum topic was closed or reopenedChatEventForumTopicToggleIsHidden— The General forum topic was hidden or unhiddenChatEventHasAggressiveAntiSpamEnabledToggled— The has_aggressive_anti_spam_enabled setting of a supergroup was toggledChatEventHasProtectedContentToggled— The has_protected_content setting of a channel was toggledChatEventInviteLinkDeleted— A revoked chat invite link was deletedChatEventInviteLinkEdited— A chat invite link was editedChatEventInviteLinkRevoked— A chat invite link was revokedChatEventInvitesToggled— The can_invite_users permission of a supergroup chat was toggledChatEventIsAllHistoryAvailableToggled— The is_all_history_available setting of a supergroup was toggledChatEventIsForumToggled— The is_forum setting of a channel was toggledChatEventLinkedChatChanged— The linked chat of a supergroup was changedChatEventLocationChanged— The supergroup location was changedChatEventLogFilters— Represents a set of filters used to obtain a chat event logChatEventMemberInvited— A new chat member was invitedChatEventMemberJoined— A new member joined the chatChatEventMemberJoinedByInviteLink— A new member joined the chat via an invite linkChatEventMemberJoinedByRequest— A new member was accepted to the chat by an administratorChatEventMemberLeft— A member left the chatChatEventMemberPromoted— A chat member has gained/lost administrator status, or the list of their administrator privileges has changedChatEventMemberRestricted— A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changedChatEventMemberSubscriptionExtended— A chat member extended their subscription to the chatChatEventMemberTagChanged— A chat member tag has been changedChatEventMessageAutoDeleteTimeChanged— The message auto-delete timer was changedChatEventMessageDeleted— A message was deletedChatEventMessageEdited— A message was editedChatEventMessagePinned— A message was pinnedChatEventMessageUnpinned— A message was unpinnedChatEventPermissionsChanged— The chat permissions were changedChatEventPhotoChanged— The chat photo was changedChatEventPollStopped— A poll in a message was stoppedChatEventProfileAccentColorChanged— The chat's profile accent color or profile background custom emoji were changedChatEvents— Contains a list of chat eventsChatEventShowMessageSenderToggled— The show_message_sender setting of a channel was toggledChatEventSignMessagesToggled— The sign_messages setting of a channel was toggledChatEventSlowModeDelayChanged— The slow_mode_delay setting of a supergroup was changedChatEventStickerSetChanged— The supergroup sticker set was changedChatEventTitleChanged— The chat title was changedChatEventUsernameChanged— The chat editable username was changedChatEventVideoChatCreated— A video chat was createdChatEventVideoChatEnded— A video chat was endedChatEventVideoChatMuteNewParticipantsToggled— The mute_new_participants setting of a video chat was toggledChatEventVideoChatParticipantIsMutedToggled— A video chat participant was muted or unmutedChatEventVideoChatParticipantVolumeLevelChanged— A video chat participant volume level was changedChatFolder— Represents a folder for user chatsChatFolderIcon— Represents an icon for a chat folderChatFolderInfo— Contains basic information about a chat folderChatFolderInviteLink— Contains a chat folder invite linkChatFolderInviteLinkInfo— Contains information about an invite link to a chat folderChatFolderInviteLinks— Represents a list of chat folder invite linksChatFolderName— Describes name of a chat folderChatInviteLink— Contains a chat invite linkChatInviteLinkCount— Describes a chat administrator with a number of active and revoked chat invite linksChatInviteLinkCounts— Contains a list of chat invite link countsChatInviteLinkInfo— Contains information about a chat invite linkChatInviteLinkMember— Describes a chat member joined a chat via an invite linkChatInviteLinkMembers— Contains a list of chat members joined a chat via an invite linkChatInviteLinks— Contains a list of chat invite linksChatInviteLinkSubscriptionInfo— Contains information about subscription plan that must be paid by the user to use a chat invite linkChatJoinRequest— Describes a user who sent a join request and waits for administrator approvalChatJoinRequestResultApproved— The request was approvedChatJoinRequestResultDeclined— The request was declinedChatJoinRequestResultQueued— The request was postponed without a decisionChatJoinRequests— Contains a list of requests to join a chatChatJoinRequestsInfo— Contains information about pending join requests for a chatChatJoinResultDeclined— The join was declined by the guard botChatJoinResultGuardBotApprovalRequired— An approval from a guard bot through a Web App is required to join the chatChatJoinResultRequestSent— The join request was sent and have to be approved by administrators of the chatChatJoinResultSuccess— The chat was joined successfullyChatListArchive— A list of chats usually located at the top of the main chat list. Unmuted chats are automatically moved from the Arch...ChatListFolder— A list of chats added to a chat folderChatListMain— A main list of chatsChatLists— Contains a list of chat listsChatLocation— Represents a location to which a chat is connectedChatMember— Describes a user or a chat as a member of another chatChatMembers— Contains a list of chat membersChatMembersFilterAdministrators— Returns the owner and administratorsChatMembersFilterBanned— Returns users banned from the chat; can be used only by administrators in a supergroup or in a channelChatMembersFilterBots— Returns bot members of the chatChatMembersFilterContacts— Returns contacts of the userChatMembersFilterMembers— Returns all chat members, including restricted chat membersChatMembersFilterMention— Returns users who can be mentioned in the chatChatMembersFilterRestricted— Returns users under certain restrictions in the chat; can be used only by administrators in a supergroupChatMemberStatusAdministrator— The user is a member of the chat and has some additional privileges. In basic groups, administrators have all applica...ChatMemberStatusBanned— The user or the chat was banned (and hence is not a member of the chat). Implies the user can't return to the chat, v...ChatMemberStatusCreator— The user is the owner of the chat and has all the administrator privilegesChatMemberStatusLeft— The user or the chat is not a chat memberChatMemberStatusMember— The user is a member of the chat, without any additional privileges or restrictionsChatMemberStatusRestricted— The user is under certain restrictions in the chat. Not supported in basic groups and channelsChatMessageSender— Represents a message sender, which can be used to send messages in a chatChatMessageSenders— Represents a list of message senders, which can be used to send messages in a chatChatNotificationSettings— Contains information about notification settings for a chat or a forum topicChatPermissions— Describes actions that a user is allowed to take in a chatChatPhoto— Describes a chat or user profile photoChatPhotoInfo— Contains basic information about the photo of a chatChatPhotos— Contains a list of chat or user profile photosChatPhotoSticker— Information about the sticker, which was used to create the chat photo. The sticker is shown at the center of the pho...ChatPhotoStickerTypeCustomEmoji— Information about the custom emoji, which was used to create the chat photoChatPhotoStickerTypeRegularOrMask— Information about the sticker, which was used to create the chat photoChatPosition— Describes a position of a chat in a chat listChatRevenueAmount— Contains information about revenue earned from sponsored messages in a chatChatRevenueStatistics— A detailed statistics about revenue earned from sponsored messages in a chatChatRevenueTransaction— Contains a chat revenue transactionsChatRevenueTransactions— Contains a list of chat revenue transactionsChatRevenueTransactionTypeFragmentRefund— Describes a refund for failed withdrawal of earnings through FragmentChatRevenueTransactionTypeFragmentWithdrawal— Describes a withdrawal of earnings through FragmentChatRevenueTransactionTypeSponsoredMessageEarnings— Describes earnings from sponsored messages in a chat in some time frameChatRevenueTransactionTypeSuggestedPostEarnings— Describes earnings from a published suggested postChatRevenueTransactionTypeUnsupported— Describes an unsupported transactionChats— Represents a list of chatsChatSourceMtprotoProxy— The chat is sponsored by the user's MTProxy serverChatSourcePublicServiceAnnouncement— The chat contains a public service announcementChatStatisticsAdministratorActionsInfo— Contains statistics about administrator actions done by a userChatStatisticsChannel— A detailed statistics about a channel chatChatStatisticsInteractionInfo— Contains statistics about interactions with a message sent in the chat or a story posted on behalf of the chatChatStatisticsInviterInfo— Contains statistics about number of new members invited by a userChatStatisticsMessageSenderInfo— Contains statistics about messages sent by a userChatStatisticsObjectTypeMessage— Describes a message sent in the chatChatStatisticsObjectTypeStory— Describes a story posted on behalf of the chatChatStatisticsSupergroup— A detailed statistics about a supergroup chatChatThemeEmoji— A chat theme based on an emojiChatThemeGift— A chat theme based on an upgraded giftChatTypeBasicGroup— A basic group (a chat with 0-200 other users)ChatTypePrivate— An ordinary chat with a userChatTypeSecret— A secret chat with a userChatTypeSupergroup— A supergroup or channel (with unlimited members)CheckChatUsernameResultOk— The username can be setCheckChatUsernameResultPublicChatsTooMany— The user has too many chats with username, one of them must be made private firstCheckChatUsernameResultPublicGroupsUnavailable— The user can't be a member of a public supergroupCheckChatUsernameResultUsernameInvalid— The username is invalidCheckChatUsernameResultUsernameOccupied— The username is occupiedCheckChatUsernameResultUsernamePurchasable— The username can be purchased at https://fragment.com. Information about the username can be received using getCollec...Checklist— Describes a checklistChecklistTask— Describes a task in a checklistCheckStickerSetNameResultNameInvalid— The name is invalidCheckStickerSetNameResultNameOccupied— The name is occupiedCheckStickerSetNameResultOk— The name can be setCloseBirthdayUser— Describes a user who had or will have a birthday soonClosedVectorPath— Represents a closed vector path. The path begins at the end point of the last command. The coordinate system origin i...CollectibleItemInfo— Contains information about a collectible item and its last purchaseCollectibleItemTypePhoneNumber— A phone numberCollectibleItemTypeUsername— A usernameCommunity— Represents a community consisting of supergroup chats, channel chats and chats with botsCommunityAdministratorRights— Describes rights of the administrator in a communityCommunityChat— Describes a chat in a communityCommunityFullInfo— Contains full information about a communityCommunityId— Contains identifier of a communityCommunityMemberStatusAdministrator— The user is a member of the community and has some additional privilegesCommunityMemberStatusBanned— The user or the chat was banned in the community; implies ban in all chats in the communityCommunityMemberStatusCreator— The user is the owner of the community and has all the administrator privilegesCommunityMemberStatusLeft— The user or the chat is not a community memberCommunityMemberStatusMember— The user is a member of the community, without any additional privileges or restrictionsCommunityPermissions— Describes actions that a user is allowed to take in a communityConnectedAffiliateProgram— Describes an affiliate program that was connected to an affiliateConnectedAffiliatePrograms— Represents a list of affiliate programs that were connected to an affiliateConnectedWebsite— Contains information about one website the current user is logged in with TelegramConnectedWebsites— Contains a list of websites the current user is logged in with TelegramConnectionStateConnecting— Establishing a connection to the Telegram serversConnectionStateConnectingToProxy— Establishing a connection with a proxy serverConnectionStateReady— There is a working connection to the Telegram serversConnectionStateUpdating— Downloading data expected to be received while the application was offlineConnectionStateWaitingForNetwork— Waiting for the network to become available. Use setNetworkType to change the available network typeContact— Describes a contact of a userCount— Contains a counterCountries— Contains information about countriesCountryInfo— Contains information about a countryCraftGiftResultFail— Crafting has failedCraftGiftResultInvalidGift— Crafting isn't possible because one of the gifts isn't suitable for craftingCraftGiftResultSuccess— Crafting was successfulCraftGiftResultTooEarly— Crafting isn't possible because one of the gifts can't be used for crafting yetCreatedBasicGroupChat— Contains information about a newly created basic group chatCurrentWeather— Describes the current weatherCustomRequestResult— Contains the result of a custom request
D¶
Data— Contains some binary dataDatabaseStatistics— Contains database statisticsDate— Represents a date according to the Gregorian calendarDatedFile— File with the date it was uploadedDateRange— Represents a date rangeDateTimeFormattingTypeAbsolute— The date and time must be shown as absolute timestampsDateTimeFormattingTypeRelative— The time must be shown relative to the current time ([in ] X seconds, minutes, hours, days, months, years [ago])DateTimePartPrecisionLong— Show the date or time in a long way (March 17, 2022 or 22:45:00)DateTimePartPrecisionNone— Don't show the date or timeDateTimePartPrecisionShort— Show the date or time in a short way (17.03.22 or 22:45)DeepLinkInfo— Contains information about a tg: deep linkDeviceTokenApplePush— A token for Apple Push Notification serviceDeviceTokenApplePushVoIP— A token for Apple Push Notification service VoIP notificationsDeviceTokenBlackBerryPush— A token for BlackBerry Push ServiceDeviceTokenFirebaseCloudMessaging— A token for Firebase Cloud MessagingDeviceTokenHuaweiPush— A token for HUAWEI Push ServiceDeviceTokenMicrosoftPush— A token for Microsoft Push Notification ServiceDeviceTokenMicrosoftPushVoIP— A token for Microsoft Push Notification Service VoIP channelDeviceTokenSimplePush— A token for Simple Push API for Firefox OSDeviceTokenTizenPush— A token for Tizen Push ServiceDeviceTokenUbuntuPush— A token for Ubuntu Push Client serviceDeviceTokenWebPush— A token for web Push APIDeviceTokenWindowsPush— A token for Windows Push Notification ServicesDiceStickersRegular— A regular animated stickerDiceStickersSlotMachine— Animated stickers to be combined into a slot machineDiffEntity— Represents a change of a textDiffEntityTypeDelete— Removal of some textDiffEntityTypeInsert— Addition of some textDiffEntityTypeReplace— Change of some textDiffText— A text with some changes highlightedDirectMessagesChatTopic— Contains information about a topic in a channel direct messages chat administered by the current userDocument— Describes a document of any typeDownloadedFileCounts— Contains number of being downloaded and recently downloaded files foundDraftMessage— Contains information about a message draftDraftMessageContentInputRichMessage— A rich message draft; only for setChatDraftMessageDraftMessageContentRichMessage— A rich message draft; not supported in setChatDraftMessageDraftMessageContentText— A text message draftDraftMessageContentVideoNote— A video note message draftDraftMessageContentVoiceNote— A voice note message draft
E¶
EmailAddressAuthenticationAppleId— An authentication token received through Apple IDEmailAddressAuthenticationCode— An authentication code delivered to a user's email addressEmailAddressAuthenticationCodeInfo— Information about the email address authentication code that was sentEmailAddressAuthenticationGoogleId— An authentication token received through Google IDEmailAddressResetStateAvailable— Email address can be reset after the given period. Call resetAuthenticationEmailAddress to reset it and allow the use...EmailAddressResetStatePending— Email address reset has already been requested. Call resetAuthenticationEmailAddress to check whether immediate reset...EmojiCategories— Represents a list of emoji categoriesEmojiCategory— Describes an emoji categoryEmojiCategorySourcePremium— The category contains premium stickers that must be found by getPremiumStickersEmojiCategorySourceSearch— The category contains a list of similar emoji to search for in getStickers and searchStickers for stickers, or getInl...EmojiCategoryTypeChatPhoto— The category must be used for chat photo emoji selectionEmojiCategoryTypeDefault— The category must be used by default (e.g., for custom emoji or animation search)EmojiCategoryTypeEmojiStatus— The category must be used for emoji status selectionEmojiCategoryTypeRegularStickers— The category must be used by default for regular sticker selection. It may contain greeting emoji category and premiu...EmojiChatTheme— Describes a chat theme based on an emojiEmojiKeyword— Represents an emoji with its keywordEmojiKeywords— Represents a list of emojis with their keywordsEmojiReaction— Contains information about an emoji reactionEmojis— Represents a list of emojisEmojiStatus— Describes an emoji to be shown instead of the Telegram Premium badgeEmojiStatusCustomEmojis— Contains a list of custom emoji identifiers for emoji statusesEmojiStatuses— Contains a list of emoji statusesEmojiStatusTypeCustomEmoji— A custom emoji set as emoji statusEmojiStatusTypeUpgradedGift— An upgraded gift set as emoji statusEncryptedCredentials— Contains encrypted Telegram Passport data credentialsEncryptedPassportElement— Contains information about an encrypted Telegram Passport element; for bots onlyEphemeralMessageContent— Describes an ephemeral content of a regular message, which must be shown instead of the regular contentError— An object of this type can be returned on every function call, in case of an error
F¶
FactCheck— Describes a fact-check added to the message by an independent checkerFailedToAddMember— Contains information about a user who has failed to be added to a chatFailedToAddMembers— Represents a list of users that has failed to be added to a chatFile— Represents a fileFileDownload— Describes a file added to file download listFileDownloadedPrefixSize— Contains size of downloaded prefix of a fileFileTypeAnimation— The file is an animationFileTypeAudio— The file is an audio fileFileTypeDocument— The file is a documentFileTypeLivePhotoVideo— The file is a video for a live photoFileTypeNone— The data is not a fileFileTypeNotificationSound— The file is a notification soundFileTypePhoto— The file is a photoFileTypePhotoStory— The file is a photo published as a storyFileTypeProfilePhoto— The file is a profile photoFileTypeSecret— The file was sent to a secret chat (the file type is not known to the server)FileTypeSecretThumbnail— The file is a thumbnail of a file from a secret chatFileTypeSecure— The file is a file from Secure storage used for storing Telegram Passport filesFileTypeSelfDestructingLivePhotoVideo— The file is a self-destructing video for a live photo in a private chatFileTypeSelfDestructingPhoto— The file is a self-destructing photo in a private chatFileTypeSelfDestructingVideo— The file is a self-destructing video in a private chatFileTypeSelfDestructingVideoNote— The file is a self-destructing video note in a private chatFileTypeSelfDestructingVoiceNote— The file is a self-destructing voice note in a private chatFileTypeSticker— The file is a stickerFileTypeThumbnail— The file is a thumbnail of another fileFileTypeUnknown— The file type is not yet knownFileTypeVideo— The file is a videoFileTypeVideoNote— The file is a video noteFileTypeVideoStory— The file is a video published as a storyFileTypeVoiceNote— The file is a voice noteFileTypeWallpaper— The file is a wallpaper or a background patternFirebaseAuthenticationSettingsAndroid— Settings for Firebase Authentication in the official Android applicationFirebaseAuthenticationSettingsIos— Settings for Firebase Authentication in the official iOS applicationFirebaseDeviceVerificationParametersPlayIntegrity— Device verification must be performed with the classic Play Integrity verification (https://developer.android.com/goo...FirebaseDeviceVerificationParametersSafetyNet— Device verification must be performed with the SafetyNet Attestation APIFixedText— A text fixed using fixTextWithAiFormattedText— A text with some entitiesForumTopic— Describes a forum topicForumTopicIcon— Describes a forum topic iconForumTopicInfo— Contains basic information about a forum topicForumTopics— Describes a list of forum topicsForwardSource— Contains information about the last message from which a new message was forwarded last timeFoundAffiliateProgram— Describes a found affiliate programFoundAffiliatePrograms— Represents a list of found affiliate programsFoundChatBoosts— Contains a list of boosts applied to a chatFoundChatMessages— Contains a list of messages found by a search in a given chatFoundFileDownloads— Contains a list of downloaded files, found by a searchFoundMessages— Contains a list of messages found by a searchFoundPosition— Contains 0-based match positionFoundPositions— Contains 0-based positions of matched objectsFoundPublicPosts— Contains a list of messages found by a public post searchFoundStories— Contains a list of stories found by a searchFoundUsers— Represents a list of found usersFoundWebApp— Contains information about a Web App found by its short name
G¶
Game— Describes a game. Use getInternalLink with internalLinkTypeGame to share the gameGameHighScore— Contains one row of the game high score tableGameHighScores— Contains a list of game high scoresGift— Describes a gift that can be sent to another user or channel chatGiftAuction— Describes an auction on which a gift can be purchasedGiftAuctionAcquiredGift— Represents a gift that was acquired by the current user on an auctionGiftAuctionAcquiredGifts— Represents a list of gifts that were acquired by the current user on an auctionGiftAuctionState— Represent auction state of a giftGiftBackground— Describes background of a giftGiftChatTheme— Describes a chat theme based on an upgraded giftGiftChatThemes— Contains a list of chat themes based on upgraded giftsGiftCollection— Describes collection of giftsGiftCollections— Contains a list of gift collectionsGiftForResale— Describes a gift available for resaleGiftForResaleOrderNumber— The gifts will be sorted by their number from the smallest to the largestGiftForResaleOrderPrice— The gifts will be sorted by their price from the lowest to the highestGiftForResaleOrderPriceChangeDate— The gifts will be sorted by the last date when their price was changed from the newest to the oldestGiftPurchaseLimits— Describes the maximum number of times that a specific gift can be purchasedGiftPurchaseOfferStateAccepted— The offer was acceptedGiftPurchaseOfferStatePending— The offer must be accepted or rejectedGiftPurchaseOfferStateRejected— The offer was rejectedGiftResaleParameters— Describes parameters of a unique gift available for resaleGiftResalePriceGram— Describes price of a resold gift in TON GramsGiftResalePriceStar— Describes price of a resold gift in Telegram StarsGiftResaleResultOk— Operation was successfully completedGiftResaleResultPriceIncreased— Operation has failed, because price has increased. If the price has decreased, then the buying will succeed anywayGiftSettings— Contains settings for gift receiving for a userGiftsForCrafting— Represents a list of gifts received by a user or a chatGiftsForResale— Describes gifts available for resaleGiftUpgradePreview— Contains examples of possible upgraded gifts for the given regular giftGiftUpgradePrice— Describes a price required to pay to upgrade a giftGiftUpgradeVariants— Contains all possible variants of upgraded gifts for the given regular giftGiveawayInfoCompleted— Describes a completed giveawayGiveawayInfoOngoing— Describes an ongoing giveawayGiveawayParameters— Describes parameters of a giveawayGiveawayParticipantStatusAdministrator— The user can't participate in the giveaway, because they are an administrator in one of the chats that created the gi...GiveawayParticipantStatusAlreadyWasMember— The user can't participate in the giveaway, because they have already been member of the chatGiveawayParticipantStatusDisallowedCountry— The user can't participate in the giveaway, because their phone number is from a disallowed countryGiveawayParticipantStatusEligible— The user is eligible for the giveawayGiveawayParticipantStatusParticipating— The user participates in the giveawayGiveawayPrizePremium— The giveaway sends Telegram Premium subscriptions to the winnersGiveawayPrizeStars— The giveaway sends Telegram Stars to the winnersGramRevenueStatistics— A detailed statistics about TON Grams earned by the current userGramRevenueStatus— Contains information about TON Grams earned by the current userGroupCall— Describes a group callGroupCallDataChannelMain— The main data channel for audio and video dataGroupCallDataChannelScreenSharing— The data channel for screen sharingGroupCallId— Contains the group call identifierGroupCallInfo— Contains information about a just created or just joined group callGroupCallJoinParameters— Describes parameters used to join a group callGroupCallMessage— Represents a message sent in a group callGroupCallMessageLevel— Represents a level of features for a message sent in a live story group callGroupCallParticipant— Represents a group call participantGroupCallParticipants— Contains identifiers of group call participantsGroupCallParticipantVideoInfo— Contains information about a group call participant's video channelGroupCallRecentSpeaker— Describes a recently speaking participant in a group callGroupCallStream— Describes an available stream in a video chat or a live storyGroupCallStreams— Represents a list of group call streamsGroupCallVideoQualityFull— The best available video qualityGroupCallVideoQualityMedium— The medium video qualityGroupCallVideoQualityThumbnail— The worst available video qualityGroupCallVideoSourceGroup— Describes a group of video synchronization source identifiers
H¶
I¶
IdentityDocument— An identity documentImportedContact— Describes a contact to importImportedContacts— Represents the result of an importContacts requestInlineButton— Represents a button inside a rich messageInlineKeyboardButton— Represents a single button in an inline keyboardInlineKeyboardButtonTypeBuy— A button to buy something. This button must be in the first column and row of the keyboard and can be attached only t...InlineKeyboardButtonTypeCallback— A button that sends a callback query to a botInlineKeyboardButtonTypeCallbackGame— A button with a game that sends a callback query to a bot. This button must be in the first column and row of the key...InlineKeyboardButtonTypeCallbackWithPassword— A button that asks for the 2-step verification password of the current user and then sends a callback query to a botInlineKeyboardButtonTypeCopyText— A button that copies specified text to clipboardInlineKeyboardButtonTypeDisabled— A disabled buttonInlineKeyboardButtonTypeLoginUrl— A button that opens a specified URL and automatically authorize the current user by calling getLoginUrlInfo; not supp...InlineKeyboardButtonTypeSwitchInline— A button that forces an inline query to the bot to be inserted in the input fieldInlineKeyboardButtonTypeUrl— A button that opens a specified URLInlineKeyboardButtonTypeUser— A button with a user reference to be handled in the same way as textEntityTypeMentionName entitiesInlineKeyboardButtonTypeWebApp— A button that opens a Web App by calling openWebAppInlineMessageId— Contains identifier of a sent guest messageInlineQueryResultAnimation— Represents an animation fileInlineQueryResultArticle— Represents a link to an article or web pageInlineQueryResultAudio— Represents an audio fileInlineQueryResultContact— Represents a user contactInlineQueryResultDocument— Represents a documentInlineQueryResultGame— Represents information about a gameInlineQueryResultLocation— Represents a point on the mapInlineQueryResultPhoto— Represents a photoInlineQueryResults— Represents the results of the inline query. Use sendInlineQueryResultMessage to send the result of the queryInlineQueryResultsButton— Represents a button to be shown above inline query resultsInlineQueryResultsButtonTypeStartBot— Describes the button that opens a private chat with the bot and sends a start message to the bot with the given param...InlineQueryResultsButtonTypeWebApp— Describes the button that opens a Web App by calling getWebAppUrlInlineQueryResultSticker— Represents a stickerInlineQueryResultVenue— Represents information about a venueInlineQueryResultVideo— Represents a videoInlineQueryResultVoiceNote— Represents a voice noteInputAnimation— An animation to be sentInputAudio— An audio to be sentInputBackgroundLocal— A background from a local fileInputBackgroundPrevious— A background previously set in the chat; for chat backgrounds onlyInputBackgroundRemote— A background from the serverInputBusinessChatLink— Describes a business chat link to create or editInputBusinessStartPage— Describes settings for a business account start page to setInputCallDiscarded— A just ended callInputCallFromMessage— A call from a message of the type messageCall with non-zero messageCall.unique_idInputChatPhotoAnimation— An animation in MPEG4 format; must be square, at most 10 seconds long, have width between 160 and 1280 and be at most...InputChatPhotoPrevious— A previously used profile photo of the current userInputChatPhotoStatic— A static photo in JPEG formatInputChatPhotoSticker— A sticker on a custom backgroundInputChatThemeEmoji— A theme based on an emojiInputChatThemeGift— A theme based on an upgraded giftInputChecklist— Describes a checklist to be sentInputChecklistTask— Describes a task in a checklist to be sentInputCredentialsApplePay— Applies if a user enters new credentials using Apple PayInputCredentialsGooglePay— Applies if a user enters new credentials using Google PayInputCredentialsNew— Applies if a user enters new credentials on a payment provider websiteInputCredentialsSaved— Applies if a user chooses some previously saved payment credentials. To use their previously saved credentials, the u...InputDocument— A document (general file) to be sentInputFileGenerated— A file generated by the application. The application must handle updates updateFileGenerationStart and updateFileGene...InputFileId— A file defined by its unique identifierInputFileLocal— A file defined by a local pathInputFileRemote— A file defined by its remote identifier. The remote identifier is guaranteed to be usable only if the corresponding f...InputGroupCallLink— The group call is accessible through a linkInputGroupCallMessage— The group call is accessible through a message of the type messageGroupCallInputIdentityDocument— An identity document to be saved to Telegram PassportInputInlineQueryResultAnimation— Represents a link to an animated GIF or an animated (i.e., without sound) H.264/MPEG-4 AVC videoInputInlineQueryResultArticle— Represents a link to an article or web pageInputInlineQueryResultAudio— Represents a link to an MP3 audio fileInputInlineQueryResultContact— Represents a user contactInputInlineQueryResultDocument— Represents a link to a fileInputInlineQueryResultGame— Represents a gameInputInlineQueryResultLocation— Represents a point on the mapInputInlineQueryResultPhoto— Represents link to a JPEG imageInputInlineQueryResultSticker— Represents a link to a WEBP, TGS, or WEBM stickerInputInlineQueryResultVenue— Represents information about a venueInputInlineQueryResultVideo— Represents a link to a page containing an embedded video player or a video fileInputInlineQueryResultVoiceNote— Represents a link to an opus-encoded audio file within an OGG container, single channel audioInputInvoiceMessage— An invoice from a message of the type messageInvoice or paid media purchase from messagePaidMediaInputInvoiceName— An invoice from a link of the type internalLinkTypeInvoiceInputInvoiceTelegram— An invoice for a payment toward Telegram; must not be used in the in-store appsInputMessageAnimation— An animation message (GIF-style).InputMessageAudio— An audio messageInputMessageChecklist— A message with a checklist. Checklists can't be sent to secret chats, channel chats and channel direct messages chats...InputMessageContact— A message containing a user contactInputMessageDice— A dice messageInputMessageDocument— A document message (general file)InputMessageForwarded— A forwarded messageInputMessageGame— A message with a game; not supported for channels or secret chatsInputMessageInvoice— A message with an invoice; can be used only by botsInputMessageLiveLocation— A message with a live locationInputMessageLocation— A message with a locationInputMessagePaidMedia— A message with paid media; can be used only in channel chats with supergroupFullInfo.has_paid_media_allowedInputMessagePhoto— A photo messageInputMessagePoll— A message with a poll. Polls can't be sent to secret chats and channel direct messages chats. Polls can be sent to a ...InputMessageReplyToEphemeralMessage— Describes an ephemeral message to be replied; for bots onlyInputMessageReplyToExternalMessage— Describes a message to be replied that is from a different chat or a forum topic; not supported in secret chatsInputMessageReplyToMessage— Describes a message to be replied in the same chat and forum topicInputMessageReplyToStory— Describes a story to be repliedInputMessageRichMessage— A rich messageInputMessageStakeDice— A stake dice messageInputMessageSticker— A sticker messageInputMessageStory— A message with a forwarded story. Stories can't be forwarded to secret chats. A story can be forwarded only if story....InputMessageText— A text messageInputMessageVenue— A message with information about a venueInputMessageVideo— A video messageInputMessageVideoNote— A video note messageInputMessageVoiceNote— A voice note messageInputPageBlockAnchor— An invisible anchorInputPageBlockAnimation— An animationInputPageBlockAudio— An audio fileInputPageBlockBlockQuote— A block quoteInputPageBlockButtonRow— A list of buttons shown in a rowInputPageBlockCollage— A collageInputPageBlockDetails— A collapsible blockInputPageBlockDivider— An empty block separating the pageInputPageBlockDocument— A general fileInputPageBlockExpandableBlockQuote— An expandable block quoteInputPageBlockFooter— The footer of the pageInputPageBlockList— A list of data blocksInputPageBlockListItem— Describes an item of a list page block to be sentInputPageBlockMap— A map. The map's width and height must not exceed 10000 in total. Width and height ratio must be at most 20InputPageBlockMathematicalExpression— A mathematical expressionInputPageBlockParagraph— A text paragraphInputPageBlockPhoto— A photoInputPageBlockPreformatted— A preformatted text paragraphInputPageBlockPullQuote— A pull quoteInputPageBlockSectionHeading— A section headingInputPageBlockSlideshow— A slideshowInputPageBlockTable— A tableInputPageBlockThinking— A "Thinking..." placeholder; for pending rich messages only; for bots onlyInputPageBlockVideo— A videoInputPageBlockVoiceNote— A voice noteInputPaidMedia— Describes a paid media to be sentInputPaidMediaTypePhoto— The media is a photo. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in ...InputPaidMediaTypeVideo— The media is a videoInputPassportElementAddress— A Telegram Passport element to be saved containing the user's addressInputPassportElementBankStatement— A Telegram Passport element to be saved containing the user's bank statementInputPassportElementDriverLicense— A Telegram Passport element to be saved containing the user's driver licenseInputPassportElementEmailAddress— A Telegram Passport element to be saved containing the user's email addressInputPassportElementError— Contains the description of an error in a Telegram Passport element; for bots onlyInputPassportElementErrorSourceDataField— A data field contains an error. The error is considered resolved when the field's value changesInputPassportElementErrorSourceFile— The file contains an error. The error is considered resolved when the file changesInputPassportElementErrorSourceFiles— The list of attached files contains an error. The error is considered resolved when the file list changesInputPassportElementErrorSourceFrontSide— The front side of the document contains an error. The error is considered resolved when the file with the front side ...InputPassportElementErrorSourceReverseSide— The reverse side of the document contains an error. The error is considered resolved when the file with the reverse s...InputPassportElementErrorSourceSelfie— The selfie contains an error. The error is considered resolved when the file with the selfie changesInputPassportElementErrorSourceTranslationFile— One of the files containing the translation of the document contains an error. The error is considered resolved when ...InputPassportElementErrorSourceTranslationFiles— The translation of the document contains an error. The error is considered resolved when the list of files changesInputPassportElementErrorSourceUnspecified— The element contains an error in an unspecified place. The error will be considered resolved when new data is addedInputPassportElementIdentityCard— A Telegram Passport element to be saved containing the user's identity cardInputPassportElementInternalPassport— A Telegram Passport element to be saved containing the user's internal passportInputPassportElementPassport— A Telegram Passport element to be saved containing the user's passportInputPassportElementPassportRegistration— A Telegram Passport element to be saved containing the user's passport registrationInputPassportElementPersonalDetails— A Telegram Passport element to be saved containing the user's personal detailsInputPassportElementPhoneNumber— A Telegram Passport element to be saved containing the user's phone numberInputPassportElementRentalAgreement— A Telegram Passport element to be saved containing the user's rental agreementInputPassportElementTemporaryRegistration— A Telegram Passport element to be saved containing the user's temporary registrationInputPassportElementUtilityBill— A Telegram Passport element to be saved containing the user's utility billInputPersonalDocument— A personal document to be saved to Telegram PassportInputPhoto— A photo to be sentInputPollMediaAnimation— An animationInputPollMediaAudio— An audioInputPollMediaDocument— A document (general file)InputPollMediaLink— A linkInputPollMediaLocation— A locationInputPollMediaPhoto— A photoInputPollMediaSticker— A stickerInputPollMediaVenue— A venueInputPollMediaVideo— A videoInputPollOption— Describes one answer option of a poll to be createdInputPollTypeQuiz— A poll in quiz mode, which has predefined correct answersInputPollTypeRegular— A regular pollInputRichMessage— A rich message to send. Total length of all texts, including custom emoji alternative text and formula source, must n...InputRichMessageMedia— Describes a media to be used in a sent rich messageInputSticker— A sticker to be sentInputStoryArea— Describes a clickable rectangle area on a story media to be addedInputStoryAreas— Contains a list of story areas to be addedInputStoryAreaTypeFoundVenue— An area pointing to a venue found by the bot getOption("venue_search_bot_username")InputStoryAreaTypeLink— An area pointing to a HTTP or tg:// linkInputStoryAreaTypeLocation— An area pointing to a locationInputStoryAreaTypeMessage— An area pointing to a messageInputStoryAreaTypePreviousVenue— An area pointing to a venue already added to the storyInputStoryAreaTypeSuggestedReaction— An area pointing to a suggested reactionInputStoryAreaTypeUpgradedGift— An area with an upgraded giftInputStoryAreaTypeWeather— An area with information about weatherInputStoryContentPhoto— A photo storyInputStoryContentVideo— A video storyInputSuggestedPostInfo— Contains information about a post to suggestInputTextQuote— Describes manually chosen quote from another messageInputThumbnail— A thumbnail to be sent along with a file; must be in JPEG or WEBP format for stickers, and less than 200 KB in sizeInputVideo— A video to be sentInputVideoNote— A video note to be sentInputVoiceNote— A video note to be sentInternalLinkTypeAttachmentMenuBot— The link is a link to an attachment menu bot to be opened in the specified or a chosen chat. Process given target_cha...InternalLinkTypeAuthenticationCode— The link contains an authentication code. Call checkAuthenticationCode with the code if the current authorization sta...InternalLinkTypeBackground— The link is a link to a background. Call searchBackground with the given background name to process the link. If back...InternalLinkTypeBotAddToChannel— The link is a link to a Telegram bot, which is expected to be added to a channel chat as an administrator. Call searc...InternalLinkTypeBotStart— The link is a link to a chat with a Telegram bot. Call searchPublicChat with the given bot username, check that the u...InternalLinkTypeBotStartInGroup— The link is a link to a Telegram bot, which is expected to be added to a group chat. Call searchPublicChat with the g...InternalLinkTypeBusinessChat— The link is a link to a business chat. Use getBusinessChatLinkInfo with the provided link name to get information abo...InternalLinkTypeCallsPage— The link is a link to the Call tab or pageInternalLinkTypeChatAffiliateProgram— The link is an affiliate program link. Call searchChatAffiliateProgram with the given username and referrer to proces...InternalLinkTypeChatBoost— The link is a link to boost a Telegram chat. Call getChatBoostLinkInfo with the given URL to process the link. If the...InternalLinkTypeChatFolderInvite— The link is an invite link to a chat folder. Call checkChatFolderInviteLink with the given invite link to process the...InternalLinkTypeChatInvite— The link is a chat invite link. Call checkChatInviteLink with the given invite link to process the link. If the link ...InternalLinkTypeChatSelection— The link is a link that allows to select some chatsInternalLinkTypeContactsPage— The link is a link to the Contacts tab or pageInternalLinkTypeDirectMessagesChat— The link is a link to a channel direct messages chat by username of the channel. Call searchPublicChat with the given...InternalLinkTypeGame— The link is a link to a game. Call searchPublicChat with the given bot username, check that the user is a bot, ask th...InternalLinkTypeGiftAuction— The link is a link to a gift auction. Call getGiftAuctionState with the given auction identifier to process the linkInternalLinkTypeGiftCollection— The link is a link to a gift collection. Call searchPublicChat with the given username, then call getReceivedGifts wi...InternalLinkTypeGroupCall— The link is a link to a group call that isn't bound to a chat. Use getGroupCallParticipants to get the list of group ...InternalLinkTypeInstantView— The link must be opened in an Instant View. Call getWebPageInstantView with the given URL to process the link. If Ins...InternalLinkTypeInvoice— The link is a link to an invoice. Call getPaymentForm with the given invoice name to process the linkInternalLinkTypeLanguagePack— The link is a link to a language pack. Call getLanguagePackInfo with the given language pack identifier to process th...InternalLinkTypeLiveStory— The link is a link to a live story. Call searchPublicChat with the given chat username, then getChatActiveStories to ...InternalLinkTypeMainWebApp— The link is a link to the main Web App of a bot. Call searchPublicChat with the given bot username, check that the us...InternalLinkTypeMessage— The link is a link to a Telegram message or a forum topic. Call getMessageLinkInfo with the given URL to process the ...InternalLinkTypeMessageDraft— The link contains a message draft text. A share screen needs to be shown to the user, then the chosen chat must be op...InternalLinkTypeMyProfilePage— The link is a link to the My Profile application pageInternalLinkTypeNewChannelChat— The link is a link to the screen for creating a new channel chatInternalLinkTypeNewGroupChat— The link is a link to the screen for creating a new group chatInternalLinkTypeNewPrivateChat— The link is a link to the screen for creating a new private chat with a contactInternalLinkTypeNewStory— The link is a link to open the story posting interfaceInternalLinkTypeOauth— The link is an OAuth link. Call getOauthLinkInfo with the given URL to process the link if the link was received from...InternalLinkTypePassportDataRequest— The link contains a request of Telegram passport data. Call getPassportAuthorizationForm with the given parameters to...InternalLinkTypePhoneNumberConfirmation— The link can be used to confirm ownership of a phone number to prevent account deletion. Call sendPhoneNumberCode wit...InternalLinkTypePremiumFeaturesPage— The link is a link to the Premium features screen of the application from which the user can subscribe to Telegram Pr...InternalLinkTypePremiumGiftCode— The link is a link with a Telegram Premium gift code. Call checkPremiumGiftCode with the given code to process the li...InternalLinkTypePremiumGiftPurchase— The link is a link to the screen for gifting Telegram Premium subscriptions to friends via inputInvoiceTelegram with ...InternalLinkTypeProxy— The link is a link to a proxy. Call addProxy with the given parameters to process the link and add the proxyInternalLinkTypePublicChat— The link is a link to a chat by its username. Call searchPublicChat with the given chat username to process the link....InternalLinkTypeQrCodeAuthentication— The link can be used to login the current user on another device, but it must be scanned from QR-code using in-app ca...InternalLinkTypeRequestManagedBot— The link is a link to a dialog for creating of a managed bot. Call searchPublicChat with the given manager bot userna...InternalLinkTypeRestorePurchases— The link forces restore of App Store purchases when opened. For official iOS application onlyInternalLinkTypeSavedMessages— The link is a link to the Saved Messages chat. Call createPrivateChat with getOption("my_id") and open the chatInternalLinkTypeSearch— The link is a link to the global chat and messages search fieldInternalLinkTypeSettings— The link is a link to application settingsInternalLinkTypeStarPurchase— The link is a link to the Telegram Star purchase section of the applicationInternalLinkTypeStickerSet— The link is a link to a sticker set. Call searchStickerSet with the given sticker set name to process the link and sh...InternalLinkTypeStory— The link is a link to a story. Call searchPublicChat with the given poster username, then call getStory with the rece...InternalLinkTypeStoryAlbum— The link is a link to an album of stories. Call searchPublicChat with the given username, then call getStoryAlbumStor...InternalLinkTypeTextCompositionStyle— The link is a link to a text composition style. Call searchTextCompositionStyle with the given style name to get info...InternalLinkTypeTheme— The link is a link to a cloud theme. TDLib has no theme support yetInternalLinkTypeUnknownDeepLink— The link is an unknown tg: link. Call getDeepLinkInfo to process the linkInternalLinkTypeUpgradedGift— The link is a link to an upgraded gift. Call getUpgradedGift with the given name to process the linkInternalLinkTypeUserPhoneNumber— The link is a link to a user by its phone number. Call searchUserByPhoneNumber with the given phone number to process...InternalLinkTypeUserToken— The link is a link to a user by a temporary token. Call searchUserByToken with the given token to process the link. I...InternalLinkTypeVideoChat— The link is a link to a video chat. Call searchPublicChat with the given chat username, and then joinVideoChat with t...InternalLinkTypeWebApp— The link is a link to a Web App. Call searchPublicChat with the given bot username, check that the user is a bot. If ...InviteGroupCallParticipantResultSuccess— The user was invited and a service message of the type messageGroupCall was sent which can be used in declineGroupCal...InviteGroupCallParticipantResultUserAlreadyParticipant— The user can't be invited because they are already a participant of the callInviteGroupCallParticipantResultUserPrivacyRestricted— The user can't be invited due to their privacy settingsInviteGroupCallParticipantResultUserWasBanned— The user can't be invited because they were banned by the owner of the call and can be invited back only by the owner...InviteLinkChatTypeBasicGroup— The link is an invite link for a basic groupInviteLinkChatTypeChannel— The link is an invite link for a channelInviteLinkChatTypeSupergroup— The link is an invite link for a supergroupInvoice— Product invoice
J¶
JsonObjectMember— Represents one member of a JSON objectJsonValueArray— Represents a JSON arrayJsonValueBoolean— Represents a boolean JSON valueJsonValueNull— Represents a null JSON valueJsonValueNumber— Represents a numeric JSON valueJsonValueObject— Represents a JSON objectJsonValueString— Represents a string JSON value
K¶
KeyboardButton— Represents a single button in a bot keyboardKeyboardButtonSourceMessage— The button is from a bot's messageKeyboardButtonSourceWebApp— The button is a prepared keyboard button from a Mini App received via getPreparedKeyboardButtonKeyboardButtonTypeRequestChat— A button that requests a chat to be shared by the current user; available only in private chats. Use the method share...KeyboardButtonTypeRequestLocation— A button that sends the user's location when pressed; available only in private chatsKeyboardButtonTypeRequestManagedBot— A button that requests creation of a managed bot by the current user; available only in private chats. Use the method...KeyboardButtonTypeRequestPhoneNumber— A button that sends the user's phone number when pressed; available only in private chatsKeyboardButtonTypeRequestPoll— A button that allows the user to create and send a poll when pressed; available only in private chatsKeyboardButtonTypeRequestUsers— A button that requests users to be shared by the current user; available only in private chats. Use the method shareU...KeyboardButtonTypeText— A simple button, with text that must be sent when the button is pressedKeyboardButtonTypeWebApp— A button that opens a Web App by calling getWebAppUrl
L¶
LabeledPricePart— Portion of the price of a product (e.g., "delivery cost", "tax amount")LanguagePackInfo— Contains information about a language packLanguagePackString— Represents one language pack stringLanguagePackStrings— Contains a list of language pack stringsLanguagePackStringValueDeleted— A deleted language pack string, the value must be taken from the built-in English language packLanguagePackStringValueOrdinary— An ordinary language pack stringLanguagePackStringValuePluralized— A language pack string which has different forms based on the number of some object it mentions. See https://www.unic...LinkPreview— Describes a link previewLinkPreviewAlbumMediaPhoto— The media is a photoLinkPreviewAlbumMediaVideo— The media is a videoLinkPreviewOptions— Options to be used for generation of a link previewLinkPreviewTypeAlbum— The link is a link to a media album consisting of photos and videosLinkPreviewTypeAnimation— The link is a link to an animationLinkPreviewTypeApp— The link is a link to an app at App Store or Google PlayLinkPreviewTypeArticle— The link is a link to a websiteLinkPreviewTypeAudio— The link is a link to an audioLinkPreviewTypeBackground— The link is a link to a background. Link preview title and description are available only for filled backgroundsLinkPreviewTypeChannelBoost— The link is a link to boost a channel chatLinkPreviewTypeChat— The link is a link to a chatLinkPreviewTypeDirectMessagesChat— The link is a link to a direct messages chat of a channelLinkPreviewTypeDocument— The link is a link to a general fileLinkPreviewTypeEmbeddedAnimationPlayer— The link is a link to an animation playerLinkPreviewTypeEmbeddedAudioPlayer— The link is a link to an audio playerLinkPreviewTypeEmbeddedVideoPlayer— The link is a link to a video playerLinkPreviewTypeExternalAudio— The link is a link to an audio fileLinkPreviewTypeExternalVideo— The link is a link to a video fileLinkPreviewTypeGiftAuction— The link is a link to a gift auctionLinkPreviewTypeGiftCollection— The link is a link to a gift collectionLinkPreviewTypeGroupCall— The link is a link to a group call that isn't bound to a chatLinkPreviewTypeInvoice— The link is a link to an invoiceLinkPreviewTypeLiveStory— The link is a link to a live story group callLinkPreviewTypeMessage— The link is a link to a text or a poll Telegram messageLinkPreviewTypePhoto— The link is a link to a photoLinkPreviewTypePremiumGiftCode— The link is a link to a Telegram Premium gift codeLinkPreviewTypeRequestManagedBot— The link is a link to a dialog for creating of a managed botLinkPreviewTypeShareableChatFolder— The link is a link to a shareable chat folderLinkPreviewTypeSticker— The link is a link to a stickerLinkPreviewTypeStickerSet— The link is a link to a sticker setLinkPreviewTypeStory— The link is a link to a story. Link preview description is unavailableLinkPreviewTypeStoryAlbum— The link is a link to an album of storiesLinkPreviewTypeSupergroupBoost— The link is a link to boost a supergroup chatLinkPreviewTypeTextCompositionStyle— The link is a link to a text composition styleLinkPreviewTypeTheme— The link is a link to a cloud theme. TDLib has no theme support yetLinkPreviewTypeUnsupported— The link preview type is unsupported yetLinkPreviewTypeUpgradedGift— The link is a link to an upgraded giftLinkPreviewTypeUser— The link is a link to a userLinkPreviewTypeVideo— The link is a link to a videoLinkPreviewTypeVideoChat— The link is a link to a video chatLinkPreviewTypeVideoNote— The link is a link to a video note messageLinkPreviewTypeVoiceNote— The link is a link to a voice note messageLinkPreviewTypeWebApp— The link is a link to a Web AppLiveLocation— A live locationLiveStoryDonors— Contains a list of users and chats that spend most money on paid messages and reactions in a live storyLocalFile— Represents a local fileLocalizationTargetInfo— Contains information about the current localization targetLocation— Describes a location on planet EarthLocationAddress— Describes an address of a locationLoginUrlInfoOpen— An HTTP URL needs to be openLoginUrlInfoRequestConfirmation— An authorization confirmation dialog needs to be shown to the userLogStreamDefault— The log is written to stderr or an OS specific logLogStreamEmpty— The log is written nowhereLogStreamFile— The log is written to a fileLogTags— Contains a list of available TDLib internal log tagsLogVerbosityLevel— Contains a TDLib internal log verbosity level
M¶
MainWebApp— Contains information about the main Web App of a botMaskPointChin— The mask is placed relatively to the chinMaskPointEyes— The mask is placed relatively to the eyesMaskPointForehead— The mask is placed relatively to the foreheadMaskPointMouth— The mask is placed relatively to the mouthMaskPosition— Position on a photo where a mask is placedMessage— Describes a messageMessageAnimatedEmoji— A message with an animated emojiMessageAnimation— An animation message (GIF-style).MessageAudio— An audio messageMessageAutoDeleteTime— Contains default auto-delete timer setting for new chatsMessageBasicGroupChatCreate— A newly created basic groupMessageBotWriteAccessAllowed— The user allowed the bot to send messagesMessageCalendar— Contains information about found messages, split by days according to the option "utc_time_offset"MessageCalendarDay— Contains information about found messages sent on a specific dayMessageCall— A message with information about an ended callMessageChatAddedToCommunity— The chat was added to a communityMessageChatAddMembers— New chat members were addedMessageChatBoost— The chat was boosted by the sender of the messageMessageChatChangePhoto— An updated chat photoMessageChatChangeTitle— An updated chat titleMessageChatDeleteMember— A chat member was deletedMessageChatDeletePhoto— A deleted chat photoMessageChatHasProtectedContentDisableRequested— Chat has_protected_content setting was requested to be disabledMessageChatHasProtectedContentToggled— Chat has_protected_content setting was changed or request to change it was rejectedMessageChatJoinByLink— A new member joined the chat via an invite linkMessageChatJoinByRequest— A new member was accepted to the chat by an administratorMessageChatJoinFromCommunity— A new member joined the chat from a communityMessageChatOwnerChanged— The owner of the chat has changedMessageChatOwnerLeft— The owner of the chat has leftMessageChatRemovedFromCommunity— The chat was removed from a communityMessageChatSetBackground— A new background was set in the chatMessageChatSetMessageAutoDeleteTime— The auto-delete or self-destruct timer for messages in the chat has been changedMessageChatSetTheme— A theme in the chat has been changedMessageChatShared— The current user shared a chat, which was requested by the botMessageChatUpgradeFrom— A supergroup has been created from a basic groupMessageChatUpgradeTo— A basic group was upgraded to a supergroup and was deactivated as the resultMessageChecklist— A message with a checklistMessageChecklistTasksAdded— Some tasks were added to a checklistMessageChecklistTasksDone— Some tasks from a checklist were marked as done or not doneMessageContact— A message with a user contactMessageContactRegistered— A contact has registered with TelegramMessageCopyOptions— Options to be used when a message content is copied without reference to the original sender. Service messages, messa...MessageCustomServiceAction— A non-standard action has happened in the chatMessageDice— A dice message. The dice value is randomly generated by the serverMessageDirectMessagePriceChanged— A price for direct messages was changed in the channel chatMessageDocument— A document message (general file)MessageEffect— Contains information about an effect added to a messageMessageEffectTypeEmojiReaction— An effect from an emoji reactionMessageEffectTypePremiumSticker— An effect from a premium stickerMessageExpiredPhoto— A self-destructed photo messageMessageExpiredVideo— A self-destructed video messageMessageExpiredVideoNote— A self-destructed video note messageMessageExpiredVoiceNote— A self-destructed voice note messageMessageFileTypeGroup— The messages were exported from a group chatMessageFileTypePrivate— The messages were exported from a private chatMessageFileTypeUnknown— The messages were exported from a chat of unknown typeMessageForumTopicCreated— A forum topic has been createdMessageForumTopicEdited— A forum topic has been editedMessageForumTopicIsClosedToggled— A forum topic has been closed or openedMessageForumTopicIsHiddenToggled— A General forum topic has been hidden or unhiddenMessageForwardInfo— Contains information about a forwarded messageMessageGame— A message with a gameMessageGameScore— A new high score was achieved in a gameMessageGift— A regular gift was received or sent by the current user, or the current user was notified about a channel giftMessageGiftedGrams— TON Grams were gifted to a userMessageGiftedPremium— Telegram Premium was gifted to a userMessageGiftedStars— Telegram Stars were gifted to a userMessageGiveaway— A giveawayMessageGiveawayCompleted— A giveaway without public winners has been completed for the chatMessageGiveawayCreated— A giveaway was created for the chat. Use telegramPaymentPurposePremiumGiveaway, storePaymentPurposePremiumGiveaway, t...MessageGiveawayPrizeStars— Telegram Stars were received by the current user from a giveawayMessageGiveawayWinners— A giveaway with public winners has been completed for the chatMessageGroupCall— A message with information about a group call not bound to a chat. If the message is incoming, the call isn't active,...MessageImportInfo— Contains information about a message created with importMessagesMessageInteractionInfo— Contains information about interactions with a messageMessageInviteVideoChatParticipants— A message with information about an invitation to a video chatMessageInvoice— A message with an invoice from a bot. Use getInternalLink with internalLinkTypeBotStart to share the invoiceMessageLink— Contains an HTTPS link to a message in a supergroup or channel, or a forum topicMessageLinkInfo— Contains information about a link to a message or a forum topic in a chatMessageLiveLocation— A message with a live locationMessageLocation— A message with a locationMessageManagedBotCreated— A bot managed by another bot was created by the userMessageOriginChannel— The message was originally a post in a channelMessageOriginChat— The message was originally sent on behalf of a chatMessageOriginHiddenUser— The message was originally sent by a user who is hidden by their privacy settingsMessageOriginUser— The message was originally sent by a known userMessagePaidMedia— A message with paid mediaMessagePaidMessagePriceChanged— A price for paid messages was changed in the supergroup chatMessagePaidMessagesRefunded— Paid messages were refundedMessagePassportDataReceived— Telegram Passport data has been received; for bots onlyMessagePassportDataSent— Telegram Passport data has been sent to a botMessagePaymentRefunded— A payment has been refundedMessagePaymentSuccessful— A payment has been sent to a bot or a business accountMessagePaymentSuccessfulBot— A payment has been received by the bot or the business accountMessagePhoto— A photo messageMessagePinMessage— A message has been pinnedMessagePoll— A message with a pollMessagePollOptionAdded— A message with information about an added poll optionMessagePollOptionDeleted— A message with information about a deleted poll optionMessagePosition— Contains information about a message in a specific positionMessagePositions— Contains a list of message positionsMessagePremiumGiftCode— A Telegram Premium gift code was created for the userMessageProperties— Contains properties of a message and describes actions that can be done with the message right nowMessageProximityAlertTriggered— A user in the chat came within proximity alert rangeMessageReaction— Contains information about a reaction to a messageMessageReactions— Contains a list of reactions added to a messageMessageReadDateMyPrivacyRestricted— The read date is unknown due to privacy settings of the current user, but will be known if the user subscribes to Tel...MessageReadDateRead— Contains read date of the messageMessageReadDateTooOld— The message is too old to get read dateMessageReadDateUnread— The message is unread yetMessageReadDateUserPrivacyRestricted— The read date is unknown due to privacy settings of the other userMessageRefundedUpgradedGift— A gift which purchase, upgrade or transfer were refundedMessageReplyInfo— Contains information about replies to a messageMessageReplyToMessage— Describes a message replied by a given messageMessageReplyToStory— Describes a story replied by a given messageMessageRichMessage— A rich message; the message can have multiple media of the same type, all of which must be shown in the corresponding...Messages— Contains a list of messagesMessageSchedulingStateSendAtDate— The message will be sent at the specified dateMessageSchedulingStateSendWhenOnline— The message will be sent when the other user is online. Applicable to private chats only and when the exact online st...MessageSchedulingStateSendWhenVideoProcessed— The message will be sent when the video in the message is converted and optimized; can be used only by the serverMessageScreenshotTaken— A screenshot of a message in the chat has been takenMessageSelfDestructTypeImmediately— The message can be opened only once and will be self-destructed once closedMessageSelfDestructTypeTimer— The message will be self-destructed in the specified time after its content was openedMessageSenderChat— The message was sent on behalf of a chatMessageSenders— Represents a list of message sendersMessageSenderUser— The message was sent by a known userMessageSendingStateFailed— The message failed to be sentMessageSendingStatePending— The message is being sent now, but has not yet been delivered to the serverMessageSendOptions— Options to be used when a message is sentMessageSourceChatEventLog— The message is from a chat event logMessageSourceChatHistory— The message is from a chat historyMessageSourceChatList— The message is from a chat list or a forum topic listMessageSourceDirectMessagesChatTopicHistory— The message is from history of a topic in a channel direct messages chat administered by the current userMessageSourceForumTopicHistory— The message is from history of a forum topicMessageSourceHistoryPreview— The message is from chat, message thread or forum topic history previewMessageSourceMessageThreadHistory— The message is from history of a message threadMessageSourceNotification— The message is from a notificationMessageSourceOther— The message is from some other sourceMessageSourceScreenshot— The message was screenshotted; the source must be used only if the message content was visible during the screenshotMessageSourceSearch— The message is from search results, including file downloads, local file list, outgoing document messages, calendarMessageStakeDice— A stake dice message. The dice value is randomly generated by the serverMessageStatistics— A detailed statistics about a messageMessageSticker— A sticker messageMessageStory— A message with a forwarded storyMessageSuggestBirthdate— A birthdate was suggested to be setMessageSuggestedPostApprovalFailed— Approval of suggested post has failed, because the user who proposed the post didn't have enough fundsMessageSuggestedPostApproved— A suggested post was approvedMessageSuggestedPostDeclined— A suggested post was declinedMessageSuggestedPostPaid— A suggested post was published for getOption("suggested_post_lifetime_min") seconds and payment for the post was rece...MessageSuggestedPostRefunded— A suggested post was refundedMessageSuggestProfilePhoto— A profile photo was suggested to a user in a private chatMessageSupergroupChatCreate— A newly created supergroup or channelMessageText— A text messageMessageThreadInfo— Contains information about a message threadMessageTopicDirectMessages— A topic in a channel direct messages chat administered by the current userMessageTopicForum— A topic in a forum supergroup chat or a chat with a botMessageTopicSavedMessages— A topic in Saved Messages chatMessageTopicThread— A topic in a non-forum supergroup chatMessageUnsupported— A message content that is not supported in the current TDLib versionMessageUpgradedGift— An upgraded gift was received or sent by the current user, or the current user was notified about a channel giftMessageUpgradedGiftPurchaseOffer— An offer to purchase an upgraded gift was sent or receivedMessageUpgradedGiftPurchaseOfferRejected— An offer to purchase a gift was rejected or expiredMessageUsersShared— The current user shared users who were requested by the botMessageVenue— A message with information about a venueMessageVideo— A video messageMessageVideoChatEnded— A message with information about an ended video chatMessageVideoChatScheduled— A new video chat was scheduledMessageVideoChatStarted— A newly created video chatMessageVideoNote— A video note messageMessageViewer— Represents a viewer of a messageMessageViewers— Represents a list of message viewersMessageVoiceNote— A voice note messageMessageWebAppDataReceived— Data from a Web App has been received; for bots onlyMessageWebAppDataSent— Data from a Web App has been sent to a botMinithumbnail— Thumbnail image of a very poor quality and low resolution
N¶
NetworkStatistics— A full list of available network statistic entriesNetworkStatisticsEntryCall— Contains information about the total amount of data that was used for callsNetworkStatisticsEntryFile— Contains information about the total amount of data that was used to send and receive filesNetworkTypeMobile— A mobile networkNetworkTypeMobileRoaming— A mobile roaming networkNetworkTypeNone— The network is not availableNetworkTypeOther— A different network type (e.g., Ethernet network)NetworkTypeWiFi— A Wi-Fi networkNewChatPrivacySettings— Contains privacy settings for chats with non-contactsNewSticker— A sticker to be added to a sticker setNotification— Contains information about a notificationNotificationGroup— Describes a group of notificationsNotificationGroupTypeCalls— A group containing notifications of type notificationTypeNewCallNotificationGroupTypeMentions— A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with unread me...NotificationGroupTypeMessages— A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with ordinary ...NotificationGroupTypeSecretChat— A group containing a notification of type notificationTypeNewSecretChatNotificationSettingsScopeChannelChats— Notification settings applied to all channel chats when the corresponding chat setting has a default valueNotificationSettingsScopeGroupChats— Notification settings applied to all basic group and supergroup chats when the corresponding chat setting has a defau...NotificationSettingsScopePrivateChats— Notification settings applied to all private and secret chats when the corresponding chat setting has a default valueNotificationSound— Describes a notification sound in MP3 formatNotificationSounds— Contains a list of notification soundsNotificationTypeNewCall— New call was receivedNotificationTypeNewMessage— New message was receivedNotificationTypeNewPushMessage— New message was received through a push notificationNotificationTypeNewSecretChat— New secret chat was created
O¶
OauthLinkInfo— Information about the OAuth authorizationOk— An object of this type is returned on a successful function call for certain functionsOptionValueBoolean— Represents a boolean optionOptionValueEmpty— Represents an unknown option or an option which has a default valueOptionValueInteger— Represents an integer optionOptionValueString— Represents a string optionOrderInfo— Order informationOutline— Represents outline of an image
P¶
PageBlockAnchor— An invisible anchor on a page, which can be used in a URL to open the page from the specified anchorPageBlockAnimation— An animationPageBlockAudio— An audio filePageBlockAuthorDate— The author and publishing date of a page; instant view onlyPageBlockBlockQuote— A block quotePageBlockButtonRow— A list of buttons shown in a rowPageBlockCaption— Contains a caption of another blockPageBlockChatLink— A link to a chat; instant view onlyPageBlockCollage— A collagePageBlockCover— A page cover; instant view onlyPageBlockDetails— A collapsible blockPageBlockDivider— An empty block separating a pagePageBlockDocument— A general filePageBlockEmbedded— An embedded web page; instant view onlyPageBlockEmbeddedPost— An embedded post; instant view onlyPageBlockExpandableBlockQuote— An expandable block quotePageBlockFooter— The footer of a pagePageBlockHeader— A header; instant view onlyPageBlockHorizontalAlignmentCenter— The content must be center-alignedPageBlockHorizontalAlignmentLeft— The content must be left-alignedPageBlockHorizontalAlignmentRight— The content must be right-alignedPageBlockKicker— A kicker; instant view onlyPageBlockList— A list of data blocksPageBlockListItem— Describes an item of a list page blockPageBlockMap— A mapPageBlockMathematicalExpression— A mathematical expressionPageBlockParagraph— A text paragraphPageBlockPhoto— A photoPageBlockPreformatted— A preformatted text paragraphPageBlockPullQuote— A pull quotePageBlockRelatedArticle— Contains information about a related articlePageBlockRelatedArticles— Related articles; instant view onlyPageBlockSectionHeading— A section headingPageBlockSlideshow— A slideshowPageBlockSubheader— A subheader; instant view onlyPageBlockSubtitle— The subtitle of a page; instant view onlyPageBlockTable— A tablePageBlockTableCell— Represents a cell of a tablePageBlockThinking— A "Thinking..." placeholder; for pending rich messages onlyPageBlockTitle— The title of a page; instant view onlyPageBlockUnsupported— Represents a block unsupported by the current application versionPageBlockVerticalAlignmentBottom— The content must be bottom-alignedPageBlockVerticalAlignmentMiddle— The content must be middle-alignedPageBlockVerticalAlignmentTop— The content must be top-alignedPageBlockVideo— A videoPageBlockVoiceNote— A voice notePaidMediaPhoto— The media is a photoPaidMediaPreview— The media is hidden until the invoice is paidPaidMediaUnsupported— The media is unsupportedPaidMediaVideo— The media is a videoPaidReactionTypeAnonymous— An anonymous paid reactionPaidReactionTypeChat— A paid reaction on behalf of an owned chatPaidReactionTypeRegular— A paid reaction on behalf of the current userPaidReactor— Contains information about a user who added paid reactionsPasskey— Describes a passkeyPasskeys— Contains a list of passkeysPassportAuthorizationForm— Contains information about a Telegram Passport authorization form that was requestedPassportElementAddress— A Telegram Passport element containing the user's addressPassportElementBankStatement— A Telegram Passport element containing the user's bank statementPassportElementDriverLicense— A Telegram Passport element containing the user's driver licensePassportElementEmailAddress— A Telegram Passport element containing the user's email addressPassportElementError— Contains the description of an error in a Telegram Passport elementPassportElementErrorSourceDataField— One of the data fields contains an error. The error will be considered resolved when the value of the field changesPassportElementErrorSourceFile— The file contains an error. The error will be considered resolved when the file changesPassportElementErrorSourceFiles— The list of attached files contains an error. The error will be considered resolved when the list of files changesPassportElementErrorSourceFrontSide— The front side of the document contains an error. The error will be considered resolved when the file with the front ...PassportElementErrorSourceReverseSide— The reverse side of the document contains an error. The error will be considered resolved when the file with the reve...PassportElementErrorSourceSelfie— The selfie with the document contains an error. The error will be considered resolved when the file with the selfie c...PassportElementErrorSourceTranslationFile— One of files with the translation of the document contains an error. The error will be considered resolved when the f...PassportElementErrorSourceTranslationFiles— The translation of the document contains an error. The error will be considered resolved when the list of translation...PassportElementErrorSourceUnspecified— The element contains an error in an unspecified place. The error will be considered resolved when new data is addedPassportElementIdentityCard— A Telegram Passport element containing the user's identity cardPassportElementInternalPassport— A Telegram Passport element containing the user's internal passportPassportElementPassport— A Telegram Passport element containing the user's passportPassportElementPassportRegistration— A Telegram Passport element containing the user's passport registration pagesPassportElementPersonalDetails— A Telegram Passport element containing the user's personal detailsPassportElementPhoneNumber— A Telegram Passport element containing the user's phone numberPassportElementRentalAgreement— A Telegram Passport element containing the user's rental agreementPassportElements— Contains information about saved Telegram Passport elementsPassportElementsWithErrors— Contains information about a Telegram Passport elements and corresponding errorsPassportElementTemporaryRegistration— A Telegram Passport element containing the user's temporary registrationPassportElementTypeAddress— A Telegram Passport element containing the user's addressPassportElementTypeBankStatement— A Telegram Passport element containing the user's bank statementPassportElementTypeDriverLicense— A Telegram Passport element containing the user's driver licensePassportElementTypeEmailAddress— A Telegram Passport element containing the user's email addressPassportElementTypeIdentityCard— A Telegram Passport element containing the user's identity cardPassportElementTypeInternalPassport— A Telegram Passport element containing the user's internal passportPassportElementTypePassport— A Telegram Passport element containing the user's passportPassportElementTypePassportRegistration— A Telegram Passport element containing the registration page of the user's passportPassportElementTypePersonalDetails— A Telegram Passport element containing the user's personal detailsPassportElementTypePhoneNumber— A Telegram Passport element containing the user's phone numberPassportElementTypeRentalAgreement— A Telegram Passport element containing the user's rental agreementPassportElementTypeTemporaryRegistration— A Telegram Passport element containing the user's temporary registrationPassportElementTypeUtilityBill— A Telegram Passport element containing the user's utility billPassportElementUtilityBill— A Telegram Passport element containing the user's utility billPassportRequiredElement— Contains a description of the required Telegram Passport element that was requested by a servicePassportSuitableElement— Contains information about a Telegram Passport element that was requested by a servicePasswordState— Represents the current state of 2-step verificationPaymentForm— Contains information about an invoice payment formPaymentFormTypeRegular— The payment form is for a regular paymentPaymentFormTypeStars— The payment form is for a payment in Telegram StarsPaymentFormTypeStarSubscription— The payment form is for a payment in Telegram Stars for subscriptionPaymentOption— Describes an additional payment optionPaymentProviderOther— Some other payment provider, for which a web payment form must be shownPaymentProviderSmartGlocal— Smart Glocal payment providerPaymentProviderStripe— Stripe payment providerPaymentReceipt— Contains information about a successful paymentPaymentReceiptTypeRegular— The payment was done using a third-party payment providerPaymentReceiptTypeStars— The payment was done using Telegram StarsPaymentResult— Contains the result of a payment requestPersonalDetails— Contains the user's personal detailsPersonalDocument— A personal document, containing some information about a userPhoneNumberAuthenticationSettings— Contains settings for the authentication of the user's phone numberPhoneNumberCodeTypeChange— Checks ownership of a new phone number to change the user's authentication phone number; for official Android and iOS...PhoneNumberCodeTypeConfirmOwnership— Confirms ownership of a phone number to prevent account deletion while handling links of the type internalLinkTypePho...PhoneNumberCodeTypeVerify— Verifies ownership of a phone number to be added to the user's Telegram PassportPhoneNumberInfo— Contains information about a phone numberPhoto— Describes a photoPhotoSize— Describes an image in JPEG formatPoint— A point on a Cartesian planePoll— Describes a pollPollMediaAnimation— An animationPollMediaAudio— An audioPollMediaDocument— A document (general file)PollMediaLink— A linkPollMediaLocation— A locationPollMediaPhoto— A photoPollMediaSticker— A stickerPollMediaVenue— A venuePollMediaVideo— A videoPollOption— Describes one answer option of a pollPollOptionProperties— Contains properties of a poll option and describes actions that can be done with the option right nowPollTypeQuiz— A poll in quiz mode, which has predefined correct answersPollTypeRegular— A regular pollPollVoter— Represents a poll voterPollVoteRestrictionReasonClosed— The poll is closedPollVoteRestrictionReasonCountryRestricted— The user is from a country, users from which aren't allowed to votePollVoteRestrictionReasonMembershipRequired— The user must be a member of the chat for at least a day to votePollVoteRestrictionReasonOther— The poll can't be voted by the user due to some other reasonPollVoteRestrictionReasonScheduled— The poll is from a scheduled messagePollVoteRestrictionReasonYetUnsent— The poll isn't sent yetPollVoters— Represents a list of poll votersPollVoteStatistics— A detailed statistics about poll votesPremiumFeatureAccentColor— The ability to choose accent color for replies and user profilePremiumFeatureAdvancedChatManagement— Ability to change position of the main chat list, archive and mute all new chats from non-contacts, and completely di...PremiumFeatureAnimatedProfilePhoto— Profile photo animation on message and chat screensPremiumFeatureAppIcons— Allowed to set a premium application iconsPremiumFeatureBackgroundForBoth— The ability to set private chat background for both usersPremiumFeatureBusiness— The ability to use Business featuresPremiumFeatureChatBoost— The ability to boost chatsPremiumFeatureChecklists— The ability to create and use checklist messagesPremiumFeatureCustomEmoji— Allowed to use custom emoji stickers in message texts and captionsPremiumFeatureDisabledAds— Disabled adsPremiumFeatureEmojiStatus— The ability to show an emoji status along with the user's namePremiumFeatureForumTopicIcon— The ability to set a custom emoji as a forum topic iconPremiumFeatureImprovedDownloadSpeed— Improved download speedPremiumFeatureIncreasedLimits— Increased limitsPremiumFeatureIncreasedUploadFileSize— Increased maximum upload file sizePremiumFeatureLastSeenTimes— The ability to view last seen and read times of other users even if they can't view last seen or read time for the cu...PremiumFeatureMessageEffects— The ability to use all available message effectsPremiumFeatureMessagePrivacy— The ability to disallow incoming voice and video note messages in private chats using setUserPrivacySettingRules with...PremiumFeaturePaidMessages— The ability to require a payment for incoming messages in new chatsPremiumFeatureProfileBadge— A badge in the user's profilePremiumFeaturePromotionAnimation— Describes a promotion animation for a Premium featurePremiumFeatureProtectPrivateChatContent— The ability to enable content protection in private chatsPremiumFeatureRealTimeChatTranslation— Allowed to translate chat messages real-timePremiumFeatureRichMessages— The ability to send rich messagesPremiumFeatures— Contains information about features, available to Premium usersPremiumFeatureSavedMessagesTags— The ability to use tags in Saved MessagesPremiumFeatureTextComposition— The ability to compose text with AIPremiumFeatureUniqueReactions— Allowed to use more reactionsPremiumFeatureUniqueStickers— Allowed to use premium stickers with unique effectsPremiumFeatureUpgradedStories— Allowed to use many additional features for storiesPremiumFeatureVoiceRecognition— The ability to convert voice notes to textPremiumGiftCodeInfo— Contains information about a Telegram Premium gift codePremiumGiftPaymentOption— Describes an option for gifting Telegram Premium to a user. Use telegramPaymentPurposePremiumGift for out-of-store pa...PremiumGiftPaymentOptions— Contains a list of options for gifting Telegram Premium to a userPremiumGiveawayPaymentOption— Describes an option for creating of Telegram Premium giveaway or manual distribution of Telegram Premium among chat m...PremiumGiveawayPaymentOptions— Contains a list of options for creating of Telegram Premium giveaway or manual distribution of Telegram Premium among...PremiumLimit— Contains information about a limit, increased for Premium usersPremiumLimitTypeActiveStoryCount— The maximum number of active storiesPremiumLimitTypeBioLength— The maximum length of the user's bioPremiumLimitTypeCaptionLength— The maximum length of sent media captionPremiumLimitTypeChatFolderChosenChatCount— The maximum number of pinned and always included, or always excluded chats in a chat folderPremiumLimitTypeChatFolderCount— The maximum number of chat foldersPremiumLimitTypeChatFolderInviteLinkCount— The maximum number of invite links for a chat folderPremiumLimitTypeCreatedPublicChatCount— The maximum number of created public chatsPremiumLimitTypeCustomTextCompositionStyleCount— The maximum number of added text composition stylesPremiumLimitTypeFavoriteStickerCount— The maximum number of favorite stickersPremiumLimitTypeMessageTextLength— The maximum length of text of sent messagesPremiumLimitTypeMonthlyPostedStoryCount— The maximum number of stories posted per monthPremiumLimitTypeOwnedBotCount— The maximum number of owned botsPremiumLimitTypePinnedArchivedChatCount— The maximum number of pinned chats in the archive chat listPremiumLimitTypePinnedChatCount— The maximum number of pinned chats in the main chat listPremiumLimitTypePinnedSavedMessagesTopicCount— The maximum number of pinned Saved Messages topicsPremiumLimitTypeSavedAnimationCount— The maximum number of saved animationsPremiumLimitTypeShareableChatFolderCount— The maximum number of added shareable chat foldersPremiumLimitTypeSimilarChatCount— The maximum number of received similar chatsPremiumLimitTypeStoryCaptionLength— The maximum length of captions of posted storiesPremiumLimitTypeStorySuggestedReactionAreaCount— The maximum number of suggested reaction areas on a storyPremiumLimitTypeSupergroupCount— The maximum number of joined supergroups and channelsPremiumLimitTypeWeeklyPostedStoryCount— The maximum number of stories posted per weekPremiumPaymentOption— Describes an option for buying Telegram Premium to a userPremiumSourceBusinessFeature— A user tried to use a Business featurePremiumSourceFeature— A user tried to use a Premium featurePremiumSourceLimitExceeded— A limit was exceededPremiumSourceLink— A user opened an internal link of the type internalLinkTypePremiumFeaturesPagePremiumSourceSettings— A user opened the Premium features screen from settingsPremiumSourceStoryFeature— A user tried to use a Premium story featurePremiumState— Contains state of Telegram Premium subscription and promotion videos for Premium featuresPremiumStatePaymentOption— Describes an option for buying or upgrading Telegram Premium for selfPremiumStoryFeatureCustomExpirationDuration— The ability to set custom expiration duration for storiesPremiumStoryFeatureLinksAndFormatting— The ability to use links and formatting in story caption, and use inputStoryAreaTypeLink areasPremiumStoryFeaturePermanentViewsHistory— The ability to check who opened the current user's stories after they expirePremiumStoryFeaturePriorityOrder— Stories of the current user are displayed before stories of non-Premium contacts, supergroups, and channelsPremiumStoryFeatureSaveStories— The ability to save other's unprotected storiesPremiumStoryFeatureStealthMode— The ability to hide the fact that the user viewed other's storiesPremiumStoryFeatureVideoQuality— The ability to choose better quality for viewed storiesPrepaidGiveaway— Describes a prepaid giveawayPreparedInlineMessage— Represents a ready to send inline message. Use sendInlineQueryResultMessage to send the messagePreparedInlineMessageId— Represents an inline message that can be sent via the botProductInfo— Contains information about a product that can be paid with invoiceProfileAccentColor— Contains information about supported accent color for user profile photo backgroundProfileAccentColors— Contains information about supported accent colors for user profile photo background in RGB formatProfilePhoto— Describes a user profile photoProfileTabFiles— A tab with documents posted by the channelProfileTabGifs— A tab with animations posted by the channelProfileTabGifts— A tab with gifts received by the user or the channel chatProfileTabLinks— A tab with messages posted by the channel and containing linksProfileTabMedia— A tab with photos and videos posted by the channelProfileTabMusic— A tab with audio messages posted by the channelProfileTabPosts— A tab with stories posted by the user or the channel chat and saved to profileProfileTabVoice— A tab with voice notes posted by the channelProxy— Describes a proxy serverProxyTypeHttp— A HTTP transparent proxy serverProxyTypeMtproto— An MTProto proxy serverProxyTypeSocks5— A SOCKS5 proxy serverPublicChatTypeHasUsername— The chat is public, because it has an active usernamePublicChatTypeIsLocationBased— The chat is public, because it is a location-based supergroupPublicForwardMessage— Contains a public forward as a messagePublicForwards— Represents a list of public forwards and reposts as a story of a message or a storyPublicForwardStory— Contains a public repost to a storyPublicPostSearchLimits— Contains information about public post search limitsPushMessageContentAnimation— An animation message (GIF-style).PushMessageContentAudio— An audio messagePushMessageContentBasicGroupChatCreate— A newly created basic groupPushMessageContentChatAddMembers— New chat members were invited to a groupPushMessageContentChatChangePhoto— A chat photo was editedPushMessageContentChatChangeTitle— A chat title was editedPushMessageContentChatDeleteMember— A chat member was deletedPushMessageContentChatJoinByLink— A new member joined the chat via an invite linkPushMessageContentChatJoinByRequest— A new member was accepted to the chat by an administratorPushMessageContentChatSetBackground— A chat background was editedPushMessageContentChatSetTheme— A chat theme was editedPushMessageContentChecklist— A message with a checklistPushMessageContentChecklistTasksAdded— Some tasks were added to a checklistPushMessageContentChecklistTasksDone— Some tasks from a checklist were marked as done or not donePushMessageContentContact— A message with a user contactPushMessageContentContactRegistered— A contact has registered with TelegramPushMessageContentDocument— A document message (a general file)PushMessageContentGame— A message with a gamePushMessageContentGameScore— A new high score was achieved in a gamePushMessageContentGift— A message with a giftPushMessageContentGiveaway— A message with a giveawayPushMessageContentHidden— A general message with hidden contentPushMessageContentInviteVideoChatParticipants— An invitation of participants to a video chat or live streamPushMessageContentInvoice— A message with an invoice from a botPushMessageContentLocation— A message with a locationPushMessageContentMediaAlbum— A media albumPushMessageContentMessageForwards— A forwarded messagesPushMessageContentPaidMedia— A message with paid mediaPushMessageContentPhoto— A photo messagePushMessageContentPoll— A message with a pollPushMessageContentPollOptionAdded— An option was added to a pollPushMessageContentPremiumGiftCode— A message with a Telegram Premium gift code created for the userPushMessageContentProximityAlertTriggered— A user in the chat came within proximity alert range from the current userPushMessageContentRecurringPayment— A new recurring payment was made by the current userPushMessageContentScreenshotTaken— A screenshot of a message in the chat has been takenPushMessageContentSticker— A message with a stickerPushMessageContentStory— A message with a storyPushMessageContentSuggestBirthdate— A birthdate was suggested to be setPushMessageContentSuggestProfilePhoto— A profile photo was suggested to the userPushMessageContentText— A text messagePushMessageContentUpgradedGift— A message with an upgraded giftPushMessageContentVideo— A video messagePushMessageContentVideoChatEnded— A video chat or live stream has endedPushMessageContentVideoChatStarted— A video chat or live stream was startedPushMessageContentVideoNote— A video note messagePushMessageContentVoiceNote— A voice note messagePushReceiverId— Contains a globally unique push receiver identifier, which can be used to identify which account has received a push ...
Q¶
QuickReplyMessage— Describes a message that can be used for quick replyQuickReplyMessages— Contains a list of quick reply messagesQuickReplyShortcut— Describes a shortcut that can be used for a quick reply
R¶
ReactionNotificationSettings— Contains information about notification settings for reactions and poll votesReactionNotificationSourceAll— Notifications for reactions are shown for all reactionsReactionNotificationSourceContacts— Notifications for reactions are shown only for reactions from contactsReactionNotificationSourceNone— Notifications for reactions are disabledReactionTypeCustomEmoji— A reaction with a custom emojiReactionTypeEmoji— A reaction with an emojiReactionTypePaid— The paid reaction in a channel chatReactionUnavailabilityReasonAnonymousAdministrator— The user is an anonymous administrator in the supergroup, but isn't a creator of it, so they can't vote on behalf of ...ReactionUnavailabilityReasonGuest— The user isn't a member of the supergroup and can't send messages and reactions there without joiningReactionUnavailabilityReasonRestricted— The user is restricted in the chatReadDatePrivacySettings— Contains privacy settings for message read date in private chats. Read dates are always shown to the users that can s...ReceivedGift— Represents a gift received by a user or a chatReceivedGifts— Represents a list of gifts received by a user or a chatRecommendedChatFolder— Describes a recommended chat folderRecommendedChatFolders— Contains a list of recommended chat foldersRecoveryEmailAddress— Contains information about the current recovery email addressRemoteFile— Represents a remote fileReplyMarkupForceReply— Instructs application to force a reply to this messageReplyMarkupInlineKeyboard— Contains an inline keyboard layoutReplyMarkupRemoveKeyboard— Instructs application to remove the keyboard once this message has been received. This kind of keyboard can't be rece...ReplyMarkupShowKeyboard— Contains a custom keyboard layout to quickly reply to botsReportChatResultMessagesRequired— The user must choose messages to report and repeat the reportChat request with the chosen messagesReportChatResultOk— The chat was reported successfullyReportChatResultOptionRequired— The user must choose an option to report the chat and repeat request with the chosen optionReportChatResultTextRequired— The user must add additional text details to the reportReportOption— Describes an option to report an entity to TelegramReportReasonChildAbuse— The chat has child abuse related contentReportReasonCopyright— The chat contains copyrighted contentReportReasonCustom— A custom reason provided by the userReportReasonFake— The chat represents a fake accountReportReasonIllegalDrugs— The chat has illegal drugs related contentReportReasonPersonalDetails— The chat contains messages with personal detailsReportReasonPornography— The chat contains pornographic messagesReportReasonSpam— The chat contains spam messagesReportReasonUnrelatedLocation— The location-based chat is unrelated to its stated locationReportReasonViolence— The chat promotes violenceReportSponsoredResultAdsHidden— Sponsored messages were hidden for the user in all chatsReportSponsoredResultFailed— The sponsored message is too old or not foundReportSponsoredResultOk— The message was reported successfullyReportSponsoredResultOptionRequired— The user must choose an option to report the message and repeat request with the chosen optionReportSponsoredResultPremiumRequired— The user asked to hide sponsored messages, but Telegram Premium is required for thisReportStoryResultOk— The story was reported successfullyReportStoryResultOptionRequired— The user must choose an option to report the story and repeat request with the chosen optionReportStoryResultTextRequired— The user must add additional text details to the reportResendCodeReasonUserRequest— The user requested to resend the codeResendCodeReasonVerificationFailed— The code is re-sent, because device verification has failedResetPasswordResultDeclined— The password reset request was declinedResetPasswordResultOk— The password was resetResetPasswordResultPending— The password reset request is pendingRestrictionInfo— Contains information about restrictions that must be applied to a chat or a messageRevenueWithdrawalStateFailed— Withdrawal failedRevenueWithdrawalStatePending— Withdrawal is pendingRevenueWithdrawalStateSucceeded— Withdrawal succeededRichMessage— Describes a message with rich formattingRichMessageSourceBlocks— A rich message defined by blocksRichMessageSourceHtml— An HTML-formatted rich message; for bots onlyRichMessageSourceMarkdown— A Markdown-formatted rich message; for bots onlyRichTextAnchor— An anchorRichTextAnchorLink— A link to an anchor on the same pageRichTextBankCardNumber— A bank card numberRichTextBold— A bold rich textRichTextBotCommand— A bot commandRichTextButton— A buttonRichTextCashtag— A cashtagRichTextCustomEmoji— A custom emojiRichTextDateTime— A date and timeRichTextDiff— A rich text replacing another rich text; not supported in inputRichMessageRichTextEmailAddress— A rich text email addressRichTextFixed— A fixed-width rich textRichTextHashtag— A hashtagRichTextIcon— A small image inside the text; instant view onlyRichTextItalic— An italicized rich textRichTextMarked— A marked rich textRichTextMathematicalExpression— A mathematical expressionRichTextMention— A mention of a Telegram user or chat by a usernameRichTextMentionName— A rich text that serves as a mention of a userRichTextPhoneNumber— A rich text phone numberRichTextPlain— A plain textRichTextReference— A referenceRichTextReferenceLink— A link to a reference on the same pageRichTexts— A concatenation of rich textsRichTextSpoiler— A spoilered rich textRichTextStrikethrough— A strikethrough rich textRichTextSubscript— A subscript rich textRichTextSuperscript— A superscript rich textRichTextUnderline— An underlined rich textRichTextUrl— A rich text URL linkRtmpUrl— Represents an RTMP URL
S¶
SavedCredentials— Contains information about saved payment credentialsSavedMessagesTag— Represents a tag used in Saved Messages or a Saved Messages topicSavedMessagesTags— Contains a list of tags used in Saved MessagesSavedMessagesTopic— Contains information about a Saved Messages topicSavedMessagesTopicTypeAuthorHidden— Topic containing messages forwarded from a user with hidden privacySavedMessagesTopicTypeMyNotes— Topic containing messages sent by the current user of forwarded from an unknown chatSavedMessagesTopicTypeSavedFromChat— Topic containing messages forwarded from a specific chatScopeAutosaveSettings— Contains autosave settings for an autosave settings scopeScopeNotificationSettings— Contains information about notification settings for several chatsSearchChatTypeFilterBot— Returns only private chats with botsSearchChatTypeFilterChannel— Returns only channel chatsSearchMessagesChatTypeFilterChannel— Returns only messages in channel chatsSearchMessagesChatTypeFilterCommunity— Returns only messages in the specified communitySearchMessagesChatTypeFilterGroup— Returns only messages in basic group and supergroup chatsSearchMessagesChatTypeFilterPrivate— Returns only messages in private chatsSearchMessagesFilterAnimation— Returns only animation messagesSearchMessagesFilterAudio— Returns only audio messagesSearchMessagesFilterChatPhoto— Returns only messages containing chat photosSearchMessagesFilterDocument— Returns only document messagesSearchMessagesFilterEmpty— Returns all found messages, no filter is appliedSearchMessagesFilterFailedToSend— Returns only failed to send messages. This filter can be used only if the message database is usedSearchMessagesFilterMention— Returns only messages with mentions of the current user, or messages that are replies to their messagesSearchMessagesFilterPhoto— Returns only photo messagesSearchMessagesFilterPhotoAndVideo— Returns only photo and video messagesSearchMessagesFilterPinned— Returns only pinned messagesSearchMessagesFilterPoll— Returns only poll messagesSearchMessagesFilterUnreadMention— Returns only messages with unread mentions of the current user, or messages that are replies to their messages. When ...SearchMessagesFilterUnreadPollVote— Returns only messages with unread poll votes for the current user. When using this filter the results can't be additi...SearchMessagesFilterUnreadReaction— Returns only messages with unread reactions for the current user. When using this filter the results can't be additio...SearchMessagesFilterUrl— Returns only messages containing URLsSearchMessagesFilterVideo— Returns only video messagesSearchMessagesFilterVideoNote— Returns only video note messagesSearchMessagesFilterVoiceAndVideoNote— Returns only voice and video note messagesSearchMessagesFilterVoiceNote— Returns only voice note messagesSeconds— Contains a value representing a number of secondsSecretChat— Represents a secret chatSecretChatStateClosed— The secret chat is closedSecretChatStatePending— The secret chat is not yet created; waiting for the other user to get onlineSecretChatStateReady— The secret chat is ready to useSentGiftRegular— Regular giftSentGiftUpgraded— Upgraded giftSession— Contains information about one session in a Telegram application used by the current user. Sessions must be shown to ...SessionDeviceTypeAndroid— The session is running on an Android deviceSessionDeviceTypeApple— The session is running on a generic Apple deviceSessionDeviceTypeBrave— The session is running on the Brave browserSessionDeviceTypeChrome— The session is running on the Chrome browserSessionDeviceTypeEdge— The session is running on the Edge browserSessionDeviceTypeFirefox— The session is running on the Firefox browserSessionDeviceTypeIpad— The session is running on an iPad deviceSessionDeviceTypeIphone— The session is running on an iPhone deviceSessionDeviceTypeLinux— The session is running on a Linux deviceSessionDeviceTypeMac— The session is running on a Mac deviceSessionDeviceTypeOpera— The session is running on the Opera browserSessionDeviceTypeSafari— The session is running on the Safari browserSessionDeviceTypeUbuntu— The session is running on an Ubuntu deviceSessionDeviceTypeUnknown— The session is running on an unknown type of deviceSessionDeviceTypeVivaldi— The session is running on the Vivaldi browserSessionDeviceTypeWindows— The session is running on a Windows deviceSessionDeviceTypeXbox— The session is running on an Xbox consoleSessions— Contains a list of sessionsSessionTypeConnectedBot— A business bot connected to the current user's accountSessionTypeDevice— A regular session from a deviceSettingsSectionAppearance— The appearance sectionSettingsSectionAskQuestion— The "Ask a question" sectionSettingsSectionBusiness— The "Telegram Business" sectionSettingsSectionChatFolders— The chat folder settings sectionSettingsSectionDataAndStorage— The data and storage settings sectionSettingsSectionDevices— The Devices sectionSettingsSectionEditProfile— The profile edit sectionSettingsSectionFaq— The FAQ sectionSettingsSectionFeatures— The "Telegram Features" sectionSettingsSectionInAppBrowser— The in-app browser settings sectionSettingsSectionLanguage— The application language sectionSettingsSectionMyGrams— The TON Gram balance and transaction sectionSettingsSectionMyStars— The Telegram Star balance and transaction sectionSettingsSectionNotifications— The notification settings sectionSettingsSectionPowerSaving— The power saving settings sectionSettingsSectionPremium— The "Telegram Premium" sectionSettingsSectionPrivacyAndSecurity— The privacy and security sectionSettingsSectionPrivacyPolicy— The "Privacy Policy" sectionSettingsSectionQrCode— The current user's QR code sectionSettingsSectionSearch— Search in SettingsSettingsSectionSendGift— The "Send a gift" sectionSharedChat— Contains information about a chat shared with a botSharedUser— Contains information about a user shared with a botShippingOption— One shipping optionSpeechRecognitionResultError— The speech recognition failedSpeechRecognitionResultPending— The speech recognition is ongoingSpeechRecognitionResultText— The speech recognition successfully finishedSponsoredChat— Describes a sponsored chatSponsoredChats— Contains a list of sponsored chatsSponsoredMessage— Describes a sponsored messageSponsoredMessages— Contains a list of sponsored messagesStakeDiceState— Describes state of the stake diceStarAmount— Describes a possibly non-integer Telegram Star amountStarCount— Contains a number of Telegram StarsStarGiveawayPaymentOption— Describes an option for creating of Telegram Star giveaway. Use telegramPaymentPurposeStarGiveaway for out-of-store p...StarGiveawayPaymentOptions— Contains a list of options for creating of Telegram Star giveawayStarGiveawayWinnerOption— Describes an option for the number of winners of a Telegram Star giveawayStarPaymentOption— Describes an option for buying Telegram Stars. Use telegramPaymentPurposeStars for out-of-store paymentsStarPaymentOptions— Contains a list of options for buying Telegram StarsStarRevenueStatistics— A detailed statistics about Telegram Stars earned by a user or a chatStarRevenueStatus— Contains information about Telegram Stars earned by a user or a chatStarSubscription— Contains information about subscription to a channel chat, a bot, or a business account that was paid in Telegram StarsStarSubscriptionPricing— Describes subscription plan paid in Telegram StarsStarSubscriptions— Represents a list of Telegram Star subscriptionsStarSubscriptionTypeBot— Describes a subscription in a bot or a business accountStarSubscriptionTypeChannel— Describes a subscription to a channel chatStartLiveStoryResultFail— The live story failed to post with an error to be handledStartLiveStoryResultOk— The live story was successfully postedStarTransaction— Represents a transaction changing the amount of owned Telegram StarsStarTransactions— Represents a list of Telegram Star transactionsStarTransactionTypeAffiliateProgramCommission— The transaction is a receiving of a commission from an affiliate program; relevant for regular users, bots and channe...StarTransactionTypeAppStoreDeposit— The transaction is a deposit of Telegram Stars from App Store; relevant for regular users onlyStarTransactionTypeBotInvoicePurchase— The transaction is a purchase of a product from a bot or a business account by the current user; relevant for regular...StarTransactionTypeBotInvoiceSale— The transaction is a sale of a product by the bot; relevant for bots onlyStarTransactionTypeBotPaidMediaPurchase— The transaction is a purchase of paid media from a bot or a business account by the current user; relevant for regula...StarTransactionTypeBotPaidMediaSale— The transaction is a sale of paid media by the bot or a business account managed by the bot; relevant for bots onlyStarTransactionTypeBotSubscriptionPurchase— The transaction is a purchase of a subscription from a bot or a business account by the current user; relevant for re...StarTransactionTypeBotSubscriptionSale— The transaction is a sale of a subscription by the bot; relevant for bots onlyStarTransactionTypeBusinessBotTransferReceive— The transaction is a transfer of Telegram Stars from a business account; relevant for bots onlyStarTransactionTypeBusinessBotTransferSend— The transaction is a transfer of Telegram Stars to a business bot; relevant for regular users onlyStarTransactionTypeChannelPaidMediaPurchase— The transaction is a purchase of paid media from a channel by the current user; relevant for regular users onlyStarTransactionTypeChannelPaidMediaSale— The transaction is a sale of paid media by the channel chat; relevant for channel chats onlyStarTransactionTypeChannelPaidReactionReceive— The transaction is a receiving of a paid reaction to a message by the channel chat; relevant for channel chats onlyStarTransactionTypeChannelPaidReactionSend— The transaction is a sending of a paid reaction to a message in a channel chat by the current user; relevant for regu...StarTransactionTypeChannelSubscriptionPurchase— The transaction is a purchase of a subscription to a channel chat by the current user; relevant for regular users onlyStarTransactionTypeChannelSubscriptionSale— The transaction is a sale of a subscription by the channel chat; relevant for channel chats onlyStarTransactionTypeFragmentDeposit— The transaction is a deposit of Telegram Stars from Fragment; relevant for regular users and bots onlyStarTransactionTypeFragmentWithdrawal— The transaction is a withdrawal of earned Telegram Stars to Fragment; relevant for regular users, bots, supergroup an...StarTransactionTypeGiftAuctionBid— The transaction is a bid on a gift auction; relevant for regular users onlyStarTransactionTypeGiftOriginalDetailsDrop— The transaction is a drop of original details of an upgraded gift; relevant for regular users onlyStarTransactionTypeGiftPurchase— The transaction is a purchase of a regular gift; relevant for regular users and bots onlyStarTransactionTypeGiftPurchaseOffer— The transaction is an offer of gift purchase; relevant for regular users onlyStarTransactionTypeGiftSale— The transaction is a sale of a received gift; relevant for regular users and channel chats onlyStarTransactionTypeGiftTransfer— The transaction is a transfer of an upgraded gift; relevant for regular users onlyStarTransactionTypeGiftUpgrade— The transaction is an upgrade of a gift; relevant for regular users onlyStarTransactionTypeGiftUpgradePurchase— The transaction is a purchase of an upgrade of a gift owned by another user or channel; relevant for regular users onlyStarTransactionTypeGiveawayDeposit— The transaction is a deposit of Telegram Stars from a giveaway; relevant for regular users onlyStarTransactionTypeGooglePlayDeposit— The transaction is a deposit of Telegram Stars from Google Play; relevant for regular users onlyStarTransactionTypePaidGroupCallMessageReceive— The transaction is a receiving of a paid group call message; relevant for regular users and channel chats onlyStarTransactionTypePaidGroupCallMessageSend— The transaction is a sending of a paid group call message; relevant for regular users onlyStarTransactionTypePaidGroupCallReactionReceive— The transaction is a receiving of a paid group call reaction; relevant for regular users and channel chats onlyStarTransactionTypePaidGroupCallReactionSend— The transaction is a sending of a paid group reaction; relevant for regular users onlyStarTransactionTypePaidMessageReceive— The transaction is a receiving of a paid message; relevant for regular users, supergroup and channel chats onlyStarTransactionTypePaidMessageSend— The transaction is a sending of a paid message; relevant for regular users onlyStarTransactionTypePremiumBotDeposit— The transaction is a deposit of Telegram Stars from the Premium bot; relevant for regular users onlyStarTransactionTypePremiumPurchase— The transaction is a purchase of Telegram Premium subscription; relevant for regular users and bots onlyStarTransactionTypePublicPostSearch— The transaction is a payment for search of posts in public Telegram channels; relevant for regular users onlyStarTransactionTypeSuggestedPostPaymentReceive— The transaction is a receiving of a payment for a suggested post by the channel chat; relevant for channel chats onlyStarTransactionTypeSuggestedPostPaymentSend— The transaction is a payment for a suggested post; relevant for regular users onlyStarTransactionTypeTelegramAdsWithdrawal— The transaction is a withdrawal of earned Telegram Stars to Telegram Ad platform; relevant for bots and channel chats...StarTransactionTypeTelegramApiUsage— The transaction is a payment for Telegram API usage; relevant for bots onlyStarTransactionTypeUnsupported— The transaction is a transaction of an unsupported typeStarTransactionTypeUpgradedGiftPurchase— The transaction is a purchase of an upgraded gift for some user or channel; relevant for regular users onlyStarTransactionTypeUpgradedGiftSale— The transaction is a sale of an upgraded gift; relevant for regular users onlyStarTransactionTypeUserDeposit— The transaction is a deposit of Telegram Stars by another user; relevant for regular users onlyStatisticalGraphAsync— The graph data to be asynchronously loaded through getStatisticalGraphStatisticalGraphData— A graph dataStatisticalGraphError— An error message to be shown to the user instead of the graphStatisticalValue— A value with information about its recent changesSticker— Describes a stickerStickerFormatTgs— The sticker is an animation in TGS formatStickerFormatWebm— The sticker is a video in WEBM formatStickerFormatWebp— The sticker is an image in WEBP formatStickerFullTypeCustomEmoji— The sticker is a custom emoji to be used inside message text and caption. Currently, only Telegram Premium users can ...StickerFullTypeMask— The sticker is a mask in WEBP format to be placed on photos or videosStickerFullTypeRegular— The sticker is a regular stickerStickers— Represents a list of stickersStickerSet— Represents a sticker setStickerSetInfo— Represents short information about a sticker setStickerSets— Represents a list of sticker setsStickerTypeCustomEmoji— The sticker is a custom emoji to be used inside message text and captionStickerTypeMask— The sticker is a mask in WEBP format to be placed on photos or videosStickerTypeRegular— The sticker is a regular stickerStorageStatistics— Contains the exact storage usage statistics split by chats and file typeStorageStatisticsByChat— Contains the storage usage statistics for a specific chatStorageStatisticsByFileType— Contains the storage usage statistics for a specific file typeStorageStatisticsFast— Contains approximate storage usage statistics, excluding files of unknown file typeStorePaymentPurposeGiftedStars— The user buying Telegram Stars for other usersStorePaymentPurposePremiumGift— The user gifting Telegram Premium to another userStorePaymentPurposePremiumGiftCodes— The user boosting a chat by creating Telegram Premium gift codes for other usersStorePaymentPurposePremiumGiveaway— The user creating a Telegram Premium giveawayStorePaymentPurposePremiumSubscription— The user subscribing to Telegram PremiumStorePaymentPurposeStarGiveaway— The user creating a Telegram Star giveawayStorePaymentPurposeStars— The user buying Telegram StarsStoreTransactionAppStore— A purchase through App StoreStoreTransactionGooglePlay— A purchase through Google PlayStories— Represents a list of storiesStory— Represents a storyStoryAlbum— Describes album of storiesStoryAlbums— Represents a list of story albumsStoryArea— Describes a clickable rectangle area on a story mediaStoryAreaPosition— Describes position of a clickable rectangle area on a story mediaStoryAreaTypeLink— An area pointing to a HTTP or tg:// linkStoryAreaTypeLocation— An area pointing to a locationStoryAreaTypeMessage— An area pointing to a messageStoryAreaTypeSuggestedReaction— An area pointing to a suggested reaction. App needs to show a clickable reaction on the area and call setStoryReactio...StoryAreaTypeUpgradedGift— An area with an upgraded giftStoryAreaTypeVenue— An area pointing to a venueStoryAreaTypeWeather— An area with information about weatherStoryContentLive— A live storyStoryContentPhoto— A photo storyStoryContentTypeLive— A live storyStoryContentTypePhoto— A photo storyStoryContentTypeUnsupported— A story of unknown content typeStoryContentTypeVideo— A video storyStoryContentUnsupported— A story content that is not supported in the current TDLib versionStoryContentVideo— A video storyStoryFullId— Contains identifier of a story along with identifier of the chat that posted itStoryInfo— Contains basic information about a storyStoryInteraction— Represents interaction with a storyStoryInteractionInfo— Contains information about interactions with a storyStoryInteractions— Represents a list of interactions with a storyStoryInteractionTypeForward— A forward of the story as a messageStoryInteractionTypeRepost— A repost of the story as a storyStoryInteractionTypeView— A view of the storyStoryListArchive— The list of stories, shown in the Archive chat listStoryListMain— The list of stories, shown in the main chat list and folder chat listsStoryOriginHiddenUser— The original story was posted by an unknown userStoryOriginPublicStory— The original story was a public story that was posted by a known chatStoryPrivacySettingsCloseFriends— The story can be viewed by all close friendsStoryPrivacySettingsContacts— The story can be viewed by all contacts except chosen usersStoryPrivacySettingsEveryone— The story can be viewed by everyoneStoryPrivacySettingsSelectedUsers— The story can be viewed by certain specified usersStoryRepostInfo— Contains information about original story that was repostedStoryStatistics— A detailed statistics about a storyStoryVideo— Describes a video file posted as a storySuggestedActionAddLoginPasskey— Suggests the user to add a passkey for login using addLoginPasskeySuggestedActionCheckPassword— Suggests the user to check whether they still remember their 2-step verification passwordSuggestedActionCheckPhoneNumber— Suggests the user to check whether authorization phone number is correct and change the phone number if it is inacces...SuggestedActionConvertToBroadcastGroup— Suggests the user to convert specified supergroup to a broadcast groupSuggestedActionCustom— A custom suggestion to be shown at the top of the chat listSuggestedActionEnableArchiveAndMuteNewChats— Suggests the user to enable archive_and_mute_new_chats_from_unknown_users setting in archiveChatListSettingsSuggestedActionExtendPremium— Suggests the user to extend their expiring Telegram Premium subscriptionSuggestedActionExtendStarSubscriptions— Suggests the user to extend their expiring Telegram Star subscriptions. Call getStarSubscriptions with only_expiring ...SuggestedActionGiftPremiumForChristmas— Suggests the user to gift Telegram Premium to friends for ChristmasSuggestedActionRestorePremium— Suggests the user to restore a recently expired Premium subscriptionSuggestedActionSetBirthdate— Suggests the user to set birthdateSuggestedActionSetLoginEmailAddress— Suggests the user to add login email address. Call isLoginEmailAddressRequired, and then setLoginEmailAddress or chec...SuggestedActionSetPassword— Suggests the user to set a 2-step verification password to be able to log in againSuggestedActionSetProfilePhoto— Suggests the user to set profile photoSuggestedActionSubscribeToAnnualPremium— Suggests the user to subscribe to the Premium subscription with annual paymentsSuggestedActionUpgradePremium— Suggests the user to upgrade the Premium subscription from monthly payments to annual paymentsSuggestedActionViewChecksHint— Suggests the user to view a hint about the meaning of one and two check marks on sent messagesSuggestedPostInfo— Contains information about a suggested post. If the post can be approved or declined, then changes to the post can be...SuggestedPostPriceGram— Describes price of a suggested post in TON GramsSuggestedPostPriceStar— Describes price of a suggested post in Telegram StarsSuggestedPostRefundReasonPaymentRefunded— The post was refunded, because the payment for the post was refundedSuggestedPostRefundReasonPostDeleted— The post was refunded, because it was deleted by channel administrators in less than getOption("suggested_post_lifeti...SuggestedPostStateApproved— The post was approvedSuggestedPostStateDeclined— The post was declinedSuggestedPostStatePending— The post must be approved or declinedSupergroup— Represents a supergroup or channel with zero or more members (subscribers in the case of channels)SupergroupFullInfo— Contains full information about a supergroup or channelSupergroupMembersFilterAdministrators— Returns the owner and administratorsSupergroupMembersFilterBanned— Returns users banned from the supergroup or channel; can be used only by administratorsSupergroupMembersFilterBots— Returns bot members of the supergroup or channelSupergroupMembersFilterContacts— Returns contacts of the current user who are members of the supergroup or channelSupergroupMembersFilterMention— Returns users who can be mentioned in the supergroupSupergroupMembersFilterRecent— Returns recently active users in reverse chronological orderSupergroupMembersFilterRestricted— Returns restricted supergroup members; can be used only by administratorsSupergroupMembersFilterSearch— Used to search for supergroup or channel members via a (string) query
T¶
TargetChatChosen— The chat needs to be chosen by the user among chats of the specified typesTargetChatCurrent— The currently opened chat and forum topic must be keptTargetChatInternalLink— The chat needs to be open with the provided internal linkTargetChatTypes— Describes allowed types for the target chatTelegramPaymentPurposeGiftedStars— The user buying Telegram Stars for other usersTelegramPaymentPurposeJoinChat— The user joins a chat and subscribes to regular payments in Telegram StarsTelegramPaymentPurposePremiumGift— The user gifting Telegram Premium to another userTelegramPaymentPurposePremiumGiftCodes— The user boosting a chat by creating Telegram Premium gift codes for other usersTelegramPaymentPurposePremiumGiveaway— The user creating a Telegram Premium giveawayTelegramPaymentPurposeStarGiveaway— The user creating a Telegram Star giveawayTelegramPaymentPurposeStars— The user buying Telegram StarsTemporaryPasswordState— Returns information about the availability of a temporary password, which can be used for paymentsTermsOfService— Contains Telegram terms of serviceTestBytes— A simple object containing a sequence of bytes; for testing onlyTestInt— A simple object containing a number; for testing onlyTestString— A simple object containing a string; for testing onlyTestVectorInt— A simple object containing a vector of numbers; for testing onlyTestVectorIntObject— A simple object containing a vector of objects that hold a number; for testing onlyTestVectorString— A simple object containing a vector of strings; for testing onlyTestVectorStringObject— A simple object containing a vector of objects that hold a string; for testing onlyText— Contains some textTextCompositionStyle— Describes a style that can be used to compose a textTextCompositionStyleExample— Contains an example of text composition style usageTextEntities— Contains a list of text entitiesTextEntity— Represents a part of the text that needs to be formatted in some unusual wayTextEntityTypeBankCardNumber— A bank card number. The getBankCardInfo method can be used to get information about the bank cardTextEntityTypeBlockQuote— Text that must be formatted as if inside a blockquote HTML tag; not supported in secret chatsTextEntityTypeBold— A bold textTextEntityTypeBotCommand— A bot command, beginning with "/"TextEntityTypeCashtag— A cashtag text, beginning with "$", consisting of capital English letters (e.g., "$USD"), and optionally containing a...TextEntityTypeCode— Text that must be formatted as if inside a code HTML tagTextEntityTypeCustomEmoji— A custom emoji. The text behind a custom emoji must be an emoji. Only premium users can use premium custom emojiTextEntityTypeDateTime— A date and timeTextEntityTypeEmailAddress— An email addressTextEntityTypeExpandableBlockQuote— Text that must be formatted as if inside a blockquote HTML tag and collapsed by default to 3 lines with the ability t...TextEntityTypeHashtag— A hashtag text, beginning with "#" and optionally containing a chat username at the endTextEntityTypeItalic— An italic textTextEntityTypeMediaTimestamp— A media timestampTextEntityTypeMention— A mention of a user, a supergroup, or a channel by their usernameTextEntityTypeMentionName— A text shows instead of a raw mention of the user (e.g., when the user has no username)TextEntityTypePhoneNumber— A phone numberTextEntityTypePre— Text that must be formatted as if inside a pre HTML tagTextEntityTypePreCode— Text that must be formatted as if inside pre, and code HTML tagsTextEntityTypeSpoiler— A spoiler textTextEntityTypeStrikethrough— A strikethrough textTextEntityTypeTextUrl— A text description shown instead of a raw URLTextEntityTypeUnderline— An underlined textTextEntityTypeUrl— An HTTP URLTextParseModeHTML— The text uses HTML-style formatting. The same as Telegram Bot API "HTML" parse modeTextParseModeMarkdown— The text uses Markdown-style formattingTextQuote— Describes manually or automatically chosen quote from another messageThemeParameters— Contains parameters of the application themeThemeSettings— Describes theme settingsThumbnail— Represents a thumbnailThumbnailFormatGif— The thumbnail is in static GIF format. It will be used only for some bot inline query resultsThumbnailFormatJpeg— The thumbnail is in JPEG formatThumbnailFormatMpeg4— The thumbnail is in MPEG4 format. It will be used only for some animations and videosThumbnailFormatPng— The thumbnail is in PNG format. It will be used only for background patternsThumbnailFormatTgs— The thumbnail is in TGS format. It will be used only for sticker setsThumbnailFormatWebm— The thumbnail is in WEBM format. It will be used only for sticker setsThumbnailFormatWebp— The thumbnail is in WEBP format. It will be used only for some stickers and sticker setsTimeZone— Describes a time zoneTimeZones— Contains a list of time zonesTMeUrl— Represents a URL linking to an internal Telegram entityTMeUrls— Contains a list of t.me URLsTMeUrlTypeChatInvite— A chat invite linkTMeUrlTypeStickerSet— A URL linking to a sticker setTMeUrlTypeSupergroup— A URL linking to a public supergroup or channelTMeUrlTypeUser— A URL linking to a userTonTransaction— Represents a transaction changing the amount of owned TON GramsTonTransactions— Represents a list of TON Gram transactionsTonTransactionTypeFragmentDeposit— The transaction is a deposit of Grams from FragmentTonTransactionTypeFragmentWithdrawal— The transaction is a withdrawal of earned Grams to FragmentTonTransactionTypeGiftPurchaseOffer— The transaction is an offer of gift purchaseTonTransactionTypeStakeDicePayout— The transaction is a payment for successful stake dice throwTonTransactionTypeStakeDiceStake— The transaction is a payment for stake dice throwTonTransactionTypeSuggestedPostPayment— The transaction is a payment for a suggested postTonTransactionTypeUnsupported— The transaction is a transaction of an unsupported typeTonTransactionTypeUpgradedGiftPurchase— The transaction is a purchase of an upgraded gift for some user or channelTonTransactionTypeUpgradedGiftSale— The transaction is a sale of an upgraded giftTopChatCategoryBots— A category containing frequently used private chats with bot usersTopChatCategoryCalls— A category containing frequently used chats used for callsTopChatCategoryChannels— A category containing frequently used channelsTopChatCategoryForwardChats— A category containing frequently used chats used to forward messagesTopChatCategoryGroups— A category containing frequently used basic groups and supergroupsTopChatCategoryGuestBots— A category containing frequently used chats with bots, which were used as guest botsTopChatCategoryInlineBots— A category containing frequently used chats with inline bots sorted by their usage in inline modeTopChatCategoryUsers— A category containing frequently used private chats with non-bot usersTopChatCategoryWebAppBots— A category containing frequently used chats with bots, which Web Apps were openedTransactionDirectionIncoming— The transaction is incoming and increases the amount of owned currencyTransactionDirectionOutgoing— The transaction is outgoing and decreases the amount of owned currencyTrendingStickerSets— Represents a list of trending sticker sets
U¶
UnconfirmedSession— Contains information about an unconfirmed sessionUnreadReaction— Contains information about an unread reaction to a messageUpgradedGift— Describes an upgraded gift that can be transferred to another owner or transferred to the TON blockchain as an NFTUpgradedGiftAttributeIdBackdrop— Identifier of a gift backdropUpgradedGiftAttributeIdModel— Identifier of a gift modelUpgradedGiftAttributeIdSymbol— Identifier of a gift symbolUpgradedGiftAttributeRarityEpic— The attribute is epicUpgradedGiftAttributeRarityLegendary— The attribute is legendaryUpgradedGiftAttributeRarityPerMille— The rarity is represented as the numeric frequency of the modelUpgradedGiftAttributeRarityRare— The attribute is rareUpgradedGiftAttributeRarityUncommon— The attribute is uncommonUpgradedGiftBackdrop— Describes a backdrop of an upgraded giftUpgradedGiftBackdropColors— Describes colors of a backdrop of an upgraded giftUpgradedGiftBackdropCount— Describes a backdrop of an upgraded giftUpgradedGiftColors— Contains information about color scheme for user's name, background of empty chat photo, replies to messages and link...UpgradedGiftModel— Describes a model of an upgraded giftUpgradedGiftModelCount— Describes a model of an upgraded gift with the number of gifts foundUpgradedGiftOriginalDetails— Describes the original details about the giftUpgradedGiftOriginBlockchain— The gift was assigned from blockchain and isn't owned by the current user. The gift can't be transferred, resold or w...UpgradedGiftOriginCraft— The gift was crafted from other giftsUpgradedGiftOriginOffer— The gift was bought through an offerUpgradedGiftOriginPrepaidUpgrade— The sender or receiver of the message has paid for upgrade of the gift, which has been completedUpgradedGiftOriginResale— The gift was bought from another userUpgradedGiftOriginTransfer— The gift was transferred from another ownerUpgradedGiftOriginUpgrade— The gift was obtained by upgrading of a previously received giftUpgradedGiftSymbol— Describes a symbol shown on the pattern of an upgraded giftUpgradedGiftSymbolCount— Describes a symbol shown on the pattern of an upgraded giftUpgradedGiftValueInfo— Contains information about value of an upgraded giftUpgradeGiftResult— Contains result of gift upgradingUser— Represents a userUserAuctionBid— Describes a bid of the current user in an auctionUserFullInfo— Contains full information about a userUserLink— Contains an HTTPS URL, which can be used to get information about a userUsernames— Describes usernames assigned to a user, a supergroup, or a channelUserPrivacySettingAllowCalls— A privacy setting for managing whether the user can be calledUserPrivacySettingAllowChatInvites— A privacy setting for managing whether the user can be invited to chatsUserPrivacySettingAllowFindingByPhoneNumber— A privacy setting for managing whether the user can be found by their phone number. Checked only if the phone number ...UserPrivacySettingAllowPeerToPeerCalls— A privacy setting for managing whether peer-to-peer connections can be used for callsUserPrivacySettingAllowPrivateVoiceAndVideoNoteMessages— A privacy setting for managing whether the user can receive voice and video messages in private chats; for Telegram P...UserPrivacySettingAllowUnpaidMessages— A privacy setting for managing whether the user can receive messages without additional paymentUserPrivacySettingAutosaveGifts— A privacy setting for managing whether received gifts are automatically shown on the user's profile pageUserPrivacySettingRuleAllowAll— A rule to allow all users to do somethingUserPrivacySettingRuleAllowBots— A rule to allow all bots to do somethingUserPrivacySettingRuleAllowChatMembers— A rule to allow all members of certain specified basic groups and supergroups to doing somethingUserPrivacySettingRuleAllowContacts— A rule to allow all contacts of the user to do somethingUserPrivacySettingRuleAllowPremiumUsers— A rule to allow all Premium Users to do something; currently, allowed only for userPrivacySettingAllowChatInvitesUserPrivacySettingRuleAllowUsers— A rule to allow certain specified users to do somethingUserPrivacySettingRuleRestrictAll— A rule to restrict all users from doing somethingUserPrivacySettingRuleRestrictBots— A rule to restrict all bots from doing somethingUserPrivacySettingRuleRestrictChatMembers— A rule to restrict all members of specified basic groups and supergroups from doing somethingUserPrivacySettingRuleRestrictContacts— A rule to restrict all contacts of the user from doing somethingUserPrivacySettingRuleRestrictUsers— A rule to restrict all specified users from doing somethingUserPrivacySettingRules— A list of privacy rules. Rules are matched in the specified order. The first matched rule defines the privacy setting...UserPrivacySettingShowBio— A privacy setting for managing whether the user's bio is visibleUserPrivacySettingShowBirthdate— A privacy setting for managing whether the user's birthdate is visibleUserPrivacySettingShowLinkInForwardedMessages— A privacy setting for managing whether a link to the user's account is included in forwarded messagesUserPrivacySettingShowPhoneNumber— A privacy setting for managing whether the user's phone number is visibleUserPrivacySettingShowProfileAudio— A privacy setting for managing whether the user's profile audio files are visibleUserPrivacySettingShowProfilePhoto— A privacy setting for managing whether the user's profile photo is visibleUserPrivacySettingShowStatus— A privacy setting for managing whether the user's online status is visibleUserRating— Contains description of user ratingUsers— Represents a list of usersUserStatusEmpty— The user's status has never been changedUserStatusLastMonth— The user is offline, but was online last monthUserStatusLastWeek— The user is offline, but was online last weekUserStatusOffline— The user is offlineUserStatusOnline— The user is onlineUserStatusRecently— The user was online recentlyUserSupportInfo— Contains custom information about the userUserTypeBot— A bot (see https://core.telegram.org/bots)UserTypeDeleted— A deleted user or deleted bot. No information on the user besides the user identifier is available. It is not possibl...UserTypeRegular— A regular userUserTypeUnknown— No information on the user besides the user identifier is available, yet this user has not been deleted. This object ...
V¶
ValidatedOrderInfo— Contains a temporary identifier of validated order information, which is stored for one hour, and the available shipp...VectorPathCommandCubicBezierCurve— A cubic Bézier curve to a given pointVectorPathCommandLine— A straight line to a given pointVenue— Describes a venueVerificationStatus— Contains information about verification status of a chat or a userVideo— Describes a video fileVideoChat— Describes a video chat, i.e. a group call bound to a chatVideoMessageAdvertisement— Describes an advertisement to be shown while a video from a message is watchedVideoMessageAdvertisements— Contains a list of advertisements to be shown while a video from a message is watchedVideoNote— Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 formatVideoStoryboard— Describes a storyboard for a videoVoiceNote— Describes a voice note
W¶
WebApp— Describes a Web App. Use getInternalLink with internalLinkTypeWebApp to share the Web AppWebAppInfo— Contains information about a Web AppWebAppOpenModeCompact— The Web App is opened in the compact modeWebAppOpenModeFullScreen— The Web App is opened in the full-screen modeWebAppOpenModeFullSize— The Web App is opened in the full-size modeWebAppOpenParameters— Options to be used when a Web App is openedWebAppUrl— Contains information about a Web App URLWebBrowserSettings— Describes web browser settingsWebBrowserTypeExternal— An external web browserWebBrowserTypeInApp— The in-app browserWebDomainException— Describes an exception for built-in browser usageWebPageInstantView— Describes an instant view page for a web pageWelcomeMessage— Describes a set up welcome message