View Source API Reference ExTDLib v0.0.4
Modules
This module allow you to interact with and manage sessions.
This module was generated using Telegram's TDLib documentation. It contains 662 submodules (= structs).
Accepts an incoming call. Returns object_ptr<Ok>.
Accepts Telegram terms of services. Returns object_ptr<Ok>.
Activates stealth mode for stories, which hides all views of stories from the current user in the last "story_stealth_mode_past_period" seconds and for the next "story_stealth_mode_future_period" seconds; for Telegram Premium users only. Returns object_ptr<Ok>.
Adds server-provided application changelog as messages to the chat 777000 (Telegram) or as a stories; for official applications only. Returns a 404 error if nothing changed. Returns object_ptr<Ok>.
Adds a chat folder by an invite link. Returns object_ptr<Ok>.
Adds a new member to a chat. Members can't be added to private or secret chats. Returns object_ptr<Ok>.
Adds multiple new members to a chat. Currently, this method is only available for supergroups and channels. This method can't be used to join a chat. Members can't be added to a channel if it has more than 200 members. Returns object_ptr<Ok>.
Adds a chat to a chat list. A chat can't be simultaneously in Main and Archive chat lists, so it is automatically removed from another one if needed. Returns object_ptr<Ok>.
Adds a user to the contact list or edits an existing contact by their user identifier. Returns object_ptr<Ok>.
Adds a custom server language pack to the list of installed language packs in current localization target. Can be called before authorization. Returns object_ptr<Ok>.
Adds a new sticker to the list of favorite stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list. Emoji stickers can't be added to favorite stickers. Returns object_ptr<Ok>.
Adds a file from a message to the list of file downloads. Download progress and completion of the download will be notified through updateFile updates. If message database is used, the list of file downloads is persistent across application restarts. The downloading is independent from download using downloadFile, i.e. it continues if downloadFile is canceled or is used to download a part of the file. Returns object_ptr<File>.
Adds a local message to a chat. The message is persistent across application restarts only if the message database is used. Returns the added message. Returns object_ptr<Message>.
Adds a message to TDLib internal log. Can be called synchronously. Returns object_ptr<Ok>.
Adds a reaction to a message. Use getMessageAvailableReactions to receive the list of available reactions for the message. Returns object_ptr<Ok>.
Adds the specified data to data usage statistics. Can be called before authorization. Returns object_ptr<Ok>.
Adds a proxy server for network requests. Can be called before authorization. Returns object_ptr<Proxy>.
Manually adds a new sticker to the list of recently used stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list. Emoji stickers can't be added to recent stickers. Returns object_ptr<Stickers>.
Adds a chat to the list of recently found chats. The chat is added to the beginning of the list. If the chat is already in the list, it will be removed from the list first. Returns object_ptr<Ok>.
Manually adds a new animation to the list of saved animations. The new animation is added to the beginning of the list. If the animation was already in the list, it is removed first. Only non-secret video animations with MIME type "video/mp4" can be added to the list. Returns object_ptr<Ok>.
Adds a new notification sound to the list of saved notification sounds. The new notification sound is added to the top of the list. If it is already in the list, its position isn't changed. Returns object_ptr<NotificationSound>.
Adds a new sticker to a set; for bots only. Returns object_ptr<Ok>.
Allows the specified bot to send messages to the user. Returns object_ptr<Ok>.
Sets the result of a callback query; for bots only. Returns object_ptr<Ok>.
Answers a custom query; for bots only. Returns object_ptr<Ok>.
Sets the result of an inline query; for bots only. Returns object_ptr<Ok>.
Sets the result of a pre-checkout query; for bots only. Returns object_ptr<Ok>.
Sets the result of a shipping query; for bots only. Returns object_ptr<Ok>.
Sets the result of interaction with a Web App and sends corresponding message on behalf of the user to the chat from which the query originated; for bots only. Returns object_ptr<SentWebAppMessage>.
Applies a Telegram Premium gift code. Returns object_ptr<Ok>.
Informs server about a purchase through App Store. For official applications only. Returns object_ptr<Ok>.
Informs server about a purchase through Google Play. For official applications only. Returns object_ptr<Ok>.
Bans a member in a chat. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. Returns object_ptr<Ok>.
Blocks an original sender of a message in the Replies chat. Returns object_ptr<Ok>.
Boosts a chat and returns the list of available chat boost slots for the current user after the boost. Returns object_ptr<ChatBoostSlots>.
Checks whether the specified bot can send messages to the user. Returns a 404 error if can't and the access can be granted by call to allowBotToSendMessages. Returns object_ptr<Ok>.
Checks whether Telegram Premium purchase is possible. Must be called before in-store Premium purchase. Returns object_ptr<Ok>.
Checks whether the current user can send a story on behalf of a chat; requires can_post_stories rights for channel chats. Returns object_ptr<CanSendStoryResult>.
Checks whether the current session can be used to transfer a chat ownership to another user. Returns object_ptr<CanTransferOwnershipResult>.
Stops the downloading of a file. If a file has already been downloaded, does nothing. Returns object_ptr<Ok>.
Cancels reset of 2-step verification password. The method can be called if passwordState.pending_reset_date > 0. Returns object_ptr<Ok>.
Stops the preliminary uploading of a file. Supported only for files uploaded by using preliminaryUploadFile. For other files the behavior is undefined. Returns object_ptr<Ok>.
Changes imported contacts using the list of contacts saved on the device. Imports newly added contacts and, if at least the file database is enabled, deletes recently deleted contacts. Query result depends on the result of the previous query, so only one query is possible at the same time. Returns object_ptr<ImportedContacts>.
Changes the phone number of the user and sends an authentication code to the user's new phone number; for official Android and iOS applications only. On success, returns information about the sent code. Returns object_ptr<AuthenticationCodeInfo>.
Installs/uninstalls or activates/archives a sticker set. Returns object_ptr<Ok>.
Checks the authentication token of a bot; to log in as a bot. Works only when the current authorization state is authorizationStateWaitPhoneNumber. Can be used instead of setAuthenticationPhoneNumber and checkAuthenticationCode to log in. Returns object_ptr<Ok>.
Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode. Returns object_ptr<Ok>.
Checks the authentication of a email address. Works only when the current authorization state is authorizationStateWaitEmailCode. Returns object_ptr<Ok>.
Checks the 2-step verification password for correctness. Works only when the current authorization state is authorizationStateWaitPassword. Returns object_ptr<Ok>.
Checks whether a 2-step verification password recovery code sent to an email address is valid. Works only when the current authorization state is authorizationStateWaitPassword. Returns object_ptr<Ok>.
Checks the authentication code sent to confirm a new phone number of the user. Returns object_ptr<Ok>.
Checks the validity of an invite link for a chat folder and returns information about the corresponding chat folder. Returns object_ptr<ChatFolderInviteLinkInfo>.
Checks the validity of an invite link for a chat and returns information about the corresponding chat. Returns object_ptr<ChatInviteLinkInfo>.
Checks whether a username can be set for a chat. Returns object_ptr<CheckChatUsernameResult>.
Checks whether the maximum number of owned public chats has been reached. Returns corresponding error if the limit was reached. The limit can be increased with Telegram Premium. Returns object_ptr<Ok>.
Checks the email address verification code for Telegram Passport. Returns object_ptr<Ok>.
Checks the login email address authentication. Returns object_ptr<Ok>.
Checks whether a 2-step verification password recovery code sent to an email address is valid. Returns object_ptr<Ok>.
Checks phone number confirmation code. Returns object_ptr<Ok>.
Checks the phone number verification code for Telegram Passport. Returns object_ptr<Ok>.
Return information about a Telegram Premium gift code. Returns object_ptr<PremiumGiftCodeInfo>.
Checks the 2-step verification recovery email address verification code. Returns object_ptr<PasswordState>.
Checks whether a name can be used for a new sticker set. Returns object_ptr<CheckStickerSetNameResult>.
Removes potentially dangerous characters from the name of a file. The encoding of the file name is supposed to be UTF-8. Returns an empty string on failure. Can be called synchronously. Returns object_ptr<Text>.
Clears message drafts in all chats. Returns object_ptr<Ok>.
Clears the list of all autosave settings exceptions. The method is guaranteed to work only after at least one call to getAutosaveSettings. Returns object_ptr<Ok>.
Clears all imported contacts, contact list remains unchanged. Returns object_ptr<Ok>.
Clears the list of recently used emoji statuses. Returns object_ptr<Ok>.
Clears the list of recently used reactions. Returns object_ptr<Ok>.
Clears the list of recently used stickers. Returns object_ptr<Ok>.
Clears the list of recently found chats. Returns object_ptr<Ok>.
Informs TDLib that a message with an animated emoji was clicked by the user. Returns a big animated sticker to be played or a 404 error if usual animation needs to be played. Returns object_ptr<Sticker>.
Informs TDLib that the user opened the sponsored chat via the button, the name, the photo, or a mention in the sponsored message. Returns object_ptr<Ok>.
Informs TDLib that the user clicked Premium subscription button on the Premium features screen. Returns object_ptr<Ok>.
Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes, updateAuthorizationState with authorizationStateClosed will be sent. Can be called before initialization. Returns object_ptr<Ok>.
Informs TDLib that the chat is closed by the user. Many useful activities depend on the chat being opened or closed. Returns object_ptr<Ok>.
Closes a secret chat, effectively transferring its state to secretChatStateClosed. Returns object_ptr<Ok>.
Informs TDLib that a story is closed by the user. Returns object_ptr<Ok>.
Informs TDLib that a previously opened Web App was closed. Returns object_ptr<Ok>.
Confirms QR code authentication on another device. Returns created session on success. Returns object_ptr<Session>.
Confirms an unconfirmed session of the current user from another device. Returns object_ptr<Ok>.
Returns an existing chat corresponding to a known basic group. Returns object_ptr<Chat>.
Creates a new call. Returns object_ptr<CallId>.
Creates new chat folder. Returns information about the created chat folder. There can be up to getOption("chat_folder_count_max") chat folders, but the limit can be increased with Telegram Premium. Returns object_ptr<ChatFolderInfo>.
Creates a new invite link for a chat folder. A link can be created for a chat folder if it has only pinned and included chats. Returns object_ptr<ChatFolderInviteLink>.
Creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat. Returns object_ptr<ChatInviteLink>.
Creates a topic in a forum supergroup chat; requires can_manage_topics rights in the supergroup. Returns object_ptr<ForumTopicInfo>.
Creates a link for the given invoice; for bots only. Returns object_ptr<HttpUrl>.
Creates a new basic group and sends a corresponding messageBasicGroupChatCreate. Returns the newly created chat. Returns object_ptr<Chat>.
Creates a new secret chat. Returns the newly created chat. Returns object_ptr<Chat>.
Creates a new sticker set. Returns the newly created sticker set. Returns object_ptr<StickerSet>.
Creates a new supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created chat. Returns object_ptr<Chat>.
Returns an existing chat corresponding to a given user. Returns object_ptr<Chat>.
Returns an existing chat corresponding to a known secret chat. Returns object_ptr<Chat>.
Returns an existing chat corresponding to a known supergroup or channel. Returns object_ptr<Chat>.
Creates a new temporary password for processing payments. Returns object_ptr<TemporaryPasswordState>.
Creates a video chat (a group call bound to a chat). Available only for basic groups, supergroups and channels; requires can_manage_video_chats rights. Returns object_ptr<GroupCallId>.
Deletes the account of the current user, deleting all information associated with the user from the server. The phone number of the account can be used to create a new account. Can be called before authorization when the current authorization state is authorizationStateWaitPassword. Returns object_ptr<Ok>.
Deletes all call messages. Returns object_ptr<Ok>.
Deletes all revoked chat invite links created by a given chat administrator. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links. Returns object_ptr<Ok>.
Deletes a chat along with all messages in the corresponding chat for all chat members. For group chats this will release the usernames and remove all members. Use the field chat.can_be_deleted_for_all_users to find whether the method can be applied to the chat. Returns object_ptr<Ok>.
Deletes background in a specific chat. Returns object_ptr<Ok>.
Deletes existing chat folder. Returns object_ptr<Ok>.
Deletes an invite link for a chat folder. Returns object_ptr<Ok>.
Deletes all messages in the chat. Use chat.can_be_deleted_only_for_self and chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat. Returns object_ptr<Ok>.
Deletes all messages between the specified dates in a chat. Supported only for private chats and basic groups. Messages sent in the last 30 seconds will not be deleted. Returns object_ptr<Ok>.
Deletes all messages sent by the specified message sender in a chat. Supported only for supergroups; requires can_delete_messages administrator privileges. Returns object_ptr<Ok>.
Deletes the default reply markup from a chat. Must be called after a one-time keyboard or a replyMarkupForceReply reply markup has been used. An updateChatReplyMarkup update will be sent if the reply markup is changed. Returns object_ptr<Ok>.
Deletes commands supported by the bot for the given user scope and language; for bots only. Returns object_ptr<Ok>.
Deletes a file from the TDLib file cache. Returns object_ptr<Ok>.
Deletes all messages in a forum topic; requires can_delete_messages administrator right in the supergroup unless the user is creator of the topic, the topic has no messages from other users and has at most 11 messages. Returns object_ptr<Ok>.
Deletes all information about a language pack in the current localization target. The language pack which is currently in use (including base language pack) or is being synchronized can't be deleted. Can be called before authorization. Returns object_ptr<Ok>.
Deletes messages. Returns object_ptr<Ok>.
Deletes a Telegram Passport element. Returns object_ptr<Ok>.
Deletes a profile photo. Returns object_ptr<Ok>.
Deletes revoked chat invite links. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links. Returns object_ptr<Ok>.
Deletes saved credentials for all payment provider bots. Returns object_ptr<Ok>.
Deletes saved order information. Returns object_ptr<Ok>.
Deleted a sticker set; for bots only. Returns object_ptr<Ok>.
Deletes a previously sent story. Can be called only if story.can_be_deleted == true. Returns object_ptr<Ok>.
Closes the TDLib instance, destroying all local data without a proper logout. The current user session will remain in the list of all active sessions. All local data will be destroyed. After the destruction completes updateAuthorizationState with authorizationStateClosed will be sent. Can be called before authorization. Returns object_ptr<Ok>.
Disables all active non-editable usernames of a supergroup or channel, requires owner privileges in the supergroup or channel. Returns object_ptr<Ok>.
Disables the currently enabled proxy. Can be called before authorization. Returns object_ptr<Ok>.
Discards a call. Returns object_ptr<Ok>.
Disconnects all websites from the current user's Telegram account. Returns object_ptr<Ok>.
Disconnects website from the current user's Telegram account. Returns object_ptr<Ok>.
Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates. Returns object_ptr<File>.
Edits existing chat folder. Returns information about the edited chat folder. Returns object_ptr<ChatFolderInfo>.
Edits an invite link for a chat folder. Returns object_ptr<ChatFolderInviteLink>.
Edits a non-primary invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links. Returns object_ptr<ChatInviteLink>.
Edits information about a custom local language pack in the current localization target. Can be called before authorization. Returns object_ptr<Ok>.
Edits title and icon of a topic in a forum supergroup chat; requires can_manage_topics administrator right in the supergroup unless the user is creator of the topic. Returns object_ptr<Ok>.
Edits the caption of an inline message sent via a bot; for bots only. Returns object_ptr<Ok>.
Edits the content of a live location in an inline message sent via a bot; for bots only. Returns object_ptr<Ok>.
Edits the content of a message with an animation, an audio, a document, a photo or a video in an inline message sent via a bot; for bots only. Returns object_ptr<Ok>.
Edits the reply markup of an inline message sent via a bot; for bots only. Returns object_ptr<Ok>.
Edits the text of an inline text or game message sent via a bot; for bots only. Returns object_ptr<Ok>.
Edits the message content caption. Returns the edited message after the edit is completed on the server side. Returns object_ptr<Message>.
Edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location. Returns the edited message after the edit is completed on the server side. Returns object_ptr<Message>.
Edits the content of a message with an animation, an audio, a document, a photo or a video, including message caption. If only the caption needs to be edited, use editMessageCaption instead. The media can't be edited if the message was set to self-destruct or to a self-destructing media. The type of message content in an album can't be changed with exception of replacing a photo with a video or vice versa. Returns the edited message after the edit is completed on the server side. Returns object_ptr<Message>.
Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side. Returns object_ptr<Message>.
Edits the time when a scheduled message will be sent. Scheduling state of all messages in the same album or forwarded together with the message will be also changed. Returns object_ptr<Ok>.
Edits the text of a message (or a text of a game message). Returns the edited message after the edit is completed on the server side. Returns object_ptr<Message>.
Edits an existing proxy server for network requests. Can be called before authorization. Returns object_ptr<Proxy>.
Changes content and caption of a story. Can be called only if story.can_be_edited == true. Returns object_ptr<Ok>.
Enables a proxy. Only one proxy can be enabled at a time. Can be called before authorization. Returns object_ptr<Ok>.
Ends a group call. Requires groupCall.can_be_managed. Returns object_ptr<Ok>.
Ends recording of an active group call. Requires groupCall.can_be_managed group call flag. Returns object_ptr<Ok>.
Ends screen sharing in a joined group call. Returns object_ptr<Ok>.
Finishes the file generation. Returns object_ptr<Ok>.
Forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed in message_ids. If a message can't be forwarded, null will be returned instead of the message. Returns object_ptr<Messages>.
Returns the period of inactivity after which the account of the current user will automatically be deleted. Returns object_ptr<AccountTtl>.
Returns all active live locations that need to be updated by the application. The list is persistent across application restarts only if the message database is used. Returns object_ptr<Messages>.
Returns all active sessions of the current user. Returns object_ptr<Sessions>.
Returns all available Telegram Passport elements. Returns object_ptr<PassportElements>.
Returns unique emoji that correspond to stickers to be found by the getStickers(sticker_type, query, 1000000, chat_id). Returns object_ptr<Emojis>.
Returns an animated emoji corresponding to a given emoji. Returns a 404 error if the emoji has no animated emoji. Returns object_ptr<AnimatedEmoji>.
Returns application config, provided by the server. Can be called before authorization. Returns object_ptr<JsonValue>.
Returns the link for downloading official Telegram application to be used when the current user invites friends to Telegram. Returns object_ptr<HttpUrl>.
Returns settings for automatic moving of chats to and from the Archive chat lists. Returns object_ptr<ArchiveChatListSettings>.
Returns a list of archived sticker sets. Returns object_ptr<StickerSets>.
Returns a list of sticker sets attached to a file, including regular, mask, and emoji sticker sets. Currently, only animations, photos, and videos can have attached sticker sets. Returns object_ptr<StickerSets>.
Returns information about a bot that can be added to attachment or side menu. Returns object_ptr<AttachmentMenuBot>.
Returns the current authorization state; this is an offline request. For informational purposes only. Use updateAuthorizationState instead to maintain the current authorization state. Can be called before initialization. Returns object_ptr<AuthorizationState>.
Returns auto-download settings presets for the current user. Returns object_ptr<AutoDownloadSettingsPresets>.
Returns autosave settings for the current user. Returns object_ptr<AutosaveSettings>.
Returns the list of available chat boost slots for the current user. Returns object_ptr<ChatBoostSlots>.
Constructs a persistent HTTP URL for a background. Returns object_ptr<HttpUrl>.
Returns backgrounds installed by the user. Returns object_ptr<Backgrounds>.
Returns information about a bank card. Returns object_ptr<BankCardInfo>.
Returns information about a basic group by its identifier. This is an offline request if the current user is not a bot. Returns object_ptr<BasicGroup>.
Returns full information about a basic group by its identifier. Returns object_ptr<BasicGroupFullInfo>.
Returns users and chats that were blocked by the current user. Returns object_ptr<MessageSenders>.
Returns the text shown in the chat with a bot if the chat is empty in the given language. Can be called only if userTypeBot.can_be_edited == true. Returns object_ptr<Text>.
Returns the text shown on a bot's profile page and sent together with the link when users share the bot in the given language. Can be called only if userTypeBot.can_be_edited == true. Returns object_ptr<Text>.
Returns the name of a bot in the given language. Can be called only if userTypeBot.can_be_edited == true. Returns object_ptr<Text>.
Sends a callback query to a bot and returns an answer. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires. Returns object_ptr<CallbackQueryAnswer>.
Returns information about a message with the callback button that originated a callback query; for bots only. Returns object_ptr<Message>.
Returns information about a chat by its identifier; this is an offline request if the current user is not a bot. Returns object_ptr<Chat>.
Returns the list of active stories posted by the given chat. Returns object_ptr<ChatActiveStories>.
Returns a list of administrators of the chat with their custom titles. Returns object_ptr<ChatAdministrators>.
Returns the list of all stories posted by the given chat; requires can_edit_stories rights for channel chats. The stories are returned in a reverse chronological order (i.e., in order of decreasing story_id). For optimal performance, the number of returned stories is chosen by TDLib. Returns object_ptr<Stories>.
Returns list of message sender identifiers, which can be used to send messages in a chat. Returns object_ptr<ChatMessageSenders>.
Returns an HTTPS link to boost the specified channel chat. Returns object_ptr<ChatBoostLink>.
Returns information about a link to boost a chat. Can be called for any internal link of the type internalLinkTypeChatBoost. Returns object_ptr<ChatBoostLinkInfo>.
Returns the current boost status for a channel chat. Returns object_ptr<ChatBoostStatus>.
Returns list of boosts applied to a chat; requires administrator rights in the channel chat. Returns object_ptr<FoundChatBoosts>.
Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only for supergroups and channels. Requires administrator rights. Returns results in reverse chronological order (i.e., in order of decreasing event_id). Returns object_ptr<ChatEvents>.
Returns information about a chat folder by its identifier. Returns object_ptr<ChatFolder>.
Returns approximate number of chats in a being created chat folder. Main and archive chat lists must be fully preloaded for this function to work correctly. Returns object_ptr<Count>.
Returns identifiers of pinned or always included chats from a chat folder, which are suggested to be left when the chat folder is deleted. Returns object_ptr<Chats>.
Returns default icon name for a folder. Can be called synchronously. Returns object_ptr<ChatFolderIcon>.
Returns invite links created by the current user for a shareable chat folder. Returns object_ptr<ChatFolderInviteLinks>.
Returns new chats added to a shareable chat folder by its owner. The method must be called at most once in getOption("chat_folder_new_chats_update_period") for the given chat folder. Returns object_ptr<Chats>.
Returns messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib. This is an offline request if only_local is true. Returns object_ptr<Messages>.
Returns information about an invite link. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links. Returns object_ptr<ChatInviteLink>.
Returns list of chat administrators with number of their invite links. Requires owner privileges in the chat. Returns object_ptr<ChatInviteLinkCounts>.
Returns chat members joined a chat via an invite link. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links. Returns object_ptr<ChatInviteLinkMembers>.
Returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links. Returns object_ptr<ChatInviteLinks>.
Returns pending join requests in a chat. Returns object_ptr<ChatJoinRequests>.
Returns chat lists to which the chat can be added. This is an offline request. Returns object_ptr<ChatLists>.
Returns information about a single member of a chat. Returns object_ptr<ChatMember>.
Returns the last message sent in a chat no later than the specified date. Returns object_ptr<Message>.
Returns information about the next messages of the specified type in the chat split by days. Returns the results in reverse chronological order. Can return partial result for the last returned day. Behavior of this method depends on the value of the option "utc_time_offset". Returns object_ptr<MessageCalendar>.
Returns approximate number of messages of the specified type in the chat. Returns object_ptr<Count>.
Returns approximate 1-based position of a message among messages, which can be found by the specified filter in the chat. Cannot be used in secret chats. Returns object_ptr<Count>.
Returns list of chats with non-default notification settings for new messages. Returns object_ptr<Chats>.
Returns information about a newest pinned message in the chat. Returns object_ptr<Message>.
Returns the list of pinned stories posted by the given chat. The stories are returned in a reverse chronological order (i.e., in order of decreasing story_id). For optimal performance, the number of returned stories is chosen by TDLib. Returns object_ptr<Stories>.
Returns all scheduled messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). Returns object_ptr<Messages>.
Returns approximate number of chats similar to the given chat. Returns object_ptr<Count>.
Returns a list of chats similar to the given chat. Returns object_ptr<Chats>.
Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). Cannot be used in secret chats or with searchMessagesFilterFailedToSend filter without an enabled message database. Returns object_ptr<MessagePositions>.
Returns sponsored messages to be shown in a chat; for channel chats only. Returns object_ptr<SponsoredMessages>.
Returns detailed statistics about a chat. Currently, this method can be used only for supergroups and channels. Can be used only if supergroupFullInfo.can_get_statistics == true. Returns object_ptr<ChatStatistics>.
Returns an ordered list of chats from the beginning of a chat list. For informational purposes only. Use loadChats and updates processing instead to maintain chat lists in a consistent state. Returns object_ptr<Chats>.
Returns identifiers of chats from a chat folder, suitable for adding to a chat folder invite link. Returns object_ptr<Chats>.
Returns channel chats in which the current user has the right to post stories. The chats must be rechecked with canSendStory before actually trying to post a story there. Returns object_ptr<Chats>.
Returns all close friends of the current user. Returns object_ptr<Users>.
Returns list of commands supported by the bot for the given user scope and language; for bots only. Returns object_ptr<BotCommands>.
Returns all website where the current user used Telegram to log in. Returns object_ptr<ConnectedWebsites>.
Returns all contacts of the user. Returns object_ptr<Users>.
Returns information about existing countries. Can be called before authorization. Returns object_ptr<Countries>.
Uses the current IP address to find the current country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be called before authorization. Returns object_ptr<Text>.
Returns a list of public chats of the specified type, owned by the user. Returns object_ptr<Chats>.
Returns all updates needed to restore current TDLib state, i.e. all actual updateAuthorizationState/updateUser/updateNewChat and others. This is especially useful if TDLib is run in a separate process. Can be called before initialization. Returns object_ptr<Updates>.
Returns TGS stickers with generic animations for custom emoji reactions. Returns object_ptr<Stickers>.
Returns list of custom emoji stickers by their identifiers. Stickers are returned in arbitrary order. Only found stickers are returned. Returns object_ptr<Stickers>.
Returns database statistics. Returns object_ptr<DatabaseStatistics>.
Returns information about a tg:// deep link. Use "tg://need_update_for_some_feature" or "tg:some_unsupported_feature" for testing. Returns a 404 error for unknown links. Can be called before authorization. Returns object_ptr<DeepLinkInfo>.
Returns default list of custom emoji stickers for reply background. Returns object_ptr<Stickers>.
Returns default list of custom emoji stickers for placing on a chat photo. Returns object_ptr<Stickers>.
Returns default emoji statuses. Returns object_ptr<EmojiStatuses>.
Returns default message auto-delete time setting for new chats. Returns object_ptr<MessageAutoDeleteTime>.
Returns default list of custom emoji stickers for placing on a profile photo. Returns object_ptr<Stickers>.
Returns available emojis categories. Returns object_ptr<EmojiCategories>.
Returns information about a emoji reaction. Returns a 404 error if the reaction is not found. Returns object_ptr<EmojiReaction>.
Returns an HTTP URL which can be used to automatically log in to the translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation. Returns object_ptr<HttpUrl>.
Returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP link. Use the method getExternalLinkInfo to find whether a prior user confirmation is needed. Returns object_ptr<HttpUrl>.
Returns information about an action to be done when the current user clicks an external link. Don't use this method for links from secret chats if web page preview is disabled in secret chats. Returns object_ptr<LoginUrlInfo>.
Returns favorite stickers. Returns object_ptr<Stickers>.
Returns information about a file; this is an offline request. Returns object_ptr<File>.
Returns file downloaded prefix size from a given offset, in bytes. Returns object_ptr<FileDownloadedPrefixSize>.
Returns the extension of a file, guessed by its MIME type. Returns an empty string on failure. Can be called synchronously. Returns object_ptr<Text>.
Returns the MIME type of a file, guessed by its extension. Returns an empty string on failure. Can be called synchronously. Returns object_ptr<Text>.
Returns information about a forum topic. Returns object_ptr<ForumTopic>.
Returns list of custom emojis, which can be used as forum topic icon by all users. Returns object_ptr<Stickers>.
Returns an HTTPS link to a topic in a forum chat. This is an offline request. Returns object_ptr<MessageLink>.
Returns found forum topics in a forum chat. This is a temporary method for getting information about topic list from the server. Returns object_ptr<ForumTopics>.
Returns the high scores for a game and some part of the high score table in the range of the specified user; for bots only. Returns object_ptr<GameHighScores>.
Returns information about a group call. Returns object_ptr<GroupCall>.
Returns invite link to a video chat in a public chat. Returns object_ptr<HttpUrl>.
Returns a file with a segment of a group call stream in a modified OGG format for audio or MPEG-4 format for video. Returns object_ptr<FilePart>.
Returns information about available group call streams. Returns object_ptr<GroupCallStreams>.
Returns a list of common group chats with a given user. Chats are sorted by their type and creation date. Returns object_ptr<Chats>.
Returns the total number of imported contacts. Returns object_ptr<Count>.
Returns a list of recently inactive supergroups and channels. Can be used when user reaches limit on the number of joined supergroups and channels and receives CHANNELS_TOO_MUCH error. Also, the limit can be increased with Telegram Premium. Returns object_ptr<Chats>.
Returns game high scores and some part of the high score table in the range of the specified user; for bots only. Returns object_ptr<GameHighScores>.
Sends an inline query to a bot and returns its results. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires. Returns object_ptr<InlineQueryResults>.
Returns a list of installed sticker sets. Returns object_ptr<StickerSets>.
Returns an HTTPS or a tg: link with the given type. Can be called before authorization. Returns object_ptr<HttpUrl>.
Returns information about the type of an internal link. Returns a 404 error if the link is not internal. Can be called before authorization. Returns object_ptr<InternalLinkType>.
Converts a JsonValue object to corresponding JSON-serialized string. Can be called synchronously. Returns object_ptr<Text>.
Converts a JSON-serialized string to corresponding JsonValue object. Can be called synchronously. Returns object_ptr<JsonValue>.
Returns information about a language pack. Returned language pack identifier may be different from a provided one. Can be called before authorization. Returns object_ptr<LanguagePackInfo>.
Returns a string stored in the local database from the specified localization target and language pack by its key. Returns a 404 error if the string is not found. Can be called synchronously. Returns object_ptr<LanguagePackStringValue>.
Returns strings from a language pack in the current localization target by their keys. Can be called before authorization. Returns object_ptr<LanguagePackStrings>.
Returns information about the current localization target. This is an offline request if only_local is true. Can be called before authorization. Returns object_ptr<LocalizationTargetInfo>.
Returns information about currently used log stream for internal logging of TDLib. Can be called synchronously. Returns object_ptr<LogStream>.
Returns current verbosity level for a specified TDLib internal log tag. Can be called synchronously. Returns object_ptr<LogVerbosityLevel>.
Returns list of available TDLib internal log tags, for example, ["actor", "binlog", "connections", "notifications", "proxy"]. Can be called synchronously. Returns object_ptr<LogTags>.
Returns current verbosity level of the internal logging of TDLib. Can be called synchronously. Returns object_ptr<LogVerbosityLevel>.
Returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button. Returns object_ptr<HttpUrl>.
Returns information about a button of type inlineKeyboardButtonTypeLoginUrl. The method needs to be called when the user presses the button. Returns object_ptr<LoginUrlInfo>.
Returns information about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB can be downloaded. Returns object_ptr<File>.
Replaces text entities with Markdown formatting in a human-friendly format. Entities that can't be represented in Markdown unambiguously are kept as is. Can be called synchronously. Returns object_ptr<FormattedText>.
Returns the current user. Returns object_ptr<User>.
Returns menu button set by the bot for the given user; for bots only. Returns object_ptr<BotMenuButton>.
Returns information about a message. Returns object_ptr<Message>.
Returns reactions added for a message, along with their sender. Returns object_ptr<AddedReactions>.
Returns reactions, which can be added to a message. The list can change after updateActiveEmojiReactions, updateChatAvailableReactions for the chat, or updateMessageInteractionInfo for the message. Returns object_ptr<AvailableReactions>.
Returns an HTML code for embedding the message. Available only for messages in supergroups and channels with a username. Returns object_ptr<Text>.
Returns information about a file with messages exported from another application. Returns object_ptr<MessageFileType>.
Returns a confirmation text to be shown to the user before starting message import. Returns object_ptr<Text>.
Returns an HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels, or if message.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline request. Returns object_ptr<MessageLink>.
Returns information about a public or private message link. Can be called for any internal link of the type internalLinkTypeMessage. Returns object_ptr<MessageLinkInfo>.
Returns information about a message, if it is available without sending network request. This is an offline request. Returns object_ptr<Message>.
Returns forwarded copies of a channel message to different public channels. Can be used only if message.can_get_statistics == true. For optimal performance, the number of returned messages is chosen by TDLib. Returns object_ptr<FoundMessages>.
Returns detailed statistics about a message. Can be used only if message.can_get_statistics == true. Returns object_ptr<MessageStatistics>.
Returns information about a message thread. Can be used only if message.can_get_message_thread == true. Returns object_ptr<MessageThreadInfo>.
Returns messages in a message thread of a message. Can be used only if message.can_get_message_thread == true. Message thread of a channel message is in the channel's linked supergroup. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib. Returns object_ptr<Messages>.
Returns viewers of a recent outgoing message in a basic group or a supergroup chat. For video notes and voice notes only users, opened content of the message, are returned. The method can be called if message.can_get_viewers == true. Returns object_ptr<MessageViewers>.
Returns information about messages. If a message is not found, returns null on the corresponding position of the result. Returns object_ptr<Messages>.
Returns network data usage statistics. Can be called before authorization. Returns object_ptr<NetworkStatistics>.
Returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization. Can be called synchronously for options "version" and "commit_hash". Returns object_ptr<OptionValue>.
Returns a Telegram Passport authorization form for sharing data with a service. Returns object_ptr<PassportAuthorizationForm>.
Returns already available Telegram Passport elements suitable for completing a Telegram Passport authorization form. Result can be received only once for each authorization form. Returns object_ptr<PassportElementsWithErrors>.
Returns one of the available Telegram Passport elements. Returns object_ptr<PassportElement>.
Returns the current state of 2-step verification. Returns object_ptr<PasswordState>.
Returns an invoice payment form. This method must be called when the user presses inline button of the type inlineKeyboardButtonTypeBuy. Returns object_ptr<PaymentForm>.
Returns information about a successful payment. Returns object_ptr<PaymentReceipt>.
Returns information about a phone number by its prefix. Can be called before authorization. Returns object_ptr<PhoneNumberInfo>.
Returns information about a phone number by its prefix synchronously. getCountries must be called at least once after changing localization to the specified language if properly localized country information is expected. Can be called synchronously. Returns object_ptr<PhoneNumberInfo>.
Returns message senders voted for the specified option in a non-anonymous polls. For optimal performance, the number of returned users is chosen by TDLib. Returns object_ptr<MessageSenders>.
Returns an IETF language tag of the language preferred in the country, which must be used to fill native fields in Telegram Passport personal details. Returns a 404 error if unknown. Returns object_ptr<Text>.
Returns information about features, available to Premium users. Returns object_ptr<PremiumFeatures>.
Returns available options for Telegram Premium gift code or giveaway creation. Returns object_ptr<PremiumGiftCodePaymentOptions>.
Returns information about a Telegram Premium giveaway. Returns object_ptr<PremiumGiveawayInfo>.
Returns information about a limit, increased for Premium users. Returns a 404 error if the limit is unknown. Returns object_ptr<PremiumLimit>.
Returns state of Telegram Premium subscription and promotion videos for Premium features. Returns object_ptr<PremiumState>.
Returns examples of premium stickers for demonstration purposes. Returns object_ptr<Stickers>.
Returns premium stickers from regular sticker sets. Returns object_ptr<Stickers>.
Returns list of proxies that are currently set up. Can be called before authorization. Returns object_ptr<Proxies>.
Returns an HTTPS link, which can be used to add a proxy. Available only for SOCKS5 and MTProto proxies. Can be called before authorization. Returns object_ptr<HttpUrl>.
Returns a globally unique push notification subscription identifier for identification of an account, which has received a push notification. Can be called synchronously. Returns object_ptr<PushReceiverId>.
Returns recent emoji statuses. Returns object_ptr<EmojiStatuses>.
Returns up to 20 recently used inline bots in the order of their last usage. Returns object_ptr<Users>.
Returns a list of recently used stickers. Returns object_ptr<Stickers>.
Returns recently opened chats; this is an offline request. Returns chats in the order of last opening. Returns object_ptr<Chats>.
Returns t.me URLs recently visited by a newly registered user. Returns object_ptr<TMeUrls>.
Returns recommended chat folders for the current user. Returns object_ptr<RecommendedChatFolders>.
Returns a 2-step verification recovery email address that was previously set up. This method can be used to verify a password provided by the user. Returns object_ptr<RecoveryEmailAddress>.
Returns information about a file by its remote identifier; this is an offline request. Can be used to register a URL as a file for further uploading, or sending as a message. Even the request succeeds, the file can be used only if it is still accessible to the user. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the application. Returns object_ptr<File>.
Returns information about a non-bundled message that is replied by a given message. Also, returns the pinned message, the game message, the invoice message, the message with a previously set same background, the giveaway message, and the topic creation message for messages of the types messagePinMessage, messageGameScore, messagePaymentSuccessful, messageChatSetBackground, messagePremiumGiveawayCompleted and topic messages without non-bundled replied message respectively. Returns object_ptr<Message>.
Returns saved animations. Returns object_ptr<Animations>.
Returns saved notification sound by its identifier. Returns a 404 error if there is no saved notification sound with the specified identifier. Returns object_ptr<NotificationSounds>.
Returns list of saved notification sounds. If a sound isn't in the list, then default sound needs to be used. Returns object_ptr<NotificationSounds>.
Returns saved order information. Returns a 404 error if there is no saved order information. Returns object_ptr<OrderInfo>.
Returns the notification settings for chats of a given type. Returns object_ptr<ScopeNotificationSettings>.
Returns information about a secret chat by its identifier. This is an offline request. Returns object_ptr<SecretChat>.
Loads an asynchronous or a zoomed in statistical graph. Returns object_ptr<StatisticalGraph>.
Returns emoji corresponding to a sticker. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object. Returns object_ptr<Emojis>.
Returns information about a sticker set by its identifier. Returns object_ptr<StickerSet>.
Returns stickers from the installed sticker sets that correspond to any of the given emoji or can be found by sticker-specific keywords. If the query is non-empty, then favorite, recently used or trending stickers may also be returned. Returns object_ptr<Stickers>.
Returns storage usage statistics. Can be called before authorization. Returns object_ptr<StorageStatistics>.
Quickly returns approximate storage usage statistics. Can be called before authorization. Returns object_ptr<StorageStatisticsFast>.
Returns a story. Returns object_ptr<Story>.
Returns reactions, which can be chosen for a story. Returns object_ptr<AvailableReactions>.
Returns list of chats with non-default notification settings for stories. Returns object_ptr<Chats>.
Returns forwards of a story as a message to public chats and reposts by public channels. Can be used only if the story is posted on behalf of the current user or story.can_get_statistics == true. For optimal performance, the number of returned messages and stories is chosen by TDLib. Returns object_ptr<StoryPublicForwards>.
Returns detailed statistics about a story. Can be used only if story.can_get_statistics == true. Returns object_ptr<StoryStatistics>.
Returns viewers of a story. The method can be called only for stories posted on behalf of the current user. Returns object_ptr<StoryViewers>.
Returns suggested name for saving a file in a given directory. Returns object_ptr<Text>.
Returns a suggested name for a new sticker set with a given title. Returns object_ptr<Text>.
Returns a list of basic group and supergroup chats, which can be used as a discussion group for a channel. Returned basic group chats must be first upgraded to supergroups before they can be set as a discussion group. To set a returned supergroup as a discussion group, access to its old messages must be enabled using toggleSupergroupIsAllHistoryAvailable first. Returns object_ptr<Chats>.
Returns information about a supergroup or a channel by its identifier. This is an offline request if the current user is not a bot. Returns object_ptr<Supergroup>.
Returns full information about a supergroup or a channel by its identifier, cached for up to 1 minute. Returns object_ptr<SupergroupFullInfo>.
Returns information about members or banned users in a supergroup or channel. Can be used only if supergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters. Returns object_ptr<ChatMembers>.
Returns localized name of the Telegram support user; for Telegram support only. Returns object_ptr<Text>.
Returns a user that can be contacted to get support. Returns object_ptr<User>.
Returns information about the current temporary password. Returns object_ptr<TemporaryPasswordState>.
Returns all entities (mentions, hashtags, cashtags, bot commands, bank card numbers, URLs, and email addresses) found in the text. Can be called synchronously. Returns object_ptr<TextEntities>.
Converts a themeParameters object to corresponding JSON-serialized string. Can be called synchronously. Returns object_ptr<Text>.
Returns up to 8 emoji statuses, which must be shown right after the default Premium Badge in the emoji status list. Returns object_ptr<EmojiStatuses>.
Returns a list of frequently used chats. Returns object_ptr<Chats>.
Returns a list of trending sticker sets. For optimal performance, the number of returned sticker sets is chosen by TDLib. Returns object_ptr<TrendingStickerSets>.
Returns information about a user by their identifier. This is an offline request if the current user is not a bot. Returns object_ptr<User>.
Returns list of boosts applied to a chat by a given user; requires administrator rights in the channel chat; for bots only. Returns object_ptr<FoundChatBoosts>.
Returns full information about a user by their identifier. Returns object_ptr<UserFullInfo>.
Returns an HTTPS link, which can be used to get information about the current user. Returns object_ptr<UserLink>.
Returns the current privacy settings. Returns object_ptr<UserPrivacySettingRules>.
Returns the profile photos of a user. Personal and public photo aren't returned. Returns object_ptr<ChatPhotos>.
Returns support information for the given user; for Telegram support only. Returns object_ptr<UserSupportInfo>.
Returns list of participant identifiers, on whose behalf a video chat in the chat can be joined. Returns object_ptr<MessageSenders>.
Returns RTMP URL for streaming to the chat; requires creator privileges. Returns object_ptr<RtmpUrl>.
Returns an HTTPS URL of a Web App to open after a link of the type internalLinkTypeWebApp is clicked. Returns object_ptr<HttpUrl>.
Returns an HTTPS URL of a Web App to open from the side menu, a keyboardButtonTypeWebApp button, an inlineQueryResultsButtonTypeWebApp button, or an internalLinkTypeSideMenuBot link. Returns object_ptr<HttpUrl>.
Returns an instant view version of a web page if available. Returns a 404 error if the web page has no instant view page. Returns object_ptr<WebPageInstantView>.
Returns a link preview by the text of a message. Do not call this function too often. Returns a 404 error if the text has no link preview. Returns object_ptr<WebPage>.
Hides a suggested action. Returns object_ptr<Ok>.
Adds new contacts or edits existing contacts by their phone numbers; contacts' user identifiers are ignored. Returns object_ptr<ImportedContacts>.
Imports messages exported from another app. Returns object_ptr<Ok>.
Invites users to an active group call. Sends a service message of type messageInviteVideoChatParticipants for video chats. Returns object_ptr<Ok>.
Adds the current user as a new member to a chat. Private and secret chats can't be joined using this method. May return an error with a message "INVITE_REQUEST_SENT" if only a join request was created. Returns object_ptr<Ok>.
Uses an invite link to add the current user to the chat if possible. May return an error with a message "INVITE_REQUEST_SENT" if only a join request was created. Returns object_ptr<Chat>.
Joins an active group call. Returns join response payload for tgcalls. Returns object_ptr<Text>.
Launches a prepaid Telegram Premium giveaway for subscribers of channel chats; requires can_post_messages rights in the channels. Returns object_ptr<Ok>.
Removes the current user from chat members. Private and secret chats can't be left using this method. Returns object_ptr<Ok>.
Leaves a group call. Returns object_ptr<Ok>.
Loads more active stories from a story list. The loaded stories will be sent through updates. Active stories are sorted by the pair (active_stories.order, active_stories.story_sender_chat_id) in descending order. Returns a 404 error if all active stories have been loaded. Returns object_ptr<Ok>.
Loads more chats from a chat list. The loaded chats and their positions in the chat list will be sent through updates. Chats are sorted by the pair (chat.position.order, chat.id) in descending order. Returns a 404 error if all chats have been loaded. Returns object_ptr<Ok>.
Loads more participants of a group call. The loaded participants will be received through updates. Use the field groupCall.loaded_all_participants to check whether all participants have already been loaded. Returns object_ptr<Ok>.
Closes the TDLib instance after a proper logout. Requires an available network connection. All local data will be destroyed. After the logout completes, updateAuthorizationState with authorizationStateClosed will be sent. Returns object_ptr<Ok>.
Informs TDLib that the chat is opened by the user. Many useful activities depend on the chat being opened or closed (e.g., in supergroups and channels all updates are received only for opened chats). Returns object_ptr<Ok>.
Informs TDLib that the message content has been opened (e.g., the user has opened a photo, video, document, location or venue, or has listened to an audio file or voice note message). An updateMessageContentOpened update will be generated if something has changed. Returns object_ptr<Ok>.
Informs TDLib that a story is opened and is being viewed by the user. Returns object_ptr<Ok>.
Informs TDLib that a Web App is being opened from the attachment menu, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an inlineKeyboardButtonTypeWebApp button. For each bot, a confirmation alert about data sent to the bot must be shown once. Returns object_ptr<WebAppInfo>.
Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted. Returns object_ptr<StorageStatistics>.
Parses Markdown entities in a human-friendly format, ignoring markup errors. Can be called synchronously. Returns object_ptr<FormattedText>.
Parses Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, BlockQuote, Code, Pre, PreCode, TextUrl and MentionName entities from a marked-up text. Can be called synchronously. Returns object_ptr<FormattedText>.
Pins a message in a chat; requires can_pin_messages rights or can_edit_messages rights in the channel. Returns object_ptr<Ok>.
Computes time needed to receive a response from a Telegram server through a proxy. Can be called before authorization. Returns object_ptr<Seconds>.
Preliminary uploads a file to the cloud before sending it in a message, which can be useful for uploading of being recorded voice and video notes. Updates updateFile will be used to notify about upload progress and successful completion of the upload. The file will not have a persistent remote identifier until it is sent in a message. Returns object_ptr<File>.
Process new chats added to a shareable chat folder by its owner. Returns object_ptr<Ok>.
Handles a pending join request in a chat. Returns object_ptr<Ok>.
Handles all pending join requests for a given link in a chat. Returns object_ptr<Ok>.
Handles a push notification. Returns error with code 406 if the push notification is not supported and connection to the server is required to fetch new data. Can be called before authorization. Returns object_ptr<Ok>.
Rates recognized speech in a video note or a voice note message. Returns object_ptr<Ok>.
Marks all mentions in a chat as read. Returns object_ptr<Ok>.
Marks all reactions in a chat or a forum topic as read. Returns object_ptr<Ok>.
Marks all mentions in a forum topic as read. Returns object_ptr<Ok>.
Marks all reactions in a forum topic as read. Returns object_ptr<Ok>.
Traverse all chats in a chat list and marks all messages in the chats as read. Returns object_ptr<Ok>.
Reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if the application has no direct access to TDLib's file system, because it is usually slower than a direct read from the file. Returns object_ptr<FilePart>.
Recognizes speech in a video note or a voice note message. The message must be successfully sent, must not be scheduled, and must be from a non-secret chat. Returns object_ptr<Ok>.
Recovers the 2-step verification password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword. Returns object_ptr<Ok>.
Recovers the 2-step verification password using a recovery code sent to an email address that was previously set up. Returns object_ptr<PasswordState>.
Registers the currently used device for receiving push notifications. Returns a globally unique identifier of the push notification subscription. Returns object_ptr<PushReceiverId>.
Finishes user registration. Works only when the current authorization state is authorizationStateWaitRegistration. Returns object_ptr<Ok>.
Removes all files from the file download list. Returns object_ptr<Ok>.
Removes background from the list of installed backgrounds. Returns object_ptr<Ok>.
Removes a chat action bar without any other action. Returns object_ptr<Ok>.
Removes users from the contact list. Returns object_ptr<Ok>.
Removes a sticker from the list of favorite stickers. Returns object_ptr<Ok>.
Removes a file from the file download list. Returns object_ptr<Ok>.
Removes a reaction from a message. A chosen reaction can always be removed. Returns object_ptr<Ok>.
Removes an active notification from notification list. Needs to be called only if the notification is removed by the current user. Returns object_ptr<Ok>.
Removes a group of active notifications. Needs to be called only if the notification group is removed by the current user. Returns object_ptr<Ok>.
Removes a proxy server. Can be called before authorization. Returns object_ptr<Ok>.
Removes a hashtag from the list of recently used hashtags. Returns object_ptr<Ok>.
Removes a sticker from the list of recently used stickers. Returns object_ptr<Ok>.
Removes a chat from the list of recently found chats. Returns object_ptr<Ok>.
Removes an animation from the list of saved animations. Returns object_ptr<Ok>.
Removes a notification sound from the list of saved notification sounds. Returns object_ptr<Ok>.
Removes a sticker from the set to which it belongs; for bots only. The sticker set must have been created by the bot. Returns object_ptr<Ok>.
Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled. Returns object_ptr<Ok>.
Changes order of active usernames of the current user. Returns object_ptr<Ok>.
Changes order of active usernames of a bot. Can be called only if userTypeBot.can_be_edited == true. Returns object_ptr<Ok>.
Changes the order of chat folders. Returns object_ptr<Ok>.
Changes the order of installed sticker sets. Returns object_ptr<Ok>.
Changes order of active usernames of a supergroup or channel, requires owner privileges in the supergroup or channel. Returns object_ptr<Ok>.
Replaces current primary invite link for a chat with a new primary invite link. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right. Returns object_ptr<ChatInviteLink>.
Replaces the current RTMP URL for streaming to the chat; requires creator privileges. Returns object_ptr<RtmpUrl>.
Reports a chat to the Telegram moderators. A chat can be reported only from the chat action bar, or if chat.can_be_reported. Returns object_ptr<Ok>.
Reports a chat photo to the Telegram moderators. A chat photo can be reported only if chat.can_be_reported. Returns object_ptr<Ok>.
Reports reactions set on a message to the Telegram moderators. Reactions on a message can be reported only if message.can_report_reactions. Returns object_ptr<Ok>.
Reports a story to the Telegram moderators. Returns object_ptr<Ok>.
Reports a false deletion of a message by aggressive anti-spam checks; requires administrator rights in the supergroup. Can be called only for messages from chatEventMessageDeleted with can_report_anti_spam_false_positive == true. Returns object_ptr<Ok>.
Reports messages in a supergroup as spam; requires administrator rights in the supergroup. Returns object_ptr<Ok>.
Requests to send a 2-step verification password recovery code to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword. Returns object_ptr<Ok>.
Requests to send a 2-step verification password recovery code to an email address that was previously set up. Returns object_ptr<EmailAddressAuthenticationCodeInfo>.
Requests QR code authentication by scanning a QR code on another logged in device. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword. Returns object_ptr<Ok>.
Resends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitCode, the next_code_type of the result is not null and the server-specified timeout has passed, or when the current authorization state is authorizationStateWaitEmailCode. Returns object_ptr<Ok>.
Resends the authentication code sent to confirm a new phone number for the current user. Works only if the previously received authenticationCodeInfo next_code_type was not null and the server-specified timeout has passed. Returns object_ptr<AuthenticationCodeInfo>.
Resends the code to verify an email address to be added to a user's Telegram Passport. Returns object_ptr<EmailAddressAuthenticationCodeInfo>.
Resends the login email address verification code. Returns object_ptr<EmailAddressAuthenticationCodeInfo>.
Resends messages which failed to send. Can be called only for messages for which messageSendingStateFailed.can_retry is true and after specified in messageSendingStateFailed.retry_after time passed. If a message is re-sent, the corresponding failed to send message is deleted. Returns the sent messages in the same order as the message identifiers passed in message_ids. If a message can't be re-sent, null will be returned instead of the message. Returns object_ptr<Messages>.
Resends phone number confirmation code. Returns object_ptr<AuthenticationCodeInfo>.
Resends the code to verify a phone number to be added to a user's Telegram Passport. Returns object_ptr<AuthenticationCodeInfo>.
Resends the 2-step verification recovery email address verification code. Returns object_ptr<PasswordState>.
Resets all notification settings to their default values. By default, all chats are unmuted and message previews are shown. Returns object_ptr<Ok>.
Resets the login email address. May return an error with a message "TASK_ALREADY_EXISTS" if reset is still pending. Works only when the current authorization state is authorizationStateWaitEmailCode and authorization_state.can_reset_email_address == true. Returns object_ptr<Ok>.
Resets list of installed backgrounds to its default value. Returns object_ptr<Ok>.
Resets all network data usage statistics to zero. Can be called before authorization. Returns object_ptr<Ok>.
Removes 2-step verification password without previous password and access to recovery email address. The password can't be reset immediately and the request needs to be repeated after the specified time. Returns object_ptr<ResetPasswordResult>.
Revokes invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links. If a primary link is revoked, then additionally to the revoked link returns new primary link. Returns object_ptr<ChatInviteLinks>.
Revokes invite link for a group call. Requires groupCall.can_be_managed group call flag. Returns object_ptr<Ok>.
Saves application log event on the server. Can be called before authorization. Returns object_ptr<Ok>.
Searches for a background by its name. Returns object_ptr<Background>.
Searches for call messages. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib. Returns object_ptr<FoundMessages>.
Searches for a specified query in the first name, last name and usernames of the members of a specified chat. Requires administrator rights in channels. Returns object_ptr<ChatMembers>.
Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, sender_id, filter and message_thread_id search criteria is expected to be supported, only if it is required for Telegram official application implementation. Returns object_ptr<FoundChatMessages>.
Returns information about the recent locations of chat members that were sent to the chat. Returns up to 1 location message per user. Returns object_ptr<Messages>.
Searches for the specified query in the title and username of already known chats; this is an offline request. Returns chats in the order seen in the main chat list. Returns object_ptr<Chats>.
Returns a list of users and location-based supergroups nearby. The list of users nearby will be updated for 60 seconds after the request by the updates updateUsersNearby. The request must be sent again every 25 seconds with adjusted location to not miss new chats. Returns object_ptr<ChatsNearby>.
Searches for the specified query in the title and username of already known chats via request to the server. Returns chats in the order seen in the main chat list. Returns object_ptr<Chats>.
Searches for the specified query in the first names, last names and usernames of the known user contacts. Returns object_ptr<Users>.
Searches for emojis by keywords. Supported only if the file database is enabled. Returns object_ptr<Emojis>.
Searches for files in the file download list or recently downloaded files from the list. Returns object_ptr<FoundFileDownloads>.
Searches for recently used hashtags by their prefix. Returns object_ptr<Hashtags>.
Searches for installed sticker sets by looking for specified query in their title and name. Returns object_ptr<StickerSets>.
Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. Returns object_ptr<FoundMessages>.
Searches for outgoing messages with content of the type messageDocument in all chats except secret chats. Returns the results in reverse chronological order. Returns object_ptr<FoundMessages>.
Searches a public chat by its username. Currently, only private chats, supergroups and channels can be public. Returns the chat if found; otherwise, an error is returned. Returns object_ptr<Chat>.
Searches public chats by looking for specified query in their username and title. Currently, only private chats, supergroups and channels can be public. Returns a meaningful number of results. Excludes private chats with contacts and chats from the chat list from the results. Returns object_ptr<Chats>.
Searches for a given quote in a text. Returns found quote start position in UTF-16 code units. Returns a 404 error if the quote is not found. Can be called synchronously. Returns object_ptr<FoundPosition>.
Searches for the specified query in the title and username of up to 50 recently found chats; this is an offline request. Returns object_ptr<Chats>.
Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance, the number of returned messages is chosen by TDLib. Returns object_ptr<FoundMessages>.
Searches for a sticker set by its name. Returns object_ptr<StickerSet>.
Searches for sticker sets by looking for specified query in their title and name. Excludes installed sticker sets from the results. Returns object_ptr<StickerSets>.
Searches for stickers from public sticker sets that correspond to any of the given emoji. Returns object_ptr<Stickers>.
Searches specified query by word prefixes in the provided strings. Returns 0-based positions of strings that matched. Can be called synchronously. Returns object_ptr<FoundPositions>.
Searches a user by their phone number. Returns a 404 error if the user can't be found. Returns object_ptr<User>.
Searches a user by a token from the user's link. Returns object_ptr<User>.
Returns information about a Web App by its short name. Returns a 404 error if the Web App is not found. Returns object_ptr<FoundWebApp>.
Sends Firebase Authentication SMS to the phone number of the user. Works only when the current authorization state is authorizationStateWaitCode and the server returned code of the type authenticationCodeTypeFirebaseAndroid or authenticationCodeTypeFirebaseIos. Returns object_ptr<Ok>.
Invites a bot to a chat (if it is not yet a member) and sends it the /start command. Bots can't be invited to a private chat other than the chat with the bot. Bots can't be invited to channels (although they can be added as admins) and secret chats. Returns the sent message. Returns object_ptr<Message>.
Sends debug information for a call to Telegram servers. Returns object_ptr<Ok>.
Sends log file for a call to Telegram servers. Returns object_ptr<Ok>.
Sends a call rating. Returns object_ptr<Ok>.
Sends call signaling data. Returns object_ptr<Ok>.
Sends a notification about user activity in a chat. Returns object_ptr<Ok>.
Sends a custom request; for bots only. Returns object_ptr<CustomRequestResult>.
Sends a code to verify an email address to be added to a user's Telegram Passport. Returns object_ptr<EmailAddressAuthenticationCodeInfo>.
Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message. Returns object_ptr<Message>.
Sends a message. Returns the sent message. Returns object_ptr<Message>.
Sends 2-10 messages grouped together into an album. Currently, only audio, document, photo and video messages can be grouped into an album. Documents and audio files can be only grouped in an album with messages of the same type. Returns sent messages. Returns object_ptr<Messages>.
Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after getPassportAuthorizationFormAvailableElements if some previously available elements are going to be reused. Returns object_ptr<Ok>.
Sends a filled-out payment form to the bot for final verification. Returns object_ptr<PaymentResult>.
Sends phone number confirmation code to handle links of the type internalLinkTypePhoneNumberConfirmation. Returns object_ptr<AuthenticationCodeInfo>.
Sends a code to verify a phone number to be added to a user's Telegram Passport. Returns object_ptr<AuthenticationCodeInfo>.
Sends a new story to a chat; requires can_post_stories rights for channel chats. Returns a temporary story. Returns object_ptr<Story>.
Sends a custom request from a Web App. Returns object_ptr<CustomRequestResult>.
Sends data received from a keyboardButtonTypeWebApp Web App to a bot. Returns object_ptr<Ok>.
Changes accent color and background custom emoji for the current user; for Telegram Premium users only. Returns object_ptr<Ok>.
Changes the period of inactivity after which the account of the current user will automatically be deleted. Returns object_ptr<Ok>.
Succeeds after a specified amount of time has passed. Can be called before initialization. Returns object_ptr<Ok>.
Changes settings for automatic moving of chats to and from the Archive chat lists. Returns object_ptr<Ok>.
Sets the email address of the user and sends an authentication code to the email address. Works only when the current authorization state is authorizationStateWaitEmailAddress. Returns object_ptr<Ok>.
Sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword. Returns object_ptr<Ok>.
Sets auto-download settings. Returns object_ptr<Ok>.
Sets autosave settings for the given scope. The method is guaranteed to work only after at least one call to getAutosaveSettings. Returns object_ptr<Ok>.
Changes the background selected by the user; adds background to the list of installed backgrounds. Returns object_ptr<Background>.
Changes the bio of the current user. Returns object_ptr<Ok>.
Sets the text shown in the chat with a bot if the chat is empty. Can be called only if userTypeBot.can_be_edited == true. Returns object_ptr<Ok>.
Sets the text shown on a bot's profile page and sent together with the link when users share the bot. Can be called only if userTypeBot.can_be_edited == true. Returns object_ptr<Ok>.
Sets the name of a bot. Can be called only if userTypeBot.can_be_edited == true. Returns object_ptr<Ok>.
Changes a profile photo for a bot. Returns object_ptr<Ok>.
Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only. Returns object_ptr<Ok>.
Changes accent color and background custom emoji of a chat. Supported only for channels with getOption("channel_custom_accent_color_boost_level_min") boost level. Requires can_change_info administrator right. Returns object_ptr<Ok>.
Changes story list in which stories from the chat are shown. Returns object_ptr<Ok>.
Changes reactions, available in a chat. Available for basic groups, supergroups, and channels. Requires can_change_info administrator right. Returns object_ptr<Ok>.
Sets the background in a specific chat. Supported only in private and secret chats with non-deleted users. Returns object_ptr<Ok>.
Changes application-specific data associated with a chat. Returns object_ptr<Ok>.
Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info administrator right. Returns object_ptr<Ok>.
Changes the discussion group of a channel chat; requires can_change_info administrator right in the channel if it is specified. Returns object_ptr<Ok>.
Changes the draft message in a chat. Returns object_ptr<Ok>.
Changes the location of a chat. Available only for some location-based supergroups, use supergroupFullInfo.can_set_location to check whether the method is allowed to use. Returns object_ptr<Ok>.
Changes the status of a chat member, needs appropriate privileges. This function is currently not suitable for transferring chat ownership; use transferChatOwnership instead. Use addChatMember or banChatMember if some additional parameters needs to be passed. Returns object_ptr<Ok>.
Changes the message auto-delete or self-destruct (for secret chats) time in a chat. Requires change_info administrator right in basic groups, supergroups and channels Message auto-delete time can't be changed in a chat with the current user (Saved Messages) and the chat 777000 (Telegram). Returns object_ptr<Ok>.
Selects a message sender to send messages in a chat. Returns object_ptr<Ok>.
Changes the notification settings of a chat. Notification settings of a chat with the current user (Saved Messages) can't be changed. Returns object_ptr<Ok>.
Changes the chat members permissions. Supported only for basic groups and supergroups. Requires can_restrict_members administrator right. Returns object_ptr<Ok>.
Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info administrator right. Returns object_ptr<Ok>.
Changes the slow mode delay of a chat. Available only for supergroups; requires can_restrict_members rights. Returns object_ptr<Ok>.
Changes the chat theme. Supported only in private and secret chats. Returns object_ptr<Ok>.
Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info administrator right. Returns object_ptr<Ok>.
Changes the list of close friends of the current user. Returns object_ptr<Ok>.
Sets the list of commands supported by the bot for the given user scope and language; for bots only. Returns object_ptr<Ok>.
Sets a custom emoji sticker set thumbnail; for bots only. Returns object_ptr<Ok>.
Adds or changes a custom local language pack to the current localization target. Returns object_ptr<Ok>.
Adds, edits or deletes a string in a custom local language pack. Can be called before authorization. Returns object_ptr<Ok>.
Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain. Returns object_ptr<Ok>.
Sets default administrator rights for adding the bot to channel chats; for bots only. Returns object_ptr<Ok>.
Sets default administrator rights for adding the bot to basic group and supergroup chats; for bots only. Returns object_ptr<Ok>.
Changes the default message auto-delete time for new chats. Returns object_ptr<Ok>.
Changes type of default reaction for the current user. Returns object_ptr<Ok>.
Changes the emoji status of the current user; for Telegram Premium users only. Returns object_ptr<Ok>.
Informs TDLib on a file generation progress. Returns object_ptr<Ok>.
Changes the notification settings of a forum topic. Returns object_ptr<Ok>.
Updates the game score of the specified user in the game; for bots only. Returns object_ptr<Message>.
Informs TDLib that speaking state of a participant of an active group has changed. Returns object_ptr<Ok>.
Changes volume level of a participant of an active group call. If the current user can manage the group call, then the participant's volume level will be changed for all users with the default volume level. Returns object_ptr<Ok>.
Sets group call title. Requires groupCall.can_be_managed group call flag. Returns object_ptr<Ok>.
Changes the period of inactivity after which sessions will automatically be terminated. Returns object_ptr<Ok>.
Updates the game score of the specified user in a game; for bots only. Returns object_ptr<Ok>.
Changes the location of the current user. Needs to be called if getOption("is_location_visible") is true and location changes for more than 1 kilometer. Returns object_ptr<Ok>.
Sets new log stream for internal logging of TDLib. Can be called synchronously. Returns object_ptr<Ok>.
Sets the verbosity level for a specified TDLib internal log tag. Can be called synchronously. Returns object_ptr<Ok>.
Sets the verbosity level of the internal logging of TDLib. Can be called synchronously. Returns object_ptr<Ok>.
Changes the login email address of the user. The email address can be changed only if the current user already has login email and passwordState.login_email_address_pattern is non-empty. The change will not be applied until the new login email address is confirmed with checkLoginEmailAddressCode. To use Apple ID/Google ID instead of a email address, call checkLoginEmailAddressCode directly. Returns object_ptr<EmailAddressAuthenticationCodeInfo>.
Sets menu button for the given user or for all users; for bots only. Returns object_ptr<Ok>.
Changes the block list of a message sender. Currently, only users and supergroup chats can be blocked. Returns object_ptr<Ok>.
Changes the first and last name of the current user. Returns object_ptr<Ok>.
Sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it must be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics. Returns object_ptr<Ok>.
Sets the value of an option. (Check the list of available options on https://core.telegram.org/tdlib/options.) Only writable options can be set. Can be called before authorization. Returns object_ptr<Ok>.
Adds an element to the user's Telegram Passport. May return an error with a message "PHONE_VERIFICATION_NEEDED" or "EMAIL_VERIFICATION_NEEDED" if the chosen phone number or the chosen email address must be verified first. Returns object_ptr<PassportElement>.
Informs the user that some of the elements in their Telegram Passport contain errors; for bots only. The user will not be able to resend the elements, until the errors are fixed. Returns object_ptr<Ok>.
Changes the 2-step verification password for the current user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed. Returns object_ptr<PasswordState>.
Changes the order of pinned chats. Returns object_ptr<Ok>.
Changes the order of pinned forum topics. Returns object_ptr<Ok>.
Changes the user answer to a poll. A poll in quiz mode can be answered only once. Returns object_ptr<Ok>.
Changes accent color and background custom emoji for profile of the current user; for Telegram Premium users only. Returns object_ptr<Ok>.
Changes a profile photo for the current user. Returns object_ptr<Ok>.
Changes the 2-step verification recovery email address of the user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed. If new_recovery_email_address is the same as the email address that is currently set up, this call succeeds immediately and aborts all other requests waiting for an email confirmation. Returns object_ptr<PasswordState>.
Changes notification settings for chats of a given type. Returns object_ptr<Ok>.
Changes the list of emoji corresponding to a sticker; for bots only. The sticker must belong to a regular or custom emoji sticker set created by the bot. Returns object_ptr<Ok>.
Changes the list of keywords of a sticker; for bots only. The sticker must belong to a regular or custom emoji sticker set created by the bot. Returns object_ptr<Ok>.
Changes the mask position of a mask sticker; for bots only. The sticker must belong to a mask sticker set created by the bot. Returns object_ptr<Ok>.
Changes the position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot. Returns object_ptr<Ok>.
Sets a sticker set thumbnail; for bots only. Returns object_ptr<Ok>.
Sets a sticker set title; for bots only. Returns object_ptr<Ok>.
Changes privacy settings of a story. Can be called only if story.can_be_edited == true. Returns object_ptr<Ok>.
Changes chosen reaction on a story. Returns object_ptr<Ok>.
Changes the sticker set of a supergroup; requires can_change_info administrator right. Returns object_ptr<Ok>.
Changes the editable username of a supergroup or channel, requires owner privileges in the supergroup or channel. Returns object_ptr<Ok>.
Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters. Returns object_ptr<Ok>.
Changes a personal profile photo of a contact user. Returns object_ptr<Ok>.
Changes user privacy settings. Returns object_ptr<Ok>.
Sets support information for the given user; for Telegram support only. Returns object_ptr<UserSupportInfo>.
Changes the editable username of the current user. Returns object_ptr<Ok>.
Changes default participant identifier, on whose behalf a video chat in the chat will be joined. Returns object_ptr<Ok>.
Shares a chat after pressing a keyboardButtonTypeRequestChat button with the bot. Returns object_ptr<Ok>.
Shares the phone number of the current user with a mutual contact. Supposed to be called when the user clicks on chatActionBarSharePhoneNumber. Returns object_ptr<Ok>.
Shares a user after pressing a keyboardButtonTypeRequestUser button with the bot. Returns object_ptr<Ok>.
Starts recording of an active group call. Requires groupCall.can_be_managed group call flag. Returns object_ptr<Ok>.
Starts screen sharing in a joined group call. Returns join response payload for tgcalls. Returns object_ptr<Text>.
Starts a scheduled group call. Returns object_ptr<Ok>.
Stops a poll. A poll in a message can be stopped when the message has can_be_edited flag is set. Returns object_ptr<Ok>.
Suggests a profile photo to another regular user with common messages. Returns object_ptr<Ok>.
Fetches the latest versions of all strings from a language pack in the current localization target from the server. This method doesn't need to be called explicitly for the current used/base language packs. Can be called before authorization. Returns object_ptr<Ok>.
Terminates all other sessions of the current user. Returns object_ptr<Ok>.
Terminates a session of the current user. Returns object_ptr<Ok>.
Returns the received bytes; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<TestBytes>.
Does nothing; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<Ok>.
Returns the received string; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<TestString>.
Returns the received vector of numbers; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<TestVectorInt>.
Returns the received vector of objects containing a number; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<TestVectorIntObject>.
Returns the received vector of strings; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<TestVectorString>.
Returns the received vector of objects containing a string; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<TestVectorStringObject>.
Forces an updates.getDifference call to the Telegram servers; for testing only. Returns object_ptr<Ok>.
Sends a simple network request to the Telegram servers; for testing only. Can be called before authorization. Returns object_ptr<Ok>.
Sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization. Returns object_ptr<Ok>.
Returns the specified error and ensures that the Error object is used; for testing only. Can be called synchronously. Returns object_ptr<Error>.
Returns the squared received number; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<TestInt>.
Does nothing and ensures that the Update object is used; for testing only. This is an offline method. Can be called before authorization. Returns object_ptr<Update>.
Changes pause state of all files in the file download list. Returns object_ptr<Ok>.
Adds or removes a bot to attachment and side menu. Bot can be added to the menu, only if userTypeBot.can_be_added_to_attachment_menu == true. Returns object_ptr<Ok>.
Changes active state for a username of a bot. The editable username can't be disabled. May return an error with a message "USERNAMES_ACTIVE_TOO_MUCH" if the maximum number of active usernames has been reached. Can be called only if userTypeBot.can_be_edited == true. Returns object_ptr<Ok>.
Changes the value of the default disable_notification parameter, used when a message is sent to a chat. Returns object_ptr<Ok>.
Changes the ability of users to save, forward, or copy chat content. Supported only for basic groups, supergroups and channels. Requires owner privileges. Returns object_ptr<Ok>.
Changes the marked as unread state of a chat. Returns object_ptr<Ok>.
Changes the pinned state of a chat. There can be up to getOption("pinned_chat_count_max")/getOption("pinned_archived_chat_count_max") pinned non-secret chats and the same number of secret chats in the main/archive chat list. The limit can be increased with Telegram Premium. Returns object_ptr<Ok>.
Changes the translatable state of a chat. Returns object_ptr<Ok>.
Changes the view_as_topics setting of a forum chat. Returns object_ptr<Ok>.
Changes pause state of a file in the file download list. Returns object_ptr<Ok>.
Toggles whether a topic is closed in a forum supergroup chat; requires can_manage_topics administrator right in the supergroup unless the user is creator of the topic. Returns object_ptr<Ok>.
Changes the pinned state of a forum topic; requires can_manage_topics administrator right in the supergroup. There can be up to getOption("pinned_forum_topic_count_max") pinned forum topics. Returns object_ptr<Ok>.
Toggles whether a General topic is hidden in a forum supergroup chat; requires can_manage_topics administrator right in the supergroup. Returns object_ptr<Ok>.
Toggles whether the current user will receive a notification when the group call starts; scheduled group calls only. Returns object_ptr<Ok>.
Toggles whether current user's video is enabled. Returns object_ptr<Ok>.
Toggles whether current user's video is paused. Returns object_ptr<Ok>.
Toggles whether new participants of a group call can be unmuted only by administrators of the group call. Requires groupCall.can_toggle_mute_new_participants group call flag. Returns object_ptr<Ok>.
Toggles whether a group call participant hand is rased. Returns object_ptr<Ok>.
Toggles whether a participant of an active group call is muted, unmuted, or allowed to unmute themselves. Returns object_ptr<Ok>.
Pauses or unpauses screen sharing in a joined group call. Returns object_ptr<Ok>.
Toggles whether a session can accept incoming calls. Returns object_ptr<Ok>.
Toggles whether a session can accept incoming secret chats. Returns object_ptr<Ok>.
Toggles whether a story is accessible after expiration. Can be called only if story.can_toggle_is_pinned == true. Returns object_ptr<Ok>.
Toggles whether aggressive anti-spam checks are enabled in the supergroup. Can be called only if supergroupFullInfo.can_toggle_aggressive_anti_spam == true. Returns object_ptr<Ok>.
Toggles whether non-administrators can receive only administrators and bots using getSupergroupMembers or searchChatMembers. Can be called only if supergroupFullInfo.can_hide_members == true. Returns object_ptr<Ok>.
Toggles whether the message history of a supergroup is available to new members; requires can_change_info administrator right. Returns object_ptr<Ok>.
Upgrades supergroup to a broadcast group; requires owner privileges in the supergroup. Returns object_ptr<Ok>.
Toggles whether the supergroup is a forum; requires owner privileges in the supergroup. Discussion supergroups can't be converted to forums. Returns object_ptr<Ok>.
Toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires can_restrict_members administrator right. Returns object_ptr<Ok>.
Toggles whether joining is mandatory to send messages to a discussion supergroup; requires can_restrict_members administrator right. Returns object_ptr<Ok>.
Toggles whether sender signature is added to sent messages in a channel; requires can_change_info administrator right. Returns object_ptr<Ok>.
Changes active state for a username of a supergroup or channel, requires owner privileges in the supergroup or channel. The editable username can't be disabled. May return an error with a message "USERNAMES_ACTIVE_TOO_MUCH" if the maximum number of active usernames has been reached. Returns object_ptr<Ok>.
Changes active state for a username of the current user. The editable username can't be disabled. May return an error with a message "USERNAMES_ACTIVE_TOO_MUCH" if the maximum number of active usernames has been reached. Returns object_ptr<Ok>.
Changes the owner of a chat. The current user must be a current owner of the chat. Use the method canTransferOwnership to check whether the ownership can be transferred from the current session. Available only for supergroups and channel chats. Returns object_ptr<Ok>.
Extracts text or caption of the given message and translates it to the given language. If the current user is a Telegram Premium user, then text formatting is preserved. Returns object_ptr<FormattedText>.
Translates a text to the given language. If the current user is a Telegram Premium user, then text formatting is preserved. Returns object_ptr<FormattedText>.
Removes all pinned messages from a chat; requires can_pin_messages rights in the group or can_edit_messages rights in the channel. Returns object_ptr<Ok>.
Removes all pinned messages from a forum topic; requires can_pin_messages rights in the supergroup. Returns object_ptr<Ok>.
Removes a pinned message from a chat; requires can_pin_messages rights in the group or can_edit_messages rights in the channel. Returns object_ptr<Ok>.
Creates a new supergroup from an existing basic group and sends a corresponding messageChatUpgradeTo and messageChatUpgradeFrom; requires creator privileges. Deactivates the original basic group. Returns object_ptr<Chat>.
Uploads a file with a sticker; returns the uploaded file. Returns object_ptr<File>.
Validates the order information provided by a user and returns the available shipping options for a flexible invoice. Returns object_ptr<ValidatedOrderInfo>.
Informs TDLib that messages are being viewed by the user. Sponsored messages must be marked as viewed only when the entire text of the message is shown on the screen (excluding the button). Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels). Returns object_ptr<Ok>.
Informs TDLib that the user viewed detailed information about a Premium feature on the Premium features screen. Returns object_ptr<Ok>.
Informs the server that some trending sticker sets have been viewed by the user. Returns object_ptr<Ok>.
Writes a part of a generated file. This method is intended to be used only if the application has no direct access to TDLib's file system, because it is usually slower than a direct write to the destination file. Returns object_ptr<Ok>.
This module was generated using Telegram's TDLib documentation. It contains 1478 submodules (= structs).
Contains information about supported accent color for user/chat name, background of empty chat photo, replies to messages and link previews.
Contains information about the period of inactivity after which the current user's account will automatically be deleted.
Represents a reaction applied to a message.
Represents a list of reactions added to a message.
Describes an address.
Animated variant of a chat photo in MPEG4 format.
Describes an animated or custom representation of an emoji.
Describes an animation file. The animation must be encoded in GIF or MPEG4 format.
Represents a list of animations.
Contains settings for automatic moving of chats to and from the Archive chat lists.
Represents a bot, which can be added to attachment or side menu.
Describes a color to highlight a bot added to attachment menu.
Describes an audio file. Audio is usually in MP3 or M4A format.
Information about the authentication code that was sent.
This class is an abstract base class. Provides information about the method by which an authentication code is delivered to the user.
An authentication code is delivered via a phone call to the specified phone number.
An authentication code is delivered via Firebase Authentication to the official Android application.
An authentication code is delivered via Firebase Authentication to the official iOS application.
An authentication code is delivered by an immediately canceled call to the specified phone number. The phone number that calls is the code that must be entered automatically.
An authentication code is delivered to https://fragment.com. The user must be logged in there via a wallet owning the phone number's NFT.
An authentication code is delivered by an immediately canceled call to the specified phone number. The last digits of the phone number that calls are the code that must be entered manually by the user.
An authentication code is delivered via an SMS message to the specified phone number; applications may not receive this type of code.
An authentication code is delivered via a private Telegram message, which can be viewed from another active session.
This class is an abstract base class. Represents the current authorization state of the TDLib client.
TDLib client is in its final state. All databases are closed and all resources are released. No other updates will be received after this. All queries will be responded to with error code 500. To continue working, one must create a new instance of the TDLib client.
TDLib is closing, all subsequent queries will be answered with the error 500. Note that closing TDLib can take a while. All resources will be freed only after authorizationStateClosed has been received.
The user is currently logging out.
The user has been successfully authorized. TDLib is now ready to answer general requests.
TDLib needs the user's authentication code to authorize. Call checkAuthenticationCode to check the code.
TDLib needs the user's email address to authorize. Call setAuthenticationEmailAddress to provide the email address, or directly call checkAuthenticationEmailCode with Apple ID/Google ID token if allowed.
TDLib needs the user's authentication code sent to an email address to authorize. Call checkAuthenticationEmailCode to provide the code.
The user needs to confirm authorization on another logged in device by scanning a QR code with the provided link.
The user has been authorized, but needs to enter a 2-step verification password to start using the application. Call checkAuthenticationPassword to provide the password, or requestAuthenticationPasswordRecovery to recover the password, or deleteAccount to delete the account after a week.
TDLib needs the user's phone number to authorize. Call setAuthenticationPhoneNumber to provide the phone number, or use requestQrCodeAuthentication or checkAuthenticationBotToken for other authentication options.
The user is unregistered and need to accept terms of service and enter their first name and last name to finish registration. Call registerUser to accept the terms of service and provide the data.
Initialization parameters are needed. Call setTdlibParameters to provide them.
Contains auto-download settings.
Contains auto-download settings presets for the current user.
Describes autosave settings.
Contains autosave settings for a chat, which overrides default settings for the corresponding scope.
This class is an abstract base class. Describes scope of autosave settings.
Autosave settings applied to all channel chats without chat-specific settings.
Autosave settings applied to a chat.
Autosave settings applied to all basic group and supergroup chats without chat-specific settings.
Autosave settings applied to all private chats without chat-specific settings.
Represents an available reaction.
Represents a list of reactions that can be added to a message.
Describes a chat background.
This class is an abstract base class. Describes a fill of a background.
Describes a freeform gradient fill of a background.
Describes a gradient fill of a background.
Describes a solid fill of a background.
This class is an abstract base class. Describes the type of a background.
A filled background.
A PNG or TGV (gzipped subset of SVG with MIME type "application/x-tgwallpattern") pattern to be combined with the background fill chosen by the user.
A wallpaper in JPEG format.
Contains a list of backgrounds.
Describes an action associated with a bank card number.
Information about a bank card.
Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users).
Contains full information about a basic group.
This class is an abstract base class. Describes a type of a block list.
The main block list that disallows writing messages to the current user, receiving their status and photo, viewing of stories, and some other actions.
The block list that disallows viewing of stories of the current user.
Represents a command supported by a bot.
This class is an abstract base class. Represents the scope to which bot commands are relevant.
A scope covering all group and supergroup chat administrators.
A scope covering all group and supergroup chats.
A scope covering all private chats.
A scope covering all members of a chat.
A scope covering all administrators of a chat.
A scope covering a member of a chat.
A scope covering all users.
Contains a list of bot commands.
Contains information about a bot.
Describes a button to be shown instead of bot commands menu button.
This class is an abstract base class. Describes a reason why a bot was allowed to write messages to the current user.
The user accepted bot's request to send messages with allowBotToSendMessages.
The user added the bot to attachment or side menu using toggleBotIsAddedToAttachmentMenu.
The user connected a website by logging in using Telegram Login Widget on it.
The user launched a Web App using getWebAppLinkUrl.
Describes a call.
This class is an abstract base class. Describes the reason why a call was discarded.
The call was ended before the conversation started. It was declined by the other party.
The call was ended during the conversation because the users were disconnected.
The call wasn't discarded, or the reason is unknown.
The call was ended because one of the parties hung up.
The call was ended before the conversation started. It was canceled by the caller or missed by the other party.
Contains the call identifier.
This class is an abstract base class. Describes the exact type of a problem with a call.
The speech was distorted.
The video was distorted.
The call ended unexpectedly.
The user heard their own voice.
The other side kept disappearing.
The user heard background noise.
The video was pixelated.
The user couldn't hear the other side.
The other side couldn't hear the user.
Specifies the supported call protocols.
Describes a server for relaying call data.
This class is an abstract base class. Describes the type of a call server.
A Telegram call reflector.
A WebRTC server.
This class is an abstract base class. Describes the current call state.
The call has ended successfully.
The call has ended with an error.
The call has been answered and encryption keys are being exchanged.
The call is hanging up after discardCall has been called.
The call is pending, waiting to be accepted by a user.
The call is ready to use.
Contains a bot's answer to a callback query.
This class is an abstract base class. Represents a payload of a callback query.
The payload for a general callback button.
The payload for a callback button requiring password.
The payload for a game callback button.
This class is an abstract base class. Represents result of checking whether the current user can send a story in the specific chat.
The limit for the number of active stories exceeded. The user can buy Telegram Premium, delete an active story, or wait for the oldest story to expire.
The channel chat must be boosted first by Telegram Premium subscribers to post more stories. Call getChatBoostStatus to get current boost status of the chat.
The monthly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait specified time.
A story can be sent.
The user must subscribe to Telegram Premium to be able to post stories.
The weekly limit for the number of posted stories exceeded. The user needs to buy Telegram Premium or wait specified time.
This class is an abstract base class. Represents result of checking whether the current session can be used to transfer a chat ownership to another user.
The session can be used.
The 2-step verification needs to be enabled first.
The 2-step verification was enabled recently, user needs to wait.
The session was created recently, user needs to wait.
A chat. (Can be a private chat, basic group, supergroup, or secret chat.)
This class is an abstract base class. Describes the different types of activity in a chat.
This class is an abstract base class. Describes actions which must be possible to do through a chat action bar.
The chat is a private or secret chat and the other user can be added to the contact list using the method addContact.
The chat is a recently created group chat to which new members can be invited.
The chat is a private chat with an administrator of a chat to which the user sent join request.
The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be blocked using the method setMessageSenderBlockList, or the other user can be added to the contact list using the method addContact. If the chat is a private chat with a user with an emoji status, then a notice about emoji status usage must be shown.
The chat can be reported as spam using the method reportChat with the reason reportReasonSpam. If the chat is a private chat with a user with an emoji status, then a notice about emoji status usage must be shown.
The chat is a location-based supergroup, which can be reported as having unrelated location using the method reportChat with the reason reportReasonUnrelatedLocation.
The chat is a private or secret chat with a mutual contact and the user's phone number can be shared with the other user using the method sharePhoneNumber.
The user has canceled the previous action.
The user is picking a contact to send.
The user is picking a location or venue to send.
The user is picking a sticker to send.
The user is recording a video.
The user is recording a video note.
The user is recording a voice note.
The user has started to play a game.
The user is typing a message.
The user is uploading a document.
The user is uploading a photo.
The user is uploading a video.
The user is uploading a video note.
The user is uploading a voice note.
The user is watching animations sent by the other party by clicking on an animated emoji.
Describes active stories posted by a chat.
Contains information about a chat administrator.
Describes rights of the administrator.
Represents a list of chat administrators.
This class is an abstract base class. Describes reactions available in the chat.
All reactions are available in the chat.
Only specific reactions are available in the chat.
Describes a background set for a specific chat.
Describes a boost applied to a chat.
Contains an HTTPS link to boost a chat.
Contains information about a link to boost a chat.
Describes a slot for chat boost.
Contains a list of chat boost slots.
This class is an abstract base class. Describes source of a chat boost.
The chat created a Telegram Premium gift code for a user.
The chat created a Telegram Premium giveaway.
A user with Telegram Premium subscription or gifted Telegram Premium boosted the chat.
Describes current boost status of a chat.
Represents a chat event.
The chat accent color was changed.
This class is an abstract base class. Represents a chat event.
The chat active usernames were changed.
The chat available reactions were changed.
The chat's custom emoji for reply background was changed.
The chat description was changed.
A new forum topic was created.
A forum topic was deleted.
A forum topic was edited.
A pinned forum topic was changed.
A forum topic was closed or reopened.
The General forum topic was hidden or unhidden.
The has_aggressive_anti_spam_enabled setting of a supergroup was toggled.
The has_protected_content setting of a channel was toggled.
A revoked chat invite link was deleted.
A chat invite link was edited.
A chat invite link was revoked.
The can_invite_users permission of a supergroup chat was toggled.
The is_all_history_available setting of a supergroup was toggled.
The is_forum setting of a channel was toggled.
The linked chat of a supergroup was changed.
The supergroup location was changed.
Represents a set of filters used to obtain a chat event log.
A new chat member was invited.
A new member joined the chat.
A new member joined the chat via an invite link.
A new member was accepted to the chat by an administrator.
A member left the chat.
A chat member has gained/lost administrator status, or the list of their administrator privileges has changed.
A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed.
The message auto-delete timer was changed.
A message was deleted.
A message was edited.
A message was pinned.
A message was unpinned.
The chat permissions were changed.
The chat photo was changed.
A poll in a message was stopped.
The sign_messages setting of a channel was toggled.
The slow_mode_delay setting of a supergroup was changed.
The supergroup sticker set was changed.
The chat title was changed.
The chat editable username was changed.
A video chat was created.
A video chat was ended.
The mute_new_participants setting of a video chat was toggled.
A video chat participant was muted or unmuted.
A video chat participant volume level was changed.
Contains a list of chat events.
Represents a folder for user chats.
Represents an icon for a chat folder.
Contains basic information about a chat folder.
Contains a chat folder invite link.
Contains information about an invite link to a chat folder.
Represents a list of chat folder invite links.
Contains a chat invite link.
Describes a chat administrator with a number of active and revoked chat invite links.
Contains a list of chat invite link counts.
Contains information about a chat invite link.
Describes a chat member joined a chat via an invite link.
Contains a list of chat members joined a chat via an invite link.
Contains a list of chat invite links.
Describes a user that sent a join request and waits for administrator approval.
Contains a list of requests to join a chat.
Contains information about pending join requests for a chat.
This class is an abstract base class. Describes a list of chats.
A list of chats usually located at the top of the main chat list. Unmuted chats are automatically moved from the Archive to the Main chat list when a new message arrives.
A list of chats added to a chat folder.
A main list of chats.
Contains a list of chat lists.
Represents a location to which a chat is connected.
Describes a user or a chat as a member of another chat.
This class is an abstract base class. Provides information about the status of a member in a chat.
The user is a member of the chat and has some additional privileges. In basic groups, administrators can edit and delete messages sent by others, add new members, ban unprivileged members, and manage video chats. In supergroups and channels, there are more detailed options for administrator privileges.
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, view messages, or be used as a participant identifier to join a video chat of the chat.
The user is the owner of the chat and has all the administrator privileges.
The user or the chat is not a chat member.
The user is a member of the chat, without any additional privileges or restrictions.
The user is under certain restrictions in the chat. Not supported in basic groups and channels.
Contains a list of chat members.
This class is an abstract base class. Specifies the kind of chat members to return in searchChatMembers.
Returns the owner and administrators.
Returns users banned from the chat; can be used only by administrators in a supergroup or in a channel.
Returns bot members of the chat.
Returns contacts of the user.
Returns all chat members, including restricted chat members.
Returns users which can be mentioned in the chat.
Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup.
Represents a message sender, which can be used to send messages in a chat.
Represents a list of message senders, which can be used to send messages in a chat.
Describes a chat located nearby.
Contains information about notification settings for a chat or a forum topic.
Describes actions that a user is allowed to take in a chat.
Describes a chat or user profile photo.
Contains basic information about the photo of a chat.
Information about the sticker, which was used to create the chat photo. The sticker is shown at the center of the photo and occupies at most 67% of it.
This class is an abstract base class. Describes type of a sticker, which was used to create a chat photo.
Information about the custom emoji, which was used to create the chat photo.
Information about the sticker, which was used to create the chat photo.
Contains a list of chat or user profile photos.
Describes a position of a chat in a chat list.
This class is an abstract base class. Describes a reason why an external chat is shown in a chat list.
The chat is sponsored by the user's MTProxy server.
The chat contains a public service announcement.
This class is an abstract base class. Contains a detailed statistics about a chat.
Contains statistics about administrator actions done by a user.
A detailed statistics about a channel chat.
Contains statistics about interactions with a message sent in the chat or a story sent by the chat.
Contains statistics about number of new members invited by a user.
Contains statistics about messages sent by a user.
This class is an abstract base class. Describes type of an object, for which statistics are provided.
Describes a message sent in the chat.
Describes a story sent by the chat.
A detailed statistics about a supergroup chat.
Describes a chat theme.
This class is an abstract base class. Describes the type of a chat.
A basic group (a chat with 0-200 other users).
An ordinary chat with a user.
A secret chat with a user.
A supergroup or channel (with unlimited members).
Represents a list of chats.
Represents a list of chats located nearby.
This class is an abstract base class. Represents result of checking whether a username can be set for a chat.
The username can be set.
The user has too many chats with username, one of them must be made private first.
The user can't be a member of a public supergroup.
The username is invalid.
The username is occupied.
The username can be purchased at fragment.com.
This class is an abstract base class. Represents result of checking whether a name can be used for a new sticker set.
The name is invalid.
The name is occupied.
The name can be set.
Represents a closed vector path. The path begins at the end point of the last command.
Contains information about one website the current user is logged in with Telegram.
Contains a list of websites the current user is logged in with Telegram.
This class is an abstract base class. Describes the current state of the connection to Telegram servers.
Establishing a connection to the Telegram servers.
Establishing a connection with a proxy server.
There is a working connection to the Telegram servers.
Downloading data supposed to be received while the application was offline.
Waiting for the network to become available. Use setNetworkType to change the available network type.
Describes a user contact.
Contains a counter.
Contains information about countries.
Contains information about a country.
Contains the result of a custom request.
Contains database statistics.
Represents a date according to the Gregorian calendar.
Represents a date range.
File with the date it was uploaded.
Contains information about a tg: deep link.
This class is an abstract base class. Represents a data needed to subscribe for push notifications through registerDevice method. To use specific push notification service, the correct application platform must be specified and a valid server authentication data must be uploaded at https://my.telegram.org.
A token for Apple Push Notification service.
A token for Apple Push Notification service VoIP notifications.
A token for BlackBerry Push Service.
A token for Firebase Cloud Messaging.
A token for HUAWEI Push Service.
A token for Microsoft Push Notification Service.
A token for Microsoft Push Notification Service VoIP channel.
A token for Simple Push API for Firefox OS.
A token for Tizen Push Service.
A token for Ubuntu Push Client service.
A token for web Push API.
A token for Windows Push Notification Services.
This class is an abstract base class. Contains animated stickers which must be used for dice animation rendering.
A regular animated sticker.
Animated stickers to be combined into a slot machine.
Describes a document of any type.
Contains number of being downloaded and recently downloaded files found.
Contains information about a message draft.
This class is an abstract base class. Contains authentication data for a email address.
An authentication token received through Apple ID.
An authentication code delivered to a user's email address.
Information about the email address authentication code that was sent.
An authentication token received through Google ID.
This class is an abstract base class. Describes reset state of a email address.
Email address can be reset after the given period. Call resetAuthenticationEmailAddress to reset it and allow the user to authorize with a code sent to the user's phone number.
Email address reset has already been requested. Call resetAuthenticationEmailAddress to check whether immediate reset is possible.
Represents a list of emoji categories.
Contains a list of similar emoji to search for in getStickers and searchStickers.
This class is an abstract base class. Describes type of an emoji category.
The category must be used for chat photo emoji selection.
The category must be used by default.
The category must be used for emoji status selection.
Contains information about a emoji reaction.
Describes a custom emoji to be shown instead of the Telegram Premium badge.
Contains a list of custom emoji identifiers, which can be set as emoji statuses.
Represents a list of emoji.
Contains encrypted Telegram Passport data credentials.
Contains information about an encrypted Telegram Passport element; for bots only.
An object of this type can be returned on every function call, in case of an error.
Represents a file.
Describes a file added to file download list.
Contains size of downloaded prefix of a file.
Contains a part of a file.
This class is an abstract base class. Represents the type of a file.
The file is an animation.
The file is an audio file.
The file is a document.
The data is not a file.
The file is a notification sound.
The file is a photo.
The file is a photo published as a story.
The file is a profile photo.
The file was sent to a secret chat (the file type is not known to the server).
The file is a thumbnail of a file from a secret chat.
The file is a file from Secure storage used for storing Telegram Passport files.
The file is a sticker.
The file is a thumbnail of another file.
The file type is not yet known.
The file is a video.
The file is a video note.
The file is a video published as a story.
The file is a voice note.
The file is a wallpaper or a background pattern.
This class is an abstract base class. Contains settings for Firebase Authentication in the official applications.
Settings for Firebase Authentication in the official Android application.
Settings for Firebase Authentication in the official iOS application.
A text with some entities.
Describes a forum topic.
Describes a forum topic icon.
Contains basic information about a forum topic.
Describes a list of forum topics.
Contains a list of boosts applied to a chat.
Contains a list of messages found by a search in a given chat.
Contains a list of downloaded files, found by a search.
Contains a list of messages found by a search.
Contains 0-based match position.
Contains 0-based positions of matched objects.
Contains information about a Web App found by its short name.
Describes a game. Use getInternalLink with internalLinkTypeGame to share the game.
Contains one row of the game high score table.
Contains a list of game high scores.
Describes a group call.
Contains the group call identifier.
Represents a group call participant.
Contains information about a group call participant's video channel.
Describes a recently speaking participant in a group call.
Describes an available stream in a group call.
Represents a list of group call streams.
This class is an abstract base class. Describes the quality of a group call video.
The best available video quality.
The medium video quality.
The worst available video quality.
Describes a group of video synchronization source identifiers.
Contains a list of hashtags.
Contains an HTTP URL.
An identity document.
Represents the result of an importContacts request.
Represents a single button in an inline keyboard.
This class is an abstract base class. Describes the type of an inline keyboard button.
A button to buy something. This button must be in the first column and row of the keyboard and can be attached only to a message with content of the type messageInvoice.
A button that sends a callback query to a bot.
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 keyboard and can be attached only to a message with content of the type messageGame.
A button that asks for the 2-step verification password of the current user and then sends a callback query to a bot.
A button that opens a specified URL and automatically authorize the current user by calling getLoginUrlInfo.
A button that forces an inline query to the bot to be inserted in the input field.
A button that opens a specified URL.
A button with a user reference to be handled in the same way as textEntityTypeMentionName entities.
A button that opens a Web App by calling openWebApp.
This class is an abstract base class. Represents a single result of an inline query.
Represents an animation file.
Represents a link to an article or web page.
Represents an audio file.
Represents a user contact.
Represents a document.
Represents information about a game.
Represents a point on the map.
Represents a photo.
Represents a sticker.
Represents information about a venue.
Represents a video.
Represents a voice note.
Represents the results of the inline query. Use sendInlineQueryResultMessage to send the result of the query.
Represents a button to be shown above inline query results.
This class is an abstract base class. Represents a type of a button in results of inline query.
Describes the button that opens a private chat with the bot and sends a start message to the bot with the given parameter.
Describes the button that opens a Web App by calling getWebAppUrl.
This class is an abstract base class. Contains information about background to set.
A background from a local file.
A background previously set in the chat; for chat backgrounds only.
A background from the server.
This class is an abstract base class. Describes a photo to be set as a user profile or chat photo.
An animation in MPEG4 format; must be square, at most 10 seconds long, have width between 160 and 1280 and be at most 2MB in size.
A previously used profile photo of the current user.
A static photo in JPEG format.
A sticker on a custom background.
This class is an abstract base class. Contains information about the payment method chosen by the user.
Applies if a user enters new credentials using Apple Pay.
Applies if a user enters new credentials using Google Pay.
Applies if a user enters new credentials on a payment provider website.
Applies if a user chooses some previously saved payment credentials. To use their previously saved credentials, the user must have a valid temporary password.
This class is an abstract base class. Points to a file.
A file generated by the application.
A file defined by its unique identifier.
A file defined by a local path.
A file defined by its remote identifier. The remote identifier is guaranteed to be usable only if the corresponding file is still accessible to the user and known to TDLib. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the application.
An identity document to be saved to Telegram Passport.
This class is an abstract base class. Represents a single result of an inline query; for bots only.
Represents a link to an animated GIF or an animated (i.e., without sound) H.264/MPEG-4 AVC video.
Represents a link to an article or web page.
Represents a link to an MP3 audio file.
Represents a user contact.
Represents a link to a file.
Represents a game.
Represents a point on the map.
Represents link to a JPEG image.
Represents a link to a WEBP, TGS, or WEBM sticker.
Represents information about a venue.
Represents a link to a page containing an embedded video player or a video file.
Represents a link to an opus-encoded audio file within an OGG container, single channel audio.
This class is an abstract base class. Describes an invoice to process.
An invoice from a message of the type messageInvoice.
An invoice from a link of the type internalLinkTypeInvoice.
An invoice for a payment toward Telegram; must not be used in the in-store apps.
An animation message (GIF-style).
An audio message.
A message containing a user contact.
This class is an abstract base class. The content of a message to send.
A dice message.
A document message (general file).
A forwarded message.
A message with a game; not supported for channels or secret chats.
A message with an invoice; can be used only by bots.
A message with a location.
A photo message.
A message with a poll. Polls can't be sent to secret chats. Polls can be sent only to a private chat with a bot.
This class is an abstract base class. Contains information about the message or the story to be replied.
Describes a message to be replied.
Describes a story to be replied.
A sticker message.
A message with a forwarded story. Stories can't be sent to secret chats. A story can be forwarded only if story.can_be_forwarded.
A text message.
A message with information about a venue.
A video message.
A video note message.
A voice note message.
This class is an abstract base class. Contains information about a Telegram Passport element to be saved.
A Telegram Passport element to be saved containing the user's address.
A Telegram Passport element to be saved containing the user's bank statement.
A Telegram Passport element to be saved containing the user's driver license.
A Telegram Passport element to be saved containing the user's email address.
Contains the description of an error in a Telegram Passport element; for bots only.
This class is an abstract base class. Contains the description of an error in a Telegram Passport element; for bots only.
A data field contains an error. The error is considered resolved when the field's value changes.
The file contains an error. The error is considered resolved when the file changes.
The list of attached files contains an error. The error is considered resolved when the file list changes.
The front side of the document contains an error. The error is considered resolved when the file with the front side of the document changes.
The reverse side of the document contains an error. The error is considered resolved when the file with the reverse side of the document changes.
The selfie contains an error. The error is considered resolved when the file with the selfie changes.
One of the files containing the translation of the document contains an error. The error is considered resolved when the file with the translation changes.
The translation of the document contains an error. The error is considered resolved when the list of files changes.
The element contains an error in an unspecified place. The error will be considered resolved when new data is added.
A Telegram Passport element to be saved containing the user's identity card.
A Telegram Passport element to be saved containing the user's internal passport.
A Telegram Passport element to be saved containing the user's passport.
A Telegram Passport element to be saved containing the user's passport registration.
A Telegram Passport element to be saved containing the user's personal details.
A Telegram Passport element to be saved containing the user's phone number.
A Telegram Passport element to be saved containing the user's rental agreement.
A Telegram Passport element to be saved containing the user's temporary registration.
A Telegram Passport element to be saved containing the user's utility bill.
A personal document to be saved to Telegram Passport.
A sticker to be added to a sticker set.
Describes a clickable rectangle area on a story media to be added.
This class is an abstract base class. Describes type of a clickable rectangle area on a story media to be added.
An area pointing to a venue found by the bot getOption("venue_search_bot_username").
An area pointing to a location.
An area pointing to a venue already added to the story.
An area pointing to a suggested reaction.
Contains a list of story areas to be added.
This class is an abstract base class. The content of a story to send.
A photo story.
A video story.
Describes manually chosen quote from another message.
A thumbnail to be sent along with a file; must be in JPEG or WEBP format for stickers, and less than 200 KB in size.
This class is an abstract base class. Describes an internal https://t.me or tg: link, which must be processed by the application in a special way.
The link is a link to the active sessions section of the application. Use getActiveSessions to handle the link.
The link is a link to an attachment menu bot to be opened in the specified or a chosen chat. Process given target_chat to open the chat. Then, call searchPublicChat with the given bot username, check that the user is a bot and can be added to attachment menu. Then, use getAttachmentMenuBot to receive information about the bot. If the bot isn't added to attachment menu, then show a disclaimer about Mini Apps being a third-party apps, ask the user to accept their Terms of service and confirm adding the bot to side and attachment menu. If the user accept the terms and confirms adding, then use toggleBotIsAddedToAttachmentMenu to add the bot. If the attachment menu bot can't be used in the opened chat, show an error to the user. If the bot is added to attachment menu and can be used in the chat, then use openWebApp with the given URL.
The link contains an authentication code. Call checkAuthenticationCode with the code if the current authorization state is authorizationStateWaitCode.
The link is a link to a background. Call searchBackground with the given background name to process the link.
The link is a link to a Telegram bot, which is supposed to be added to a channel chat as an administrator. Call searchPublicChat with the given bot username and check that the user is a bot, ask the current user to select a channel chat to add the bot to as an administrator. Then, call getChatMember to receive the current bot rights in the chat and if the bot already is an administrator, check that the current user can edit its administrator rights and combine received rights with the requested administrator rights. Then, show confirmation box to the user, and call setChatMemberStatus with the chosen chat and confirmed rights.
The link is a link to a chat with a Telegram bot. Call searchPublicChat with the given bot username, check that the user is a bot, show START button in the chat with the bot, and then call sendBotStartMessage with the given start parameter after the button is pressed.
The link is a link to a Telegram bot, which is supposed to be added to a group chat. Call searchPublicChat with the given bot username, check that the user is a bot and can be added to groups, ask the current user to select a basic group or a supergroup chat to add the bot to, taking into account that bots can be added to a public supergroup only by administrators of the supergroup. If administrator rights are provided by the link, call getChatMember to receive the current bot rights in the chat and if the bot already is an administrator, check that the current user can edit its administrator rights, combine received rights with the requested administrator rights, show confirmation box to the user, and call setChatMemberStatus with the chosen chat and confirmed administrator rights. Before call to setChatMemberStatus it may be required to upgrade the chosen basic group chat to a supergroup chat. Then, if start_parameter isn't empty, call sendBotStartMessage with the given start parameter and the chosen chat; otherwise, just send /start message with bot's username added to the chat.
The link is a link to the change phone number section of the app.
The link is a link to boost a Telegram chat. Call getChatBoostLinkInfo with the given URL to process the link. If the chat is found, then call getChatBoostStatus and getAvailableChatBoostSlots to get the current boost status and check whether the chat can be boosted. If the user wants to boost the chat and the chat can be boosted, then call boostChat.
The link is an invite link to a chat folder. Call checkChatFolderInviteLink with the given invite link to process the link.
The link is a link to the folder section of the app settings.
The link is a chat invite link. Call checkChatInviteLink with the given invite link to process the link.
The link is a link to the default message auto-delete timer settings section of the app settings.
The link is a link to the edit profile section of the app settings.
The link is a link to a game. Call searchPublicChat with the given bot username, check that the user is a bot, ask the current user to select a chat to send the game, and then call sendMessage with inputMessageGame.
The link must be opened in an Instant View. Call getWebPageInstantView with the given URL to process the link.
The link is a link to an invoice. Call getPaymentForm with the given invoice name to process the link.
The link is a link to a language pack. Call getLanguagePackInfo with the given language pack identifier to process the link.
The link is a link to the language section of the app settings.
The link is a link to a Telegram message or a forum topic. Call getMessageLinkInfo with the given URL to process the link.
The link contains a message draft text. A share screen needs to be shown to the user, then the chosen chat must be opened and the text is added to the input field.
The link contains a request of Telegram passport data. Call getPassportAuthorizationForm with the given parameters to process the link if the link was received from outside of the application; otherwise, ignore it.
The link can be used to confirm ownership of a phone number to prevent account deletion. Call sendPhoneNumberConfirmationCode with the given hash and phone number to process the link.
The link is a link to the Premium features screen of the application from which the user can subscribe to Telegram Premium. Call getPremiumFeatures with the given referrer to process the link.
The link is a link with a Telegram Premium gift code. Call checkPremiumGiftCode with the given code to process the link. If the code is valid and the user wants to apply it, then call applyPremiumGiftCode.
The link is a link to the privacy and security section of the app settings.
The link is a link to a proxy. Call addProxy with the given parameters to process the link and add the proxy.
The link is a link to a chat by its username. Call searchPublicChat with the given chat username to process the link.
The link can be used to login the current user on another device, but it must be scanned from QR-code using in-app camera. An alert similar to "This code can be used to allow someone to log in to your Telegram account. To confirm Telegram login, please go to Settings > Devices > Scan QR and scan the code" needs to be shown.
The link forces restore of App Store purchases when opened. For official iOS application only.
The link is a link to application settings.
The link is a link to a bot, which can be installed to the side menu. Call searchPublicChat with the given bot username, check that the user is a bot and can be added to attachment menu. Then, use getAttachmentMenuBot to receive information about the bot. If the bot isn't added to side menu, then show a disclaimer about Mini Apps being a third-party apps, ask the user to accept their Terms of service and confirm adding the bot to side and attachment menu. If the user accept the terms and confirms adding, then use toggleBotIsAddedToAttachmentMenu to add the bot. If the bot is added to side menu, then use getWebAppUrl with the given URL.
The link is a link to a sticker set. Call searchStickerSet with the given sticker set name to process the link and show the sticker set.
The link is a link to a story. Call searchPublicChat with the given sender username, then call getStory with the received chat identifier and the given story identifier.
The link is a link to a theme. TDLib has no theme support yet.
The link is a link to the theme section of the app settings.
The link is an unknown tg: link. Call getDeepLinkInfo to process the link.
The link is a link to an unsupported proxy. An alert can be shown to the user.
The link is a link to a user by its phone number. Call searchUserByPhoneNumber with the given phone number to process the link.
The link is a link to a user by a temporary token. Call searchUserByToken with the given token to process the link.
The link is a link to a video chat. Call searchPublicChat with the given chat username, and then joinGroupCall with the given invite hash to process the link.
The link is a link to a Web App. Call searchPublicChat with the given bot username, check that the user is a bot, then call searchWebApp with the received bot and the given web_app_short_name. Process received foundWebApp by showing a confirmation dialog if needed. If the bot can be added to attachment or side menu, but isn't added yet, then show a disclaimer about Mini Apps being a third-party apps instead of the dialog and ask the user to accept their Terms of service. If the user accept the terms and confirms adding, then use toggleBotIsAddedToAttachmentMenu to add the bot. Then, call getWebAppLinkUrl and open the returned URL as a Web App.
This class is an abstract base class. Describes the type of a chat to which points an invite link.
The link is an invite link for a basic group.
The link is an invite link for a channel.
The link is an invite link for a supergroup.
Product invoice.
Represents one member of a JSON object.
This class is an abstract base class. Represents a JSON value.
Represents a JSON array.
Represents a boolean JSON value.
Represents a null JSON value.
Represents a numeric JSON value.
Represents a JSON object.
Represents a string JSON value.
Represents a single button in a bot keyboard.
This class is an abstract base class. Describes a keyboard button type.
A button that requests a chat to be shared by the current user; available only in private chats. Use the method shareChatWithBot to complete the request.
A button that sends the user's location when pressed; available only in private chats.
A button that sends the user's phone number when pressed; available only in private chats.
A button that allows the user to create and send a poll when pressed; available only in private chats.
A button that requests a user to be shared by the current user; available only in private chats. Use the method shareUserWithBot to complete the request.
A simple button, with text that must be sent when the button is pressed.
A button that opens a Web App by calling getWebAppUrl.
Portion of the price of a product (e.g., "delivery cost", "tax amount").
Contains information about a language pack.
Represents one language pack string.
This class is an abstract base class. Represents the value of a string in a language pack.
A deleted language pack string, the value must be taken from the built-in English language pack.
An ordinary language pack string.
A language pack string which has different forms based on the number of some object it mentions. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more information.
Contains a list of language pack strings.
Options to be used for generation of a link preview.
Represents a local file.
Contains information about the current localization target.
Describes a location on planet Earth.
This class is an abstract base class. Describes a stream to which TDLib internal log is written.
The log is written to stderr or an OS specific log.
The log is written nowhere.
The log is written to a file.
Contains a list of available TDLib internal log tags.
Contains a TDLib internal log verbosity level.
This class is an abstract base class. Contains information about an inline button of type inlineKeyboardButtonTypeLoginUrl.
An HTTP URL needs to be open.
An authorization confirmation dialog needs to be shown to the user.
This class is an abstract base class. Part of the face, relative to which a mask is placed.
The mask is placed relatively to the chin.
The mask is placed relatively to the eyes.
The mask is placed relatively to the forehead.
The mask is placed relatively to the mouth.
Position on a photo where a mask is placed.
Describes a message.
A message with an animated emoji.
An animation message (GIF-style).
An audio message.
Contains default auto-delete timer setting for new chats.
A newly created basic group.
The user allowed the bot to send messages.
Contains information about found messages, split by days according to the option "utc_time_offset".
Contains information about found messages sent on a specific day.
A message with information about an ended call.
New chat members were added.
An updated chat photo.
An updated chat title.
A chat member was deleted.
A deleted chat photo.
A new member joined the chat via an invite link.
A new member was accepted to the chat by an administrator.
A new background was set in the chat.
The auto-delete or self-destruct timer for messages in the chat has been changed.
A theme in the chat has been changed.
The current user shared a chat, which was requested by the bot.
A supergroup has been created from a basic group.
A basic group was upgraded to a supergroup and was deactivated as the result.
A message with a user contact.
A contact has registered with Telegram.
This class is an abstract base class. Contains the content of a message.
Options to be used when a message content is copied without reference to the original sender. Service messages, and messages with messageInvoice or messagePremiumGiveaway content can't be copied.
A non-standard action has happened in the chat.
A dice message. The dice value is randomly generated by the server.
A document message (general file).
A self-destructed photo message.
A self-destructed video message.
This class is an abstract base class. Describes a media, which is attached to an invoice.
The media is a photo.
The media is hidden until the invoice is paid.
The media is unsupported.
The media is a video.
This class is an abstract base class. Contains information about a file with messages exported from another app.
The messages were exported from a group chat.
The messages were exported from a private chat.
The messages were exported from a chat of unknown type.
A forum topic has been created.
A forum topic has been edited.
A forum topic has been closed or opened.
A General forum topic has been hidden or unhidden.
Contains information about a forwarded message.
A message with a game.
A new high score was achieved in a game.
Telegram Premium was gifted to the user.
Contains information about a message created with importMessages.
Contains information about interactions with a message.
A message with information about an invite to a video chat.
A message with an invoice from a bot. Use getInternalLink with internalLinkTypeBotStart to share the invoice.
Contains an HTTPS link to a message in a supergroup or channel, or a forum topic.
Contains information about a link to a message or a forum topic in a chat.
A message with a location.
This class is an abstract base class. Contains information about the origin of a message.
The message was originally a post in a channel.
The message was originally sent on behalf of a chat.
The message was originally sent by a user, which is hidden by their privacy settings.
The message was originally sent by a known user.
Telegram Passport data has been received; for bots only.
Telegram Passport data has been sent to a bot.
A payment has been completed.
A payment has been completed; for bots only.
A photo message.
A message has been pinned.
A message with a poll.
Contains information about a message in a specific position.
Contains a list of message positions.
A Telegram Premium gift code was created for the user.
A Telegram Premium giveaway.
A Telegram Premium giveaway has been completed for the chat.
A Telegram Premium giveaway was created for the chat.
A user in the chat came within proximity alert range.
Contains information about a reaction to a message.
Contains information about replies to a message.
This class is an abstract base class. Contains information about the message or the story a message is replying to.
Describes a message replied by a given message.
Describes a story replied by a given message.
This class is an abstract base class. Contains information about the time when a scheduled message will be sent.
The message will be sent at the specified date.
The message will be sent when the other user is online. Applicable to private chats only and when the exact online status of the other user is known.
A screenshot of a message in the chat has been taken.
This class is an abstract base class. Describes when a message will be self-destructed.
The message can be opened only once and will be self-destructed once closed.
The message will be self-destructed in the specified time after its content was opened.
Options to be used when a message is sent.
This class is an abstract base class. Contains information about the sender of a message.
The message was sent on behalf of a chat.
The message was sent by a known user.
Represents a list of message senders.
This class is an abstract base class. Contains information about the sending state of the message.
The message failed to be sent.
The message is being sent now, but has not yet been delivered to the server.
This class is an abstract base class. Describes source of a message.
The message is from a chat event log.
The message is from a chat history.
The message is from a chat list or a forum topic list.
The message is from a forum topic history.
The message is from chat, message thread or forum topic history preview.
The message is from a message thread history.
The message is from a notification.
The message is from some other source.
The message was screenshotted; the source must be used only if the message content was visible during the screenshot.
The message is from search results, including file downloads, local file list, outgoing document messages, calendar.
Information about the sponsor of a message.
This class is an abstract base class. Describes type of a message sponsor.
The sponsor is a bot.
The sponsor is a private channel chat.
The sponsor is a public channel chat.
The sponsor is a web app.
The sponsor is a website.
A detailed statistics about a message.
A sticker message.
A message with a forwarded story.
A profile photo was suggested to a user in a private chat.
A newly created supergroup or channel.
A text message.
Contains information about a message thread.
A message content that is not supported in the current TDLib version.
The current user shared a user, which was requested by the bot.
A message with information about a venue.
A video message.
A message with information about an ended video chat.
A new video chat was scheduled.
A newly created video chat.
A video note message.
Represents a viewer of a message.
Represents a list of message viewers.
A voice note message.
Data from a Web App has been received; for bots only.
Data from a Web App has been sent to a bot.
Contains a list of messages.
Thumbnail image of a very poor quality and low resolution.
A full list of available network statistic entries.
This class is an abstract base class. Contains statistics about network usage.
Contains information about the total amount of data that was used for calls.
Contains information about the total amount of data that was used to send and receive files.
This class is an abstract base class. Represents the type of a network.
A mobile network.
A mobile roaming network.
The network is not available.
A different network type (e.g., Ethernet network).
A Wi-Fi network.
Contains information about a notification.
Describes a group of notifications.
This class is an abstract base class. Describes the type of notifications in a notification group.
A group containing notifications of type notificationTypeNewCall.
A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with unread mentions of the current user, replies to their messages, or a pinned message.
A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with ordinary unread messages.
A group containing a notification of type notificationTypeNewSecretChat.
This class is an abstract base class. Describes the types of chats to which notification settings are relevant.
Notification settings applied to all channel chats when the corresponding chat setting has a default value.
Notification settings applied to all basic group and supergroup chats when the corresponding chat setting has a default value.
Notification settings applied to all private and secret chats when the corresponding chat setting has a default value.
Describes a notification sound in MP3 format.
Contains a list of notification sounds.
This class is an abstract base class. Contains detailed information about a notification.
New call was received.
New message was received.
New message was received through a push notification.
New secret chat was created.
An object of this type is returned on a successful function call for certain functions.
This class is an abstract base class. Represents the value of an option.
Represents a boolean option.
Represents an unknown option or an option which has a default value.
Represents an integer option.
Represents a string option.
Order information.
This class is an abstract base class. Describes a block of an instant view web page.
An invisible anchor on a page, which can be used in a URL to open the page from the specified anchor.
An animation.
An audio file.
The author and publishing date of a page.
A block quote.
Contains a caption of an instant view web page block, consisting of a text and a trailing credit.
A link to a chat.
A collage.
A page cover.
A collapsible block.
An empty block separating a page.
An embedded web page.
An embedded post.
The footer of a page.
A header.
This class is an abstract base class. Describes a horizontal alignment of a table cell content.
The content must be center-aligned.
The content must be left-aligned.
The content must be right-aligned.
A kicker.
A list of data blocks.
Describes an item of a list page block.
A map.
A text paragraph.
A photo.
A preformatted text paragraph.
A pull quote.
Contains information about a related article.
Related articles.
A slideshow.
A subheader.
The subtitle of a page.
A table.
Represents a cell of a table.
The title of a page.
This class is an abstract base class. Describes a Vertical alignment of a table cell content.
The content must be bottom-aligned.
The content must be middle-aligned.
The content must be top-aligned.
A video.
A voice note.
Contains information about a Telegram Passport authorization form that was requested.
This class is an abstract base class. Contains information about a Telegram Passport element.
A Telegram Passport element containing the user's address.
A Telegram Passport element containing the user's bank statement.
A Telegram Passport element containing the user's driver license.
A Telegram Passport element containing the user's email address.
Contains the description of an error in a Telegram Passport element.
This class is an abstract base class. Contains the description of an error in a Telegram Passport element.
One of the data fields contains an error. The error will be considered resolved when the value of the field changes.
The file contains an error. The error will be considered resolved when the file changes.
The list of attached files contains an error. The error will be considered resolved when the list of files changes.
The front side of the document contains an error. The error will be considered resolved when the file with the front side changes.
The reverse side of the document contains an error. The error will be considered resolved when the file with the reverse side changes.
The selfie with the document contains an error. The error will be considered resolved when the file with the selfie changes.
One of files with the translation of the document contains an error. The error will be considered resolved when the file changes.
The translation of the document contains an error. The error will be considered resolved when the list of translation files changes.
The element contains an error in an unspecified place. The error will be considered resolved when new data is added.
A Telegram Passport element containing the user's identity card.
A Telegram Passport element containing the user's internal passport.
A Telegram Passport element containing the user's passport.
A Telegram Passport element containing the user's passport registration pages.
A Telegram Passport element containing the user's personal details.
A Telegram Passport element containing the user's phone number.
A Telegram Passport element containing the user's rental agreement.
A Telegram Passport element containing the user's temporary registration.
This class is an abstract base class. Contains the type of a Telegram Passport element.
A Telegram Passport element containing the user's address.
A Telegram Passport element containing the user's bank statement.
A Telegram Passport element containing the user's driver license.
A Telegram Passport element containing the user's email address.
A Telegram Passport element containing the user's identity card.
A Telegram Passport element containing the user's internal passport.
A Telegram Passport element containing the user's passport.
A Telegram Passport element containing the registration page of the user's passport.
A Telegram Passport element containing the user's personal details.
A Telegram Passport element containing the user's phone number.
A Telegram Passport element containing the user's rental agreement.
A Telegram Passport element containing the user's temporary registration.
A Telegram Passport element containing the user's utility bill.
A Telegram Passport element containing the user's utility bill.
Contains information about saved Telegram Passport elements.
Contains information about a Telegram Passport elements and corresponding errors.
Contains a description of the required Telegram Passport element that was requested by a service.
Contains information about a Telegram Passport element that was requested by a service.
Represents the current state of 2-step verification.
Contains information about an invoice payment form.
Describes an additional payment option.
This class is an abstract base class. Contains information about a payment provider.
Some other payment provider, for which a web payment form must be shown.
Smart Glocal payment provider.
Stripe payment provider.
Contains information about a successful payment.
Contains the result of a payment request.
Contains the user's personal details.
A personal document, containing some information about a user.
Contains settings for the authentication of the user's phone number.
Contains information about a phone number.
Describes a photo.
Describes an image in JPEG format.
A point on a Cartesian plane.
Describes a poll.
Describes one answer option of a poll.
This class is an abstract base class. Describes the type of a poll.
A poll in quiz mode, which has exactly one correct answer option and can be answered only once.
A regular poll.
This class is an abstract base class. Describes a feature available to Premium users.
The ability to choose accent color for replies and user profile.
Ability to change position of the main chat list, archive and mute all new chats from non-contacts, and completely disable notifications about the user's contacts joined Telegram.
Profile photo animation on message and chat screens.
Allowed to set a premium application icons.
The ability to set private chat background for both users.
The ability to boost chats.
Allowed to use custom emoji stickers in message texts and captions.
Disabled ads.
An emoji status shown along with the user's name.
The ability to set a custom emoji as a forum topic icon.
Improved download speed.
Increased limits.
Increased maximum upload file size.
A badge in the user's profile.
Describes a promotion animation for a Premium feature.
Allowed to translate chat messages real-time.
Allowed to use more reactions.
Allowed to use premium stickers with unique effects.
Allowed to use many additional features for stories.
The ability to convert voice notes to text.
Contains information about features, available to Premium users.
Contains information about a Telegram Premium gift code.
Describes an option for creating Telegram Premium gift codes.
Contains a list of options for creating Telegram Premium gift codes.
This class is an abstract base class. Contains information about Telegram Premium giveaway.
Describes a completed giveaway.
Describes an ongoing giveaway.
Describes parameters of a Telegram Premium giveaway.
This class is an abstract base class. Contains information about status of a user in a Telegram Premium giveaway.
The user can't participate in the giveaway, because they are an administrator in one of the chats that created the giveaway.
The user can't participate in the giveaway, because they have already been member of the chat.
The user can't participate in the giveaway, because they phone number is from a disallowed country.
The user is eligible for the giveaway.
The user participates in the giveaway.
Contains information about a limit, increased for Premium users.
This class is an abstract base class. Describes type of a limit, increased for Premium users.
The maximum number of active stories.
The maximum length of the user's bio.
The maximum length of sent media caption.
The maximum number of pinned and always included, or always excluded chats in a chat folder.
The maximum number of chat folders.
The maximum number of invite links for a chat folder.
The maximum number of created public chats.
The maximum number of favorite stickers.
The maximum number of stories sent per month.
The maximum number of pinned chats in the archive chat list.
The maximum number of pinned chats in the main chat list.
The maximum number of saved animations.
The maximum number of added shareable chat folders.
The maximum number of received similar chats.
The maximum length of captions of sent stories.
The maximum number of suggested reaction areas on a story.
The maximum number of joined supergroups and channels.
The maximum number of stories sent per week.
Describes an option for buying Telegram Premium to a user.
This class is an abstract base class. Describes a source from which the Premium features screen is opened.
A user tried to use a Premium feature.
A limit was exceeded.
A user opened an internal link of the type internalLinkTypePremiumFeatures.
A user opened the Premium features screen from settings.
A user tried to use a Premium story feature.
Contains state of Telegram Premium subscription and promotion videos for Premium features.
Describes an option for buying or upgrading Telegram Premium for self.
This class is an abstract base class. Describes a story feature available to Premium users.
The ability to set custom expiration duration for stories.
The ability to use links and formatting in story caption.
The ability to check who opened the current user's stories after they expire.
User stories are displayed before stories of non-premium contacts and channels.
The ability to save other's unprotected stories.
The ability to hide the fact that the user viewed other's stories.
Describes a prepaid Telegram Premium giveaway.
Contains information about supported accent color for user profile photo background.
Contains information about supported accent colors for user profile photo background in RGB format.
Describes a user profile photo.
Represents a list of proxy servers.
Contains information about a proxy server.
This class is an abstract base class. Describes the type of a proxy server.
A HTTP transparent proxy server.
An MTProto proxy server.
A SOCKS5 proxy server.
This class is an abstract base class. Describes a type of public chats.
The chat is public, because it has an active username.
The chat is public, because it is a location-based supergroup.
This class is an abstract base class. Contains content of a push message notification.
An animation message (GIF-style).
An audio message.
A newly created basic group.
New chat members were invited to a group.
A chat photo was edited.
A chat title was edited.
A chat member was deleted.
A new member joined the chat via an invite link.
A new member was accepted to the chat by an administrator.
A chat background was edited.
A chat theme was edited.
A message with a user contact.
A contact has registered with Telegram.
A document message (a general file).
A message with a game.
A new high score was achieved in a game.
A general message with hidden content.
A message with an invoice from a bot.
A message with a location.
A media album.
A forwarded messages.
A photo message.
A message with a poll.
A message with a Telegram Premium gift code created for the user.
A message with a Telegram Premium giveaway.
A new recurring payment was made by the current user.
A screenshot of a message in the chat has been taken.
A message with a sticker.
A message with a story.
A profile photo was suggested to the user.
A text message.
A video message.
A video note message.
A voice note message.
Contains a globally unique push receiver identifier, which can be used to identify which account has received a push notification.
This class is an abstract base class. Describes type of message reaction.
A reaction with a custom emoji.
A reaction with an emoji.
Describes a recommended chat folder.
Contains a list of recommended chat folders.
Contains information about the current recovery email address.
Represents a remote file.
This class is an abstract base class. Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots.
Instructs application to force a reply to this message.
Contains an inline keyboard layout.
Instructs application to remove the keyboard once this message has been received. This kind of keyboard can't be received in an incoming message; instead, updateChatReplyMarkup with message_id == 0 will be sent.
Contains a custom keyboard layout to quickly reply to bots.
This class is an abstract base class. Describes the reason why a chat is reported.
The chat has child abuse related content.
The chat contains copyrighted content.
A custom reason provided by the user.
The chat represents a fake account.
The chat has illegal drugs related content.
The chat contains messages with personal details.
The chat contains pornographic messages.
The chat contains spam messages.
The location-based chat is unrelated to its stated location.
The chat promotes violence.
This class is an abstract base class. Represents result of 2-step verification password reset.
The password reset request was declined.
The password was reset.
The password reset request is pending.
This class is an abstract base class. Describes a text object inside an instant-view web page.
An anchor.
A link to an anchor on the same web page.
A bold rich text.
A rich text email link.
A fixed-width rich text.
A small image inside the text.
An italicized rich text.
A marked rich text.
A rich text phone number.
A plain text.
A reference to a richTexts object on the same web page.
A strikethrough rich text.
A subscript rich text.
A superscript rich text.
An underlined rich text.
A rich text URL link.
A concatenation of rich texts.
Represents an RTMP URL.
Contains information about saved payment credentials.
Contains autosave settings for an autosave settings scope.
Contains information about notification settings for several chats.
This class is an abstract base class. Represents a filter for message search results.
Returns only animation messages.
Returns only audio messages.
Returns only messages containing chat photos.
Returns only document messages.
Returns all found messages, no filter is applied.
Returns only failed to send messages. This filter can be used only if the message database is used.
Returns only messages with mentions of the current user, or messages that are replies to their messages.
Returns only photo messages.
Returns only photo and video messages.
Returns only pinned messages.
Returns only messages with unread mentions of the current user, or messages that are replies to their messages. When using this filter the results can't be additionally filtered by a query, a message thread or by the sending user.
Returns only messages with unread reactions for the current user. When using this filter the results can't be additionally filtered by a query, a message thread or by the sending user.
Returns only messages containing URLs.
Returns only video messages.
Returns only video note messages.
Returns only voice and video note messages.
Returns only voice note messages.
Contains a value representing a number of seconds.
Represents a secret chat.
This class is an abstract base class. Describes the current secret chat state.
The secret chat is closed.
The secret chat is not yet created; waiting for the other user to get online.
The secret chat is ready to use.
Information about the message sent by answerWebAppQuery.
Contains information about one session in a Telegram application used by the current user. Sessions must be shown to the user in the returned order.
This class is an abstract base class. Represents the type of a session.
The session is running on an Android device.
The session is running on a generic Apple device.
The session is running on the Brave browser.
The session is running on the Chrome browser.
The session is running on the Edge browser.
The session is running on the Firefox browser.
The session is running on an iPad device.
The session is running on an iPhone device.
The session is running on a Linux device.
The session is running on a Mac device.
The session is running on the Opera browser.
The session is running on the Safari browser.
The session is running on an Ubuntu device.
The session is running on an unknown type of device.
The session is running on the Vivaldi browser.
The session is running on a Windows device.
The session is running on an Xbox console.
Contains a list of sessions.
One shipping option.
This class is an abstract base class. Describes result of speech recognition in a voice note.
The speech recognition failed.
The speech recognition is ongoing.
The speech recognition successfully finished.
Describes a sponsored message.
Contains a list of sponsored messages.
This class is an abstract base class. Describes a statistical graph.
The graph data to be asynchronously loaded through getStatisticalGraph.
A graph data.
An error message to be shown to the user instead of the graph.
A value with information about its recent changes.
Describes a sticker.
This class is an abstract base class. Describes format of a sticker.
The sticker is an animation in TGS format.
The sticker is a video in WEBM format.
The sticker is an image in WEBP format.
This class is an abstract base class. Contains full information about sticker type.
The sticker is a custom emoji to be used inside message text and caption. Currently, only Telegram Premium users can use custom emoji.
The sticker is a mask in WEBP format to be placed on photos or videos.
The sticker is a regular sticker.
Represents a sticker set.
Represents short information about a sticker set.
Represents a list of sticker sets.
This class is an abstract base class. Describes type of a sticker.
The sticker is a custom emoji to be used inside message text and caption.
The sticker is a mask in WEBP format to be placed on photos or videos.
The sticker is a regular sticker.
Represents a list of stickers.
Contains the exact storage usage statistics split by chats and file type.
Contains the storage usage statistics for a specific chat.
Contains the storage usage statistics for a specific file type.
Contains approximate storage usage statistics, excluding files of unknown file type.
This class is an abstract base class. Describes a purpose of an in-store payment.
The user gifting Telegram Premium to another user.
The user creating Telegram Premium gift codes for other users.
The user creating a Telegram Premium giveaway for subscribers of channel chats; requires can_post_messages rights in the channels.
The user subscribing to Telegram Premium.
Represents a list of stories.
Represents a story.
Describes a clickable rectangle area on a story media.
Describes position of a clickable rectangle area on a story media.
This class is an abstract base class. Describes type of a clickable rectangle area on a story media.
An area pointing to a location.
An area pointing to a suggested reaction. App needs to show a clickable reaction on the area and call setStoryReaction when the are is clicked.
An area pointing to a venue.
This class is an abstract base class. Contains the content of a story.
A photo story.
A story content that is not supported in the current TDLib version.
A video story.
Contains identifier of a story along with identifier of its sender.
Contains basic information about a story.
Contains information about interactions with a story.
This class is an abstract base class. Describes a list of stories.
The list of stories, shown in the Arvhive chat list.
The list of stories, shown in the main chat list and folder chat lists.
This class is an abstract base class. Contains information about the origin of a story that was reposted.
The original story was sent by an unknown user.
The original story was a public story with known sender.
This class is an abstract base class. Describes privacy settings of a story.
The story can be viewed by all close friends.
The story can be viewed by all contacts except chosen users.
The story can be viewed by everyone.
The story can be viewed by certain specified users.
This class is an abstract base class. Describes a public forward or repost of a story.
Contains a public forward of a story as a message.
Contains a public repost of a story as a story.
Represents a list of public forwards and reposts of a story.
Contains information about original story that was reposted.
A detailed statistics about a story.
Describes a video file sent in a story.
Represents a viewer of a story.
Represents a list of story viewers.
This class is an abstract base class. Describes an action suggested to the current user.
Suggests the user to check whether they still remember their 2-step verification password.
Suggests the user to check whether authorization phone number is correct and change the phone number if it is inaccessible.
Suggests the user to convert specified supergroup to a broadcast group.
Suggests the user to enable archive_and_mute_new_chats_from_unknown_users setting in archiveChatListSettings.
Suggests the user to restore a recently expired Premium subscription.
Suggests the user to set a 2-step verification password to be able to log in again.
Suggests the user to subscribe to the Premium subscription with annual payments.
Suggests the user to upgrade the Premium subscription from monthly payments to annual payments.
Suggests the user to view a hint about the meaning of one and two check marks on sent messages.
Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers.
Contains full information about a supergroup or channel.
This class is an abstract base class. Specifies the kind of chat members to return in getSupergroupMembers.
Returns the owner and administrators.
Returns users banned from the supergroup or channel; can be used only by administrators.
Returns bot members of the supergroup or channel.
Returns contacts of the user, which are members of the supergroup or channel.
Returns users which can be mentioned in the supergroup.
Returns recently active users in reverse chronological order.
Returns restricted supergroup members; can be used only by administrators.
Used to search for supergroup or channel members via a (string) query.
Represents a URL linking to an internal Telegram entity.
This class is an abstract base class. Describes the type of a URL linking to an internal Telegram entity.
A chat invite link.
A URL linking to a sticker set.
A URL linking to a public supergroup or channel.
A URL linking to a user.
Contains a list of t.me URLs.
This class is an abstract base class. Describes the target chat to be opened.
The chat needs to be chosen by the user among chats of the specified types.
The currently opened chat needs to be kept.
The chat needs to be open with the provided internal link.
This class is an abstract base class. Describes a purpose of a payment toward Telegram.
The user creating Telegram Premium gift codes for other users.
The user creating a Telegram Premium giveaway for subscribers of channel chats; requires can_post_messages rights in the channels.
Returns information about the availability of a temporary password, which can be used for payments.
Contains Telegram terms of service.
A simple object containing a sequence of bytes; for testing only.
A simple object containing a number; for testing only.
A simple object containing a string; for testing only.
A simple object containing a vector of numbers; for testing only.
A simple object containing a vector of objects that hold a number; for testing only.
A simple object containing a vector of strings; for testing only.
A simple object containing a vector of objects that hold a string; for testing only.
Contains some text.
Contains a list of text entities.
Represents a part of the text that needs to be formatted in some unusual way.
This class is an abstract base class. Represents a part of the text which must be formatted differently.
A bank card number. The getBankCardInfo method can be used to get information about the bank card.
Text that must be formatted as if inside a blockquote HTML tag.
A bold text.
A bot command, beginning with "/".
A cashtag text, beginning with "$" and consisting of capital English letters (e.g., "$USD").
Text that must be formatted as if inside a code HTML tag.
A custom emoji. The text behind a custom emoji must be an emoji. Only premium users can use premium custom emoji.
An email address.
A hashtag text, beginning with "#".
An italic text.
A media timestamp.
A mention of a user, a supergroup, or a channel by their username.
A text shows instead of a raw mention of the user (e.g., when the user has no username).
A phone number.
Text that must be formatted as if inside a pre HTML tag.
Text that must be formatted as if inside pre, and code HTML tags.
A spoiler text.
A strikethrough text.
A text description shown instead of a raw URL.
An underlined text.
An HTTP URL.
This class is an abstract base class. Describes the way the text needs to be parsed for text entities.
The text uses HTML-style formatting. The same as Telegram Bot API "HTML" parse mode.
The text uses Markdown-style formatting.
Describes manually or automatically chosen quote from another message.
Contains parameters of the application theme.
Describes theme settings.
Represents a thumbnail.
This class is an abstract base class. Describes format of a thumbnail.
The thumbnail is in static GIF format. It will be used only for some bot inline query results.
The thumbnail is in JPEG format.
The thumbnail is in MPEG4 format. It will be used only for some animations and videos.
The thumbnail is in PNG format. It will be used only for background patterns.
The thumbnail is in TGS format. It will be used only for TGS sticker sets.
The thumbnail is in WEBM format. It will be used only for WEBM sticker sets.
The thumbnail is in WEBP format. It will be used only for some stickers.
This class is an abstract base class. Represents the categories of chats for which a list of frequently used chats can be retrieved.
A category containing frequently used private chats with bot users.
A category containing frequently used chats used for calls.
A category containing frequently used channels.
A category containing frequently used chats used to forward messages.
A category containing frequently used basic groups and supergroups.
A category containing frequently used chats with inline bots sorted by their usage in inline mode.
A category containing frequently used private chats with non-bot users.
Represents a list of trending sticker sets.
Contains information about an unconfirmed session.
Contains information about an unread reaction to a message.
This class is an abstract base class. Contains notifications about data changes.
The list of supported accent colors has changed.
The list of active emoji reactions has changed.
Contains active notifications that were shown on previous application launches. This update is sent only if the message database is used. In that case it comes once before any updateNotification and updateNotificationGroup update.
Adding users to a chat has failed because of their privacy settings. An invite link can be shared with the users if appropriate.
Some animated emoji message was clicked and a big animated sticker must be played if the message is visible on the screen. chatActionWatchingAnimations with the text of the message needs to be sent if the sticker is played.
The parameters of animation search through getOption("animation_search_bot_username") bot has changed.
The list of bots added to attachment or side menu has changed.
The user authorization state has changed.
Autosave settings for some type of chats were updated.
Some data of a basic group has changed. This update is guaranteed to come before the basic group identifier is returned to the application.
Some data in basicGroupFullInfo has been changed.
New call was created or information about a call was updated.
A chat accent color has changed.
A message sender activity in the chat has changed.
The chat action bar was changed.
The list of active stories posted by a specific chat has changed.
The chat available reactions were changed.
The chat background was changed.
A chat's custom emoji for reply background has changed.
A chat was blocked or unblocked.
A chat boost has changed; for bots only.
The value of the default disable_notification parameter, used when a message is sent to the chat, was changed.
A chat draft has changed. Be aware that the update may come in the currently opened chat but with old content of the draft. If the user has changed the content of the draft, this update mustn't be applied.
The list of chat folders or a chat folder has changed.
A chat content was allowed or restricted for saving.
A chat's has_scheduled_messages field has changed.
A chat was marked as unread or was read.
Translation of chat messages was enabled or disabled.
The last message of a chat was changed.
User rights changed in a chat; for bots only.
The message auto-delete or self-destruct timer setting for a chat was changed.
The message sender that is selected to send messages in a chat has changed.
Notification settings for a chat were changed.
The number of online group members has changed. This update with non-zero number of online group members is sent only for currently opened chats. There is no guarantee that it is sent just after the number of online users has changed.
The chat pending join requests were changed.
Chat permissions were changed.
A chat photo was changed.
The position of a chat in a chat list has changed. An updateChatLastMessage or updateChatDraftMessage update might be sent instead of the update.
Incoming messages were read or the number of unread messages has been changed.
Outgoing messages were read.
The default chat reply markup was changed. Can occur because new messages with reply markup were received or because an old reply markup was hidden by the user.
The chat theme was changed.
The list of available chat themes has changed.
The title of a chat was changed.
The chat unread_mention_count has changed.
The chat unread_reaction_count has changed.
A chat video chat state has changed.
A chat default appearance has changed.
The connection state has changed. This update must be used only to show a human-readable description of the connection state.
The type of default reaction has changed.
Some messages were deleted.
The list of supported dice emojis has changed.
The list of favorite stickers was updated.
Information about a file was updated.
A file was added to the file download list. This update is sent only after file download list is loaded for the first time.
A file download was changed. This update is sent only after file download list is loaded for the first time.
The state of the file download list has changed.
The file generation process needs to be started by the application.
File generation is no longer needed.
A file was removed from the file download list. This update is sent only after file download list is loaded for the first time.
Basic information about a topic in a forum chat was changed.
Information about a group call was updated.
Information about a group call participant was changed. The updates are sent only after the group call is received through getGroupCall and only if the call is joined or being joined.
Describes whether there are some pending notification updates. Can be used to prevent application from killing, while there are some pending notifications.
The list of installed sticker sets was updated.
Some language pack strings have been updated.
The message content has changed.
The message content was opened. Updates voice note messages to "listened", video note messages to "viewed" and starts the self-destruct timer.
A message was edited. Changes in the message content will come in a separate updateMessageContent.
The information about interactions with a message has changed.
The message pinned state was changed.
A message with a live location was viewed. When the update is received, the application is supposed to update the live location.
A message with an unread mention was read.
A request to send a message has reached the Telegram server. This doesn't mean that the message will be sent successfully. This update is sent only if the option "use_quick_ack" is set to true. This update may be sent multiple times for the same message.
A message failed to send. Be aware that some messages being sent can be irrecoverably deleted, in which case updateDeleteMessages will be received instead of this update.
A message has been successfully sent.
The list of unread reactions added to a message was changed.
New call signaling data arrived.
A new incoming callback query; for bots only.
A new chat has been loaded/created. This update is guaranteed to come before the chat identifier is returned to the application. The chat field changes will be reported through separate updates.
A user sent a join request to a chat; for bots only.
The user has chosen a result of an inline query; for bots only.
A new incoming event; for bots only.
A new incoming query; for bots only.
A new incoming callback query from a message sent via a bot; for bots only.
A new incoming inline query; for bots only.
A new message was received; can also be an outgoing message.
A new incoming pre-checkout query; for bots only. Contains full information about a checkout.
A new incoming shipping query; for bots only. Only for invoices with flexible price.
A notification was changed.
A list of active notifications in a notification group has changed.
An option changed its value.
A poll was updated; for bots only.
A user changed the answer to a poll; for bots only.
The list of supported accent colors for user profiles has changed.
The list of recently used stickers was updated.
The list of saved animations was updated.
The list of saved notification sounds was updated. This update may not be sent until information about a notification sound was requested for the first time.
Notification settings for some type of chats were updated.
Some data of a secret chat has changed. This update is guaranteed to come before the secret chat identifier is returned to the application.
The selected background has changed.
A service notification from the server was received. Upon receiving this the application must show a popup with the content of the notification.
The parameters of speech recognition without Telegram Premium subscription has changed.
A sticker set has changed.
A story was changed.
A story became inaccessible.
Number of chats in a story list has changed.
A story failed to send. If the story sending is canceled, then updateStoryDeleted will be received instead of this update.
A story has been successfully sent.
Story stealth mode settings have changed.
The list of suggested to the user actions has changed.
Some data of a supergroup or a channel has changed. This update is guaranteed to come before the supergroup identifier is returned to the application.
Some data in supergroupFullInfo has been changed.
New terms of service must be accepted by the user. If the terms of service are declined, then the deleteAccount method must be called with the reason "Decline ToS update".
The list of trending sticker sets was updated or some of them were viewed.
The first unconfirmed session has changed.
Number of unread chats, i.e. with unread messages or marked as unread, has changed. This update is sent only if the message database is used.
Number of unread messages in a chat list has changed. This update is sent only if the message database is used.
Some data of a user has changed. This update is guaranteed to come before the user identifier is returned to the application.
Some data in userFullInfo has been changed.
Some privacy setting rules have been changed.
The user went online or offline.
The list of users nearby has changed. The update is guaranteed to be sent only 60 seconds after a successful searchChatsNearby request.
A message was sent by an opened Web App, so the Web App needs to be closed.
Contains a list of updates.
Represents a user.
Contains full information about a user.
Contains an HTTPS URL, which can be used to get information about a user.
This class is an abstract base class. Describes available user privacy settings.
A privacy setting for managing whether the user can be called.
A privacy setting for managing whether the user can be invited to chats.
A privacy setting for managing whether the user can be found by their phone number. Checked only if the phone number is not known to the other user. Can be set only to "Allow contacts" or "Allow all".
A privacy setting for managing whether peer-to-peer connections can be used for calls.
A privacy setting for managing whether the user can receive voice and video messages in private chats.
This class is an abstract base class. Represents a single rule for managing user privacy settings.
A rule to allow all users to do something.
A rule to allow all members of certain specified basic groups and supergroups to doing something.
A rule to allow all contacts of the user to do something.
A rule to allow certain specified users to do something.
A rule to restrict all users from doing something.
A rule to restrict all members of specified basic groups and supergroups from doing something.
A rule to restrict all contacts of the user from doing something.
A rule to restrict all specified users from doing something.
A list of privacy rules. Rules are matched in the specified order. The first matched rule defines the privacy setting for a given user. If no rule matches, the action is not allowed.
A privacy setting for managing whether the user's bio is visible.
A privacy setting for managing whether a link to the user's account is included in forwarded messages.
A privacy setting for managing whether the user's phone number is visible.
A privacy setting for managing whether the user's profile photo is visible.
A privacy setting for managing whether the user's online status is visible.
This class is an abstract base class. Describes the last time the user was online.
The user status was never changed.
The user is offline, but was online last month.
The user is offline, but was online last week.
The user is offline.
The user is online.
The user was online recently.
Contains custom information about the user.
This class is an abstract base class. Represents the type of a user. The following types are possible: regular users, deleted users and bots.
A bot (see https://core.telegram.org/bots).
A deleted user or deleted bot. No information on the user besides the user identifier is available. It is not possible to perform any active actions on this type of user.
A regular user.
No information on the user besides the user identifier is available, yet this user has not been deleted. This object is extremely rare and must be handled like a deleted user. It is not possible to perform any actions on users of this type.
Describes usernames assigned to a user, a supergroup, or a channel.
Represents a list of users.
Contains a temporary identifier of validated order information, which is stored for one hour, and the available shipping options.
This class is an abstract base class. Represents a vector path command.
A cubic Bézier curve to a given point.
A straight line to a given point.
Describes a venue.
Describes a video file.
Describes a video chat.
Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format.
Describes a voice note. The voice note must be encoded with the Opus codec, and stored inside an OGG container. Voice notes can have only a single audio channel.
Describes a Web App. Use getInternalLink with internalLinkTypeWebApp to share the Web App.
Contains information about a Web App.
Describes a link preview.
Describes an instant view page for a web page.