Skip to content

Functions

A B C D E F G H I J L M O P R S T U V W

A

  • acceptCall — Accepts an incoming call
  • acceptOauthRequest — Accepts an OAuth authorization request. Returns an HTTP URL to open after successful authorization. May return an emp...
  • acceptTermsOfService — Accepts Telegram terms of service
  • activateStoryStealthMode — Activates stealth mode for stories, which hides all views of stories from the current user in the last "story_stealth...
  • addBotMediaPreview — Adds a new media preview to the beginning of the list of media previews of a bot. Returns the added preview after add...
  • addChatFolderByInviteLink — Adds a chat folder by an invite link
  • addChatMember — Adds a new member to a chat; requires can_invite_users member right. Members can't be added to private or secret chat...
  • addChatMembers — Adds multiple new members to a chat; requires can_invite_users member right. Currently, this method is available only...
  • addChatToList — Adds a chat to a chat list. A chat can't be simultaneously in Main and Archive chat lists, so it is automatically rem...
  • addChatWelcomeMessage — Adds a message to the list of welcome messages of a chat; requires can_send_welcome_messages administrator right in t...
  • addChecklistTasks — Adds tasks to a checklist in a message
  • addContact — Adds a user to the contact list or edits an existing contact by their user identifier
  • addCustomServerLanguagePack — Adds a custom server language pack to the list of installed language packs in current localization target. Can be cal...
  • addFavoriteSticker — Adds a new sticker to the list of favorite stickers. The new sticker is added to the top of the list. If the sticker ...
  • addFileToDownloads — Adds a file from a message to the list of file downloads. Download progress and completion of the download will be no...
  • addGiftCollectionGifts — Adds gifts to the beginning of a previously created collection. If the collection is owned by a channel chat, then re...
  • addLocalMessage — Adds a local message to a chat. The message is persistent across application restarts only if the message database is...
  • addLoginPasskey — Adds a passkey allowed to be used for the login by the current user and returns the added passkey. Call getPasskeyPar...
  • addLogMessage — Adds a message to TDLib internal log. Can be called synchronously
  • addMessageReaction — Adds a reaction or a tag to a message. Use getMessageAvailableReactions to receive the list of available reactions fo...
  • addNetworkStatistics — Adds the specified data to data usage statistics. Can be called before authorization
  • addOffer — Sends a suggested post based on a previously sent message in a channel direct messages chat. Can be also used to sugg...
  • addPendingLiveStoryReaction — Adds pending paid reaction in a live story group call. Can't be used in live stories posted by the current user. Call...
  • addPendingPaidMessageReaction — Adds the paid message reaction to a message. Use getMessageAvailableReactions to check whether the reaction is availa...
  • addPollOption — Adds an option to a poll
  • addProfileAudio — Adds an audio file to the beginning of the profile audio files of the current user
  • addProxy — Adds a proxy server for network requests. Can be called before authorization
  • addQuickReplyShortcutInlineQueryResultMessage — Adds a message to a quick reply shortcut via inline bot. If shortcut doesn't exist and there are less than getOption(...
  • addQuickReplyShortcutMessage — Adds a message to a quick reply shortcut. If shortcut doesn't exist and there are less than getOption("quick_reply_sh...
  • addQuickReplyShortcutMessageAlbum — Adds 2-10 messages grouped together into an album to a quick reply shortcut. Currently, only audio, document, photo a...
  • addRecentlyFoundChat — Adds a chat to the list of recently found chats. The chat is added to the beginning of the list. If the chat is alrea...
  • addRecentSticker — Manually adds a new sticker to the list of recently used stickers. The new sticker is added to the top of the list. I...
  • addSavedAnimation — Manually adds a new animation to the list of saved animations. The new animation is added to the beginning of the lis...
  • addSavedNotificationSound — Adds a new notification sound to the list of saved notification sounds. The new notification sound is added to the to...
  • addStickerToSet — Adds a new sticker to a set
  • addStoryAlbumStories — Adds stories to the beginning of a previously created story album. If the album is owned by a supergroup or a channel...
  • addTextCompositionStyle — Adds a custom text composition style to the list of used by the user styles. May return an error with a message "TONE...
  • addWebBrowserSettingsException — Adds a special handling for the opening of the specified URL
  • allowBotToSendMessages — Allows the specified bot to send messages to the user
  • allowUnpaidMessagesFromUser — Allows the specified user to send unpaid private messages to the current user by adding a rule to userPrivacySettingA...
  • answerCallbackQuery — Sets the result of a callback query; for bots only
  • answerChatJoinRequestQuery — Sets the result of a chat join query; for bots only
  • answerCustomQuery — Answers a custom query; for bots only
  • answerGuestQuery — Sets the result of a guest query; for bots only
  • answerInlineQuery — Sets the result of an inline query; for bots only
  • answerPreCheckoutQuery — Sets the result of a pre-checkout query; for bots only
  • answerShippingQuery — Sets the result of a shipping query; for bots only
  • answerWebAppQuery — Sets the result of interaction with a Web App and sends corresponding message on behalf of the user to the chat from ...
  • applyPremiumGiftCode — Applies a Telegram Premium gift code
  • approveSuggestedPost — Approves a suggested post in a channel direct messages chat
  • assignStoreTransaction — Informs server about an in-store purchase. For official applications only

B

  • banChatMember — Bans a member in a chat; requires can_restrict_members administrator right. Members can't be banned in private or sec...
  • banGroupCallParticipants — Bans users from a group call not bound to a chat; requires groupCall.is_owned. Only the owner of the group call can i...
  • blockMessageSenderFromReplies — Blocks an original sender of a message in the Replies chat
  • boostChat — Boosts a chat and returns the list of available chat boost slots for the current user after the boost
  • buyGiftUpgrade — Pays for upgrade of a regular gift that is owned by another user or channel chat

C

  • canBotSendMessages — Checks whether the specified bot can send messages to the user. Returns a 404 error if can't and the access can be gr...
  • cancelDownloadFile — Stops the downloading of a file. If a file has already been downloaded, does nothing
  • cancelPasswordReset — Cancels reset of 2-step verification password. The method can be called if passwordState.pending_reset_date > 0
  • cancelPreliminaryUploadFile — Stops the preliminary uploading of a file. Supported only for files uploaded by using preliminaryUploadFile
  • cancelRecoveryEmailAddressVerification — Cancels verification of the 2-step verification recovery email address
  • canPostStory — Checks whether the current user can post a story on behalf of a chat; requires can_post_stories administrator right f...
  • canPurchaseFromStore — Checks whether an in-store purchase is possible. Must be called before any in-store purchase. For official applicatio...
  • canSendGift — Checks whether a gift with next_send_date in the future can be sent already
  • canSendMessageToUser — Checks whether the current user can message another user or try to create a chat with them
  • canTransferOwnership — Checks whether the current session can be used to transfer a chat ownership to another user
  • changeImportedContacts — Changes imported contacts using the list of contacts saved on the device. Imports newly added contacts and, if at lea...
  • changeStickerSet — Installs/uninstalls or activates/archives a sticker set
  • changeWebBrowserSettings — Changes web browser settings
  • checkAuthenticationBotToken — Checks the authentication token of a bot; to log in as a bot. Works only when the current authorization state is auth...
  • checkAuthenticationCode — Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode
  • checkAuthenticationEmailCode — Checks the authentication of an email address. Works only when the current authorization state is authorizationStateW...
  • checkAuthenticationPasskey — Checks a passkey to log in to the corresponding account. Call getAuthenticationPasskeyParameters to get parameters fo...
  • checkAuthenticationPassword — Checks the 2-step verification password for correctness. Works only when the current authorization state is authoriza...
  • checkAuthenticationPasswordRecoveryCode — Checks whether a 2-step verification password recovery code sent to an email address is valid. Works only when the cu...
  • checkAuthenticationPremiumPurchase — Checks whether an in-store purchase of Telegram Premium is possible before authorization. Works only when the current...
  • checkAuthenticationWebToken — Checks a web token to log in to the corresponding account; for official Telegram apps only. Works only when the curre...
  • checkBotUsername — Checks whether a username can be set for a new bot. Use checkChatUsername to check username for other chat types
  • checkChatFolderInviteLink — Checks the validity of an invite link for a chat folder and returns information about the corresponding chat folder
  • checkChatInviteLink — Checks the validity of an invite link for a chat and returns information about the corresponding chat
  • checkChatUsername — Checks whether a username can be set for a chat
  • checkCreatedPublicChatsLimit — Checks whether the maximum number of owned public chats has been reached. Returns corresponding error if the limit wa...
  • checkEmailAddressVerificationCode — Checks the email address verification code for Telegram Passport
  • checkLoginEmailAddressCode — Checks the login email address authentication
  • checkOauthRequestMatchCode — Checks a match-code for an OAuth authorization request. If fails, then the authorization request has failed. Otherwis...
  • checkPasswordRecoveryCode — Checks whether a 2-step verification password recovery code sent to an email address is valid
  • checkPhoneNumberCode — Checks the authentication code and completes the request for which the code was sent if appropriate
  • checkPremiumGiftCode — Returns information about a Telegram Premium gift code
  • checkQuickReplyShortcutName — Checks validness of a name for a quick reply shortcut. Can be called synchronously
  • checkRecoveryEmailAddressCode — Checks the 2-step verification recovery email address verification code
  • checkStickerSetName — Checks whether a name can be used for a new sticker set
  • checkWebAppFileDownload — Checks whether a file can be downloaded and saved locally by Web App request
  • cleanFileName — Removes potentially dangerous characters from the name of a file. Returns an empty string on failure. Can be called s...
  • clearAllDraftMessages — Clears message drafts in all chats
  • clearAutosaveSettingsExceptions — Clears the list of all autosave settings exceptions. The method is guaranteed to work only after at least one call to...
  • clearImportedContacts — Clears all imported contacts, contact list remains unchanged
  • clearRecentEmojiStatuses — Clears the list of recently used emoji statuses for self status
  • clearRecentlyFoundChats — Clears the list of recently found chats
  • clearRecentReactions — Clears the list of recently used reactions
  • clearRecentStickers — Clears the list of recently used stickers
  • clearSearchedForTags — Clears the list of recently searched for hashtags or cashtags
  • clickAnimatedEmojiMessage — Informs TDLib that a message with an animated emoji was clicked by the user. Returns a big animated sticker to be pla...
  • clickChatSponsoredMessage — Informs TDLib that the user opened the sponsored chat via the button, the name, the chat photo, a mention in the spon...
  • clickPremiumSubscriptionButton — Informs TDLib that the user clicked Premium subscription button on the Premium features screen
  • clickVideoMessageAdvertisement — Informs TDLib that the user clicked a video message advertisement
  • close — Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes, upda...
  • closeChat — Informs TDLib that the chat is closed by the user. Many useful activities depend on the chat being opened or closed
  • closeGiftAuction — Informs TDLib that a gift auction was closed by the user
  • closeSecretChat — Closes a secret chat, effectively transferring its state to secretChatStateClosed
  • closeStory — Informs TDLib that a story is closed by the user
  • closeWebApp — Informs TDLib that a previously opened Web App was closed
  • commitPendingLiveStoryReactions — Applies all pending paid reactions in a live story group call
  • commitPendingPaidMessageReactions — Applies all pending paid reactions on a message
  • composeRichMessageWithAi — Changes a rich message using an AI model. May return an error with a message "AICOMPOSE_FLOOD_PREMIUM" if Telegram Pr...
  • composeTextWithAi — Changes text using an AI model; must not be used in secret chats. May return an error with a message "AICOMPOSE_FLOOD...
  • confirmBusinessConnectedBot — Confirms an unconfirmed business connection of the current user from another device
  • confirmQrCodeAuthentication — Confirms QR code authentication on another device. Returns created session on success
  • confirmSession — Confirms an unconfirmed session of the current user from another device
  • connectAffiliateProgram — Connects an affiliate program to the given affiliate. Returns information about the connected affiliate program
  • craftGift — Crafts a new gift from other gifts that will be permanently lost
  • createBasicGroupChat — Returns an existing chat corresponding to a known basic group
  • createBot — Creates a bot which will be managed by another bot. Returns the created bot. May return an error with a message "BOT_...
  • createBusinessChatLink — Creates a business chat link for the current account. Requires Telegram Business subscription. There can be up to get...
  • createCall — Creates a new call
  • createChatFolder — Creates new chat folder. Returns information about the created chat folder. There can be up to getOption("chat_folder...
  • createChatFolderInviteLink — Creates a new invite link for a chat folder. A link can be created for a chat folder if it has only pinned and includ...
  • createChatInviteLink — Creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator p...
  • createChatSubscriptionInviteLink — Creates a new subscription invite link for a channel chat. Requires can_invite_users right in the chat
  • createCommunity — Creates a new community for the given chat. Returns identifier of the created community
  • createForumTopic — Creates a topic in a forum supergroup chat or a chat with a bot with topics; requires can_manage_topics administrator...
  • createGiftCollection — Creates a collection from gifts on the current user's or a channel's profile page; requires can_post_messages adminis...
  • createGroupCall — Creates a new group call that isn't bound to a chat
  • createInvoiceLink — Creates a link for the given invoice; for bots only
  • createNewBasicGroupChat — Creates a new basic group and sends a corresponding messageBasicGroupChatCreate. Returns information about the newly ...
  • createNewSecretChat — Creates a new secret chat. Returns the newly created chat
  • createNewStickerSet — Creates a new sticker set. Returns the newly created sticker set
  • createNewSupergroupChat — Creates a new supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created ...
  • createPrivateChat — Returns an existing chat corresponding to a given user
  • createRichMessageWithAi — Creates a new rich message using an AI model. May return an error with a message "AICOMPOSE_FLOOD_PREMIUM" if Telegra...
  • createSecretChat — Returns an existing chat corresponding to a known secret chat
  • createStoryAlbum — Creates an album of stories; requires can_edit_stories administrator right for supergroup and channel chats
  • createSupergroupChat — Returns an existing chat corresponding to a known supergroup or channel
  • createTemporaryPassword — Creates a new temporary password for processing payments
  • createTextCompositionStyle — Creates a custom text composition style. May return an error with a message "TONES_SAVED_TOO_MANY" if the maximum num...
  • createVideoChat — Creates a video chat (a group call bound to a chat); for basic groups, supergroups and channels only; requires can_ma...

D

E

  • editBotMediaPreview — Replaces media preview in the list of media previews of a bot. Returns the new preview after edit is completed server...
  • editBusinessChatLink — Edits a business chat link of the current account. Requires Telegram Business subscription. Returns the edited link
  • editBusinessMessageCaption — Edits the caption of a message sent on behalf of a business account; for bots only
  • editBusinessMessageChecklist — Edits the content of a checklist in a message sent on behalf of a business account; for bots only
  • editBusinessMessageLiveLocation — Edits the content of a live location in a message sent on behalf of a business account; for bots only
  • editBusinessMessageMedia — Edits the media content of a message with a text, an animation, an audio, a document, a photo or a video in a message...
  • editBusinessMessageReplyMarkup — Edits the reply markup of a message sent on behalf of a business account; for bots only
  • editBusinessMessageText — Edits the text of a text or game message sent on behalf of a business account; for bots only
  • editBusinessStory — Changes a story posted by the bot on behalf of a business account; for bots only
  • editCallbackQueryMessage — Edits the message from which a callback query has originated with an ephemeral message; for bots only
  • editChatFolder — Edits existing chat folder. Returns information about the edited chat folder
  • editChatFolderInviteLink — Edits an invite link for a chat folder
  • editChatInviteLink — Edits a non-primary invite link for a chat. Available in basic groups, supergroups, and channels. If the link creates...
  • editChatSubscriptionInviteLink — Edits a subscription invite link for a channel chat. Requires can_invite_users right in the chat for own links and ow...
  • editChatWelcomeMessage — Edits a welcome message of a chat; requires can_send_welcome_messages administrator right in the chat
  • editCustomLanguagePackInfo — Edits information about a custom local language pack in the current localization target. Can be called before authori...
  • editEphemeralMessage — Edits the text, media, or reply markup of an ephemeral message sent by the bot; for bots only
  • editEphemeralMessageCaption — Edits the caption and reply markup of an ephemeral message sent by the bot; for bots only
  • editForumTopic — Edits title and icon of a topic in a forum supergroup chat or a chat with a bot with topics; for supergroup chats req...
  • editInlineMessageCaption — Edits the caption of an inline message sent via a bot; for bots only
  • editInlineMessageLiveLocation — Edits the content of a live location in an inline message sent via a bot; for bots only
  • editInlineMessageMedia — Edits the media content of a message with a text, an animation, an audio, a document, a photo or a video in an inline...
  • editInlineMessageReplyMarkup — Edits the reply markup of an inline message sent via a bot; for bots only
  • editInlineMessageText — Edits the text of an inline text or game message sent via the bot; for bots only
  • editMessageCaption — Edits the message content caption. Returns the edited message after the edit is completed on the server side
  • editMessageChecklist — Edits the message content of a checklist. Returns the edited message after the edit is completed on the server side
  • editMessageLiveLocation — Edits the message content of a live location. Messages can be edited for a limited period of time specified in the li...
  • editMessageMedia — Edits the media content of a message, including message caption. If only the caption needs to be edited, use editMess...
  • editMessageReplyMarkup — Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side
  • editMessageSchedulingState — Edits the time when a scheduled message will be sent. Scheduling state of all messages in the same album or forwarded...
  • editMessageText — Edits the text of a message (or a text of a game message). Returns the edited message after the edit is completed on ...
  • editProxy — Edits an existing proxy server for network requests. Can be called before authorization
  • editQuickReplyMessage — Asynchronously edits the text, media or caption of a quick reply message. Use quickReplyMessage.can_be_edited to chec...
  • editStarSubscription — Cancels or re-enables Telegram Star subscription
  • editStory — Changes content and caption of a story. Can be called only if story.can_be_edited == true
  • editStoryCover — Changes cover of a video story. Can be called only if story.can_be_edited == true and the story isn't being edited now
  • editTextCompositionStyle — Edits a custom text composition style that was created by the current user
  • editUserStarSubscription — Cancels or re-enables Telegram Star subscription for a user; for bots only
  • enableProxy — Enables a proxy. Only one proxy can be enabled at a time. Can be called before authorization
  • encryptGroupCallData — Encrypts group call data before sending them over network using tgcalls
  • endGroupCall — Ends a group call. Requires groupCall.can_be_managed right for video chats and live stories or groupCall.is_owned oth...
  • endGroupCallRecording — Ends recording of an active group call; for video chats only. Requires groupCall.can_be_managed right
  • endGroupCallScreenSharing — Ends screen sharing in a joined group call; not supported in live stories

F

  • finishFileGeneration — Finishes the file generation
  • fixRichMessageWithAi — Fixes a rich message using an AI model. May return an error with a message "AICOMPOSE_FLOOD_PREMIUM" if Telegram Prem...
  • fixTextWithAi — Fixes text using an AI model; must not be used in secret chats. May return an error with a message "AICOMPOSE_FLOOD_P...
  • forwardMessages — Forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed...

G

  • getAccountTtl — Returns the period of inactivity after which the account of the current user will automatically be deleted
  • getActiveSessions — Returns all active sessions of the current user. Additionally, getBusinessConnectedBot must be used to show the bot o...
  • getAllPassportElements — Returns all available Telegram Passport elements
  • getAllStickerEmojis — Returns unique emoji that correspond to stickers to be found by the getStickers(sticker_type, query, 1000000, chat_id)
  • getAnimatedEmoji — Returns an animated emoji corresponding to a given emoji. Returns a 404 error if the emoji has no animated emoji
  • getApplicationConfig — Returns application config, provided by the server. Can be called before authorization
  • getApplicationDownloadLink — Returns the link for downloading official Telegram application to be used when the current user invites friends to Te...
  • getArchiveChatListSettings — Returns settings for automatic moving of chats to and from the Archive chat lists
  • getArchivedStickerSets — Returns a list of archived sticker sets
  • getAttachedStickerSets — Returns a list of sticker sets attached to a file, including regular, mask, and emoji sticker sets. Currently, only a...
  • getAttachmentMenuBot — Returns information about a bot that can be added to attachment or side menu
  • getAuthenticationPasskeyParameters — Returns parameters for authentication using a passkey as JSON-serialized string
  • getAuthorizationState — Returns the current authorization state. This is an offline method. For informational purposes only. Use updateAuthor...
  • getAutoDownloadSettingsPresets — Returns auto-download settings presets for the current user
  • getAutosaveSettings — Returns autosave settings for the current user
  • getAvailableChatBoostSlots — Returns the list of available chat boost slots for the current user
  • getAvailableGifts — Returns gifts that can be sent to other users and channel chats
  • getBackgroundUrl — Constructs a persistent HTTP URL for a background
  • getBankCardInfo — Returns information about a bank card
  • getBasicGroup — Returns information about a basic group by its identifier. This is an offline method if the current user is not a bot
  • getBasicGroupFullInfo — Returns full information about a basic group by its identifier
  • getBlockedMessageSenders — Returns users and chats that were blocked by the current user
  • getBotInfoDescription — Returns the text shown in the chat with a bot if the chat is empty in the given language. Can be called only if userT...
  • getBotInfoShortDescription — Returns the text shown on a bot's profile page and sent together with the link when users share the bot in the given ...
  • getBotMediaPreviewInfo — Returns the list of media previews for the given language and the list of languages for which the bot has dedicated p...
  • getBotMediaPreviews — Returns the list of media previews of a bot
  • getBotName — Returns the name of a bot in the given language. Can be called only if userTypeBot.can_be_edited == true
  • getBotSimilarBotCount — Returns approximate number of bots similar to the given bot
  • getBotSimilarBots — Returns a list of bots similar to the given bot
  • getBusinessAccountStarAmount — Returns the Telegram Star amount owned by a business account; for bots only
  • getBusinessChatLinkInfo — Returns information about a business chat link
  • getBusinessChatLinks — Returns business chat links created for the current account
  • getBusinessConnectedBot — Returns information about the business bot that is connected to the current user account. Returns a 404 error if ther...
  • getBusinessConnection — Returns information about a business connection by its identifier; for bots only
  • getBusinessFeatures — Returns information about features, available to Business users
  • getCallbackQueryAnswer — Sends a callback query to a bot and returns an answer. Returns an error with code 502 if the bot fails to answer the ...
  • getCallbackQueryMessage — Returns information about a message with the callback button that originated a callback query; for bots only
  • getChat — Returns information about a chat by its identifier. This is an offline method if the current user is not a bot
  • getChatActiveStories — Returns the list of active stories posted by the given chat
  • getChatAdministrators — Returns a list of administrators of the chat with their custom titles
  • getChatArchivedStories — Returns the list of all stories posted by the given chat; requires can_edit_stories administrator right in the chat. ...
  • getChatAvailableMessageSenders — Returns the list of message sender identifiers, which can be used to send messages in a chat
  • getChatAvailablePaidMessageReactionSenders — Returns the list of message sender identifiers, which can be used to send a paid reaction in a chat
  • getChatBoostFeatures — Returns the list of features available for different chat boost levels. This is an offline method
  • getChatBoostLevelFeatures — Returns the list of features available on the specific chat boost level. This is an offline method
  • getChatBoostLink — Returns an HTTPS link to boost the specified supergroup or channel chat
  • getChatBoostLinkInfo — Returns information about a link to boost a chat. Can be called for any internal link of the type internalLinkTypeCha...
  • getChatBoosts — Returns the list of boosts applied to a chat; requires administrator rights in the chat
  • getChatBoostStatus — Returns the current boost status for a supergroup or a channel chat
  • getChatEventLog — Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only in su...
  • getChatFolder — Returns information about a chat folder by its identifier
  • getChatFolderChatCount — Returns approximate number of chats in a being created chat folder. Main and archive chat lists must be fully preload...
  • getChatFolderChatsToLeave — Returns identifiers of pinned or always included chats from a chat folder, which are suggested to be left when the ch...
  • getChatFolderDefaultIconName — Returns default icon name for a folder. Can be called synchronously
  • getChatFolderInviteLinks — Returns invite links created by the current user for a shareable chat folder
  • getChatFolderNewChats — Returns new chats added to a shareable chat folder by its owner. The method must be called at most once in getOption(...
  • getChatHistory — Returns messages in a chat. The messages are returned in reverse chronological order (i.e., in order of decreasing me...
  • getChatInviteLink — Returns information about an invite link. Requires administrator privileges and can_invite_users right in the chat to...
  • getChatInviteLinkCounts — Returns the list of chat administrators with number of their invite links. Requires owner privileges in the chat
  • getChatInviteLinkMembers — Returns chat members joined a chat via an invite link. Requires administrator privileges and can_invite_users right i...
  • getChatInviteLinks — Returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_...
  • getChatJoinRequests — Returns pending join requests in a chat
  • getChatListsToAddChat — Returns chat lists to which the chat can be added. This is an offline method
  • getChatMember — Returns information about a single member of a chat
  • getChatMessageByDate — Returns the last message sent in a chat no later than the specified date. Returns a 404 error if such message doesn't...
  • getChatMessageCalendar — Returns information about the next messages of the specified type in the chat split by days. Returns the results in r...
  • getChatMessageCount — Returns approximate number of messages of the specified type in the chat or its topic
  • getChatMessagePosition — Returns approximate 1-based position of a message among messages, which can be found by the specified filter in the c...
  • getChatNotificationSettingsExceptions — Returns the list of chats with non-default notification settings for new messages
  • getChatOwnerAfterLeaving — Returns the user who will become the owner of the chat after 7 days if the current user does not return to the superg...
  • getChatPinnedMessage — Returns information about a newest pinned message in the chat. Returns a 404 error if the message doesn't exist
  • getChatPostedToChatPageStories — Returns the list of stories that posted by the given chat to its chat page. If from_story_id == 0, then pinned storie...
  • getChatRevenueStatistics — Returns detailed revenue statistics about a chat. Currently, this method can be used only for channels if supergroupF...
  • getChatRevenueTransactions — Returns the list of revenue transactions for a chat. Currently, this method can be used only for channels if supergro...
  • getChatRevenueWithdrawalUrl — Returns a URL for chat revenue withdrawal; requires owner privileges in the channel chat or the bot. Currently, this ...
  • getChats — Returns an ordered list of chats from the beginning of a chat list. For informational purposes only. Use loadChats an...
  • getChatScheduledMessages — Returns all scheduled messages in a chat. The messages are returned in reverse chronological order (i.e., in order of...
  • getChatsForChatFolderInviteLink — Returns identifiers of chats from a chat folder, suitable for adding to a chat folder invite link
  • getChatSimilarChatCount — Returns approximate number of chats similar to the given chat
  • getChatSimilarChats — Returns a list of chats similar to the given chat
  • getChatSparseMessagePositions — Returns sparse positions of messages of the specified type in the chat to be used for Shared Media scroll implementat...
  • getChatSponsoredMessages — Returns sponsored messages to be shown in a chat; for channel chats and chats with bots only
  • getChatStatistics — Returns detailed statistics about a chat. Currently, this method can be used only for supergroups and channels. Can b...
  • getChatsToPostStories — Returns supergroup and channel chats in which the current user has the right to post stories. The chats must be reche...
  • getChatStoryAlbums — Returns the list of story albums owned by the given chat
  • getChatStoryInteractions — Returns interactions with a story posted in a chat. Can be used only if story is posted on behalf of a chat and the u...
  • getCloseFriends — Returns all close friends of the current user
  • getCollectibleItemInfo — Returns information about a given collectible item that was purchased at https://fragment.com
  • getCommands — Returns the list of commands supported by the bot for the given user scope and language; for bots only
  • getConnectedAffiliateProgram — Returns an affiliate program that was connected to the given affiliate by identifier of the bot that created the program
  • getConnectedAffiliatePrograms — Returns affiliate programs that were connected to the given affiliate
  • getConnectedWebsites — Returns all website where the current user used Telegram to log in
  • getContacts — Returns all contacts of the user
  • getCountries — Returns information about existing countries. Can be called before authorization
  • getCountry — Returns information about an existing country. Can be called before authorization
  • getCountryCode — Uses the current IP address to find the current country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be c...
  • getCountryFlagEmoji — Returns an emoji for the flag of the given country. Returns an empty string on failure. Can be called synchronously
  • getCreatedPublicChats — Returns a list of public chats of the specified type, owned by the user
  • getCurrentState — Returns all updates needed to restore current TDLib state, i.e. all actual updateAuthorizationState/updateUser/update...
  • getCurrentWeather — Returns the current weather in the given location
  • getCustomEmojiReactionAnimations — Returns TGS stickers with generic animations for custom emoji reactions
  • getCustomEmojiStickers — Returns the list of custom emoji stickers by their identifiers. Stickers are returned in arbitrary order. Only found ...
  • getDatabaseStatistics — Returns database statistics
  • getDeepLinkInfo — Returns information about a tg:// deep link. Use "tg://need_update_for_some_feature" or "tg:some_unsupported_feature"...
  • getDefaultBackgroundCustomEmojiStickers — Returns default list of custom emoji stickers for reply background
  • getDefaultChatEmojiStatuses — Returns default emoji statuses for chats
  • getDefaultChatPhotoCustomEmojiStickers — Returns default list of custom emoji stickers for placing on a chat photo
  • getDefaultEmojiStatuses — Returns default emoji statuses for self status
  • getDefaultMessageAutoDeleteTime — Returns default message auto-delete time setting for new chats
  • getDefaultProfilePhotoCustomEmojiStickers — Returns default list of custom emoji stickers for placing on a profile photo
  • getDirectMessagesChatTopic — Returns information about the topic in a channel direct messages chat administered by the current user
  • getDirectMessagesChatTopicHistory — Returns messages in the topic in a channel direct messages chat administered by the current user. The messages are re...
  • getDirectMessagesChatTopicMessageByDate — Returns the last message sent in the topic in a channel direct messages chat administered by the current user no late...
  • getDirectMessagesChatTopicRevenue — Returns the total number of Telegram Stars received by the channel chat for direct messages from the given topic
  • getDisallowedChatEmojiStatuses — Returns the list of emoji statuses, which can't be used as chat emoji status, even if they are from a sticker set wit...
  • getEmojiCategories — Returns available emoji categories
  • getEmojiReaction — Returns information about an emoji reaction. Returns a 404 error if the reaction is not found
  • getEmojiSuggestionsUrl — Returns an HTTP URL which can be used to automatically log in to the translation platform and suggest new emoji repla...
  • getExternalLink — Returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP...
  • getExternalLinkInfo — Returns information about an action to be done when the current user clicks an external link. Don't use this method f...
  • getFavoriteStickers — Returns favorite stickers
  • getFile — Returns information about a file. This is an offline method
  • getFileDownloadedPrefixSize — Returns file downloaded prefix size from a given offset, in bytes
  • getFileExtension — Returns the extension of a file, guessed by its MIME type. Returns an empty string on failure. Can be called synchron...
  • getFileMimeType — Returns the MIME type of a file, guessed by its extension. Returns an empty string on failure. Can be called synchron...
  • getForumTopic — Returns information about a topic in a forum supergroup chat or a chat with a bot with topics
  • getForumTopicDefaultIcons — Returns the list of custom emoji, which can be used as forum topic icon by all users
  • getForumTopicHistory — Returns messages in a topic in a forum supergroup chat or a chat with a bot with topics. The messages are returned in...
  • getForumTopicLink — Returns an HTTPS link to a topic in a forum supergroup chat. This is an offline method
  • getForumTopics — Returns found forum topics in a forum supergroup chat or a chat with a bot with topics. This is a temporary method fo...
  • getFullRichMessage — Returns the full version of a rich message
  • getGameHighScores — Returns the high scores for a game and some part of the high score table in the range of the specified user; for bots...
  • getGiftAuctionAcquiredGifts — Returns the gifts that were acquired by the current user on a gift auction
  • getGiftAuctionState — Returns auction state for a gift
  • getGiftChatThemes — Returns available to the current user gift chat themes
  • getGiftCollections — Returns collections of gifts owned by the given user or chat
  • getGiftsForCrafting — Returns upgraded gifts of the current user who can be used to craft another gifts
  • getGiftUpgradePreview — Returns examples of possible upgraded gifts for a regular gift
  • getGiveawayInfo — Returns information about a giveaway
  • getGramRevenueStatistics — Returns detailed TON Gram revenue statistics of the current user
  • getGramWithdrawalUrl — Returns a URL for TON Gram withdrawal from the current user's account. The user must have at least 10 Grams to withdr...
  • getGreetingStickers — Returns greeting stickers from regular sticker sets that can be used for the start page of other users
  • getGrossingWebAppBots — Returns the most grossing Web App bots
  • getGroupCall — Returns information about a group call
  • getGroupCallParticipants — Returns information about participants of a non-joined group call that is not bound to a chat
  • getGroupCallStreams — Returns information about available streams in a video chat or a live story
  • getGroupCallStreamSegment — Returns a file with a segment of a video chat or live story in a modified OGG format for audio or MPEG-4 format for v...
  • getGroupsInCommon — Returns a list of common group chats with a given user. Chats are sorted by their type and creation date
  • getGuardBotWebAppUrl — Returns an HTTPS URL of a Web App of a guard bot to open after receiving chatJoinResultGuardBotApprovalRequired
  • getImportedContactCount — Returns the total number of imported contacts
  • getInactiveSupergroupChats — Returns a list of recently inactive supergroups and channels. Can be used when user reaches limit on the number of jo...
  • getInlineGameHighScores — Returns game high scores and some part of the high score table in the range of the specified user; for bots only
  • getInlineQueryResults — Sends an inline query to a bot and returns its results. Returns an error with code 502 if the bot fails to answer the...
  • getInstalledBackgrounds — Returns backgrounds installed by the user
  • getInstalledStickerSets — Returns a list of installed sticker sets
  • getInternalLink — Returns an HTTPS or a tg: link with the given type. Can be called before authorization
  • getInternalLinkType — Returns information about the type of internal link. Returns a 404 error if the link is not internal. Can be called b...
  • getJsonString — Converts a JsonValue object to corresponding JSON-serialized string. Can be called synchronously
  • getJsonValue — Converts a JSON-serialized string to corresponding JsonValue object. Can be called synchronously
  • getKeywordEmojis — Returns emojis matching the keyword. Supported only if the file database is enabled. Order of results is unspecified
  • getLanguagePackInfo — Returns information about a language pack. Returned language pack identifier may be different from a provided one. Ca...
  • getLanguagePackString — Returns a string stored in the local database from the specified localization target and language pack by its key. Re...
  • getLanguagePackStrings — Returns strings from a language pack in the current localization target by their keys. Can be called before authoriza...
  • getLinkPreview — Returns a link preview by the text of a message. Do not call this function too often. Returns a 404 error if the text...
  • getLinkWebBrowserType — Returns a type of the web browser which must be used to open the link
  • getLiveStoryAvailableMessageSenders — Returns the list of message sender identifiers, on whose behalf messages can be sent to a live story
  • getLiveStoryRtmpUrl — Returns RTMP URL for streaming to a live story; requires can_post_stories administrator right for channel chats
  • getLiveStoryStreamer — Returns information about the user or the chat that streams to a live story; for live stories that aren't an RTMP str...
  • getLiveStoryTopDonors — Returns the list of top live story donors
  • getLocalizationTargetInfo — Returns information about the current localization target. This is an offline method if only_local is true. Can be ca...
  • getLoginPasskeys — Returns the list of passkeys allowed to be used for the login by the current user
  • getLoginUrl — Returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline butto...
  • getLoginUrlInfo — Returns information about a button of type inlineKeyboardButtonTypeLoginUrl. The method needs to be called when the u...
  • getLogStream — Returns information about currently used log stream for internal logging of TDLib. Can be called synchronously
  • getLogTags — Returns the list of available TDLib internal log tags, for example, ["actor", "binlog", "connections", "notification...
  • getLogTagVerbosityLevel — Returns current verbosity level for a specified TDLib internal log tag. Can be called synchronously
  • getLogVerbosityLevel — Returns current verbosity level of the internal logging of TDLib. Can be called synchronously
  • getMainWebApp — Returns information needed to open the main Web App of a bot
  • getManagedBotAccessSettings — Returns access settings of a managed bot; for bots only
  • getManagedBotToken — Returns token of a managed bot; for bots only
  • getMapThumbnailFile — Returns information about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB...
  • getMarkdownText — Replaces text entities with Markdown formatting in a human-friendly format. Entities that can't be represented in Mar...
  • getMe — Returns the current user
  • getMenuButton — Returns menu button set by the bot for the given user; for bots only
  • getMessage — Returns information about a message. Returns a 404 error if the message doesn't exist
  • getMessageAddedReactions — Returns reactions added for a message, along with their sender
  • getMessageAuthor — Returns information about actual author of a message sent on behalf of a channel. The method can be called if message...
  • getMessageAvailableReactions — Returns reactions, which can be added to a message. The list can change after updateActiveEmojiReactions, updateChatA...
  • getMessageEffect — Returns information about a message effect. Returns a 404 error if the effect is not found
  • getMessageEmbeddingCode — Returns an HTML code for embedding the message. Available only if messageProperties.can_get_embedding_code
  • getMessageFileType — Returns information about a file with messages exported from another application
  • getMessageImportConfirmationText — Returns a confirmation text to be shown to the user before starting message import
  • getMessageLink — Returns an HTTPS link to a message in a chat. Available only if messageProperties.can_get_link, or if messageProperti...
  • getMessageLinkInfo — Returns information about a public or private message link. Can be called for any internal link of the type internalL...
  • getMessageLocally — Returns information about a message, if it is available without sending network request. Returns a 404 error if messa...
  • getMessageProperties — Returns properties of a message. This is an offline method
  • getMessagePublicForwards — Returns forwarded copies of a channel message to different public channels and public reposts as a story. Can be used...
  • getMessageReadDate — Returns read date of a recent outgoing message in a private chat. The method can be called if messageProperties.can_g...
  • getMessages — Returns information about messages. If a message is not found, returns null on the corresponding position of the result
  • getMessageStatistics — Returns detailed statistics about a message. Can be used only if messageProperties.can_get_statistics == true
  • getMessageThread — Returns information about a message thread. Can be used only if messageProperties.can_get_message_thread == true
  • getMessageThreadHistory — Returns messages in a message thread of a message. Can be used only if messageProperties.can_get_message_thread == tr...
  • getMessageViewers — Returns viewers of a recent outgoing message in a basic group or a supergroup chat. For video notes and voice notes o...
  • getNetworkStatistics — Returns network data usage statistics. Can be called before authorization
  • getNewChatPrivacySettings — Returns privacy settings for new chat creation
  • getOauthLinkInfo — Returns information about an OAuth deep link. Use checkOauthRequestMatchCode, acceptOauthRequest or declineOauthReque...
  • getOption — Returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/o...
  • getOwnedBots — Returns the list of bots owned by the current user
  • getOwnedStickerSets — Returns sticker sets owned by the current user
  • getPaidMessageRevenue — Returns the total number of Telegram Stars received by the current user for paid messages from the given user
  • getPasskeyParameters — Returns parameters for creating of a new passkey as JSON-serialized string
  • getPassportAuthorizationForm — Returns a Telegram Passport authorization form for sharing data with a service
  • getPassportAuthorizationFormAvailableElements — Returns already available Telegram Passport elements suitable for completing a Telegram Passport authorization form. ...
  • getPassportElement — Returns one of the available Telegram Passport elements
  • getPasswordState — Returns the current state of 2-step verification
  • getPaymentForm — Returns an invoice payment form. This method must be called when the user presses inline button of the type inlineKey...
  • getPaymentReceipt — Returns information about a successful payment
  • getPersonalChatHistory — Returns messages in the personal chat of a given user; for bots only
  • getPhoneNumberInfo — Returns information about a phone number by its prefix. Can be called before authorization
  • getPhoneNumberInfoSync — Returns information about a phone number by its prefix synchronously. getCountries must be called at least once after...
  • getPollOptionProperties — Returns properties of a poll option. This is an offline method
  • getPollVoters — Returns message senders voted for the specified option in a poll; use poll.can_get_voters to check whether the method...
  • getPollVoteStatistics — Returns statistics of poll votes in a poll
  • getPreferredCountryLanguage — Returns an IETF language tag of the language preferred in the country, which must be used to fill native fields in Te...
  • getPremiumFeatures — Returns information about features, available to Premium users
  • getPremiumGiftPaymentOptions — Returns available options for gifting Telegram Premium to a user
  • getPremiumGiveawayPaymentOptions — Returns available options for creating of Telegram Premium giveaway or manual distribution of Telegram Premium among ...
  • getPremiumInfoSticker — Returns the sticker to be used as representation of the Telegram Premium subscription
  • getPremiumLimit — Returns information about a limit, increased for Premium users. Returns a 404 error if the limit is unknown
  • getPremiumState — Returns state of Telegram Premium subscription and promotion videos for Premium features
  • getPremiumStickerExamples — Returns examples of premium stickers for demonstration purposes
  • getPremiumStickers — Returns premium stickers from regular sticker sets
  • getPreparedInlineMessage — Saves an inline message to be sent by the given user
  • getPreparedKeyboardButton — Returns a keyboard button prepared by the bot for the user. The button will be of the type keyboardButtonTypeRequestU...
  • getProxies — Returns the list of proxies that are currently set up. Can be called before authorization
  • getPublicPostSearchLimits — Checks public post search limits without actually performing the search
  • getPushReceiverId — Returns a globally unique push notification subscription identifier for identification of an account, which has recei...
  • getReadDatePrivacySettings — Returns privacy settings for message read date
  • getReceivedGift — Returns information about a received gift
  • getReceivedGifts — Returns gifts received by the given user or chat
  • getRecentEmojiStatuses — Returns recent emoji statuses for self status
  • getRecentInlineBots — Returns up to 20 recently used inline bots in the order of their last usage
  • getRecentlyOpenedChats — Returns recently opened chats. This is an offline method. Returns chats in the order of last opening
  • getRecentlyVisitedTMeUrls — Returns t.me URLs recently visited by a newly registered user
  • getRecentStickers — Returns a list of recently used stickers
  • getRecommendedChatFolders — Returns recommended chat folders for the current user
  • getRecommendedChats — Returns a list of channel chats recommended to the current user
  • getRecoveryEmailAddress — Returns a 2-step verification recovery email address that was previously set up. This method can be used to verify a ...
  • getRemoteFile — Returns information about a file by its remote identifier. This is an offline method. Can be used to register a URL a...
  • getRepliedMessage — Returns information about a non-bundled message that is replied by a given message. Also, returns the pinned message ...
  • getSavedAnimations — Returns saved animations
  • getSavedMessagesTags — Returns tags used in Saved Messages or a Saved Messages topic
  • getSavedMessagesTopicHistory — Returns messages in a Saved Messages topic. The messages are returned in reverse chronological order (i.e., in order ...
  • getSavedMessagesTopicMessageByDate — Returns the last message sent in a Saved Messages topic no later than the specified date
  • getSavedNotificationSound — Returns saved notification sound by its identifier. Returns a 404 error if there is no saved notification sound with ...
  • getSavedNotificationSounds — Returns the list of saved notification sounds. If a sound isn't in the list, then default sound needs to be used
  • getSavedOrderInfo — Returns saved order information. Returns a 404 error if there is no saved order information
  • getScopeNotificationSettings — Returns the notification settings for chats of a given type
  • getSearchedForTags — Returns recently searched for hashtags or cashtags by their prefix
  • getSearchSponsoredChats — Returns sponsored chats to be shown in the search results
  • getSecretChat — Returns information about a secret chat by its identifier. This is an offline method
  • getStakeDiceState — Returns the current state of stake dice
  • getStarAdAccountUrl — Returns a URL for a Telegram Ad platform account that can be used to set up advertisements for the chat paid in the o...
  • getStarGiftPaymentOptions — Returns available options for Telegram Stars gifting
  • getStarGiveawayPaymentOptions — Returns available options for Telegram Star giveaway creation
  • getStarPaymentOptions — Returns available options for Telegram Stars purchase
  • getStarRevenueStatistics — Returns detailed Telegram Star revenue statistics
  • getStarSubscriptions — Returns the list of Telegram Star subscriptions for the current user
  • getStarTransactions — Returns the list of Telegram Star transactions for the specified owner
  • getStarWithdrawalUrl — Returns a URL for Telegram Star withdrawal
  • getStatisticalGraph — Loads an asynchronous or a zoomed in statistical graph
  • getStickerEmojis — Returns emoji corresponding to a sticker. The list is only for informational purposes, because a sticker is always se...
  • getStickerOutline — Returns outline of a sticker. This is an offline method. Returns a 404 error if the outline isn't known
  • getStickerOutlineSvgPath — Returns outline of a sticker as an SVG path. This is an offline method. Returns an empty string if the outline isn't ...
  • getStickers — Returns stickers from the installed sticker sets that correspond to any of the given emoji or can be found by sticker...
  • getStickerSet — Returns information about a sticker set by its identifier
  • getStickerSetName — Returns name of a sticker set by its identifier
  • getStorageStatistics — Returns storage usage statistics. Can be called before authorization
  • getStorageStatisticsFast — Quickly returns approximate storage usage statistics. Can be called before authorization
  • getStory — Returns a story
  • getStoryAlbumStories — Returns the list of stories added to the given story album. For optimal performance, the number of returned stories i...
  • getStoryAvailableReactions — Returns reactions, which can be chosen for a story
  • getStoryInteractions — Returns interactions with a story. The method can be called only for stories posted on behalf of the current user
  • getStoryNotificationSettingsExceptions — Returns the list of chats with non-default notification settings for stories
  • getStoryPublicForwards — Returns forwards of a story as a message to public chats and reposts by public channels. Can be used only if the stor...
  • getStoryStatistics — Returns detailed statistics about a story. Can be used only if story.can_get_statistics == true
  • getSuggestedFileName — Returns suggested name for saving a file in a given directory
  • getSuggestedStickerSetName — Returns a suggested name for a new sticker set with a given title
  • getSuitableDiscussionChats — Returns a list of basic group and supergroup chats, which can be used as a discussion group for a channel. Returned b...
  • getSuitablePersonalChats — Returns a list of channel chats, which can be used as a personal chat
  • getSupergroup — Returns information about a supergroup or a channel by its identifier. This is an offline method if the current user ...
  • getSupergroupFullInfo — Returns full information about a supergroup or a channel by its identifier, cached for up to 1 minute
  • getSupergroupMembers — Returns information about members or banned users in a supergroup or channel. Can be used only if supergroupFullInfo....
  • getSupportName — Returns localized name of the Telegram support user; for Telegram support only
  • getSupportUser — Returns a user who can be contacted to get support
  • getTemporaryPasswordState — Returns information about the current temporary password
  • getTextCompositionStyleExample — Returns an example of usage of a custom text composition style
  • getTextEntities — Returns all entities (mentions, hashtags, cashtags, bot commands, bank card numbers, URLs, and email addresses) found...
  • getThemedChatEmojiStatuses — Returns up to 8 emoji statuses, which must be shown in the emoji status list for chats
  • getThemedEmojiStatuses — Returns up to 8 emoji statuses, which must be shown right after the default Premium Badge in the emoji status list fo...
  • getThemeParametersJsonString — Converts a themeParameters object to corresponding JSON-serialized string. Can be called synchronously
  • getTimeZones — Returns the list of supported time zones
  • getTonTransactions — Returns the list of TON blockchain transactions of the current user
  • getTopChats — Returns a list of frequently used chats
  • getTrendingStickerSets — Returns a list of trending sticker sets. For optimal performance, the number of returned sticker sets is chosen by TDLib
  • getUpgradedGift — Returns information about an upgraded gift by its name
  • getUpgradedGiftEmojiStatuses — Returns available upgraded gift emoji statuses for self status
  • getUpgradedGiftsPromotionalAnimation — Returns promotional animation for upgraded gifts
  • getUpgradedGiftValueInfo — Returns information about value of an upgraded gift by its name
  • getUpgradedGiftVariants — Returns all possible variants of upgraded gifts for a regular gift
  • getUpgradedGiftWithdrawalUrl — Returns a URL for upgraded gift withdrawal in the TON blockchain as an NFT; requires owner privileges for gifts owned...
  • getUser — Returns information about a user by their identifier. This is an offline method if the current user is not a bot
  • getUserChatBoosts — Returns the list of boosts applied to a chat by a given user; requires administrator rights in the chat; for bots only
  • getUserFullInfo — Returns full information about a user by their identifier
  • getUserLink — Returns an HTTPS link, which can be used to get information about the current user
  • getUserPrivacySettingRules — Returns the current privacy settings
  • getUserProfileAudios — Returns the list of profile audio files of a user
  • getUserProfilePhotos — Returns the profile photos of a user. Personal and public photo aren't returned
  • getUserSupportInfo — Returns support information for the given user; for Telegram support only
  • getVideoChatAvailableParticipants — Returns the list of participant identifiers, on whose behalf a video chat in the chat can be joined
  • getVideoChatInviteLink — Returns invite link to a video chat in a public chat
  • getVideoChatRtmpUrl — Returns RTMP URL for streaming to the video chat of a chat; requires can_manage_video_chats administrator right
  • getVideoMessageAdvertisements — Returns advertisements to be shown while a video from a message is watched. Available only if messageProperties.can_g...
  • getWebAppLinkUrl — Returns an HTTPS URL of a Web App to open after a link of the type internalLinkTypeWebApp is clicked
  • getWebAppPlaceholder — Returns a default placeholder for Web Apps of a bot. This is an offline method. Returns a 404 error if the placeholde...
  • getWebAppUrl — Returns an HTTPS URL of a Web App to open from the side menu, a keyboardButtonTypeWebApp button, or an inlineQueryRes...
  • getWebPageInstantView — Returns an instant view version of a web page if available. This is an offline method if only_local is true. Returns ...
  • giftPremiumWithStars — Allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars; for bots only

H

I

  • importContacts — Adds new contacts or edits existing contacts by their phone numbers; contacts' user identifiers are ignored
  • importMessages — Imports messages exported from another application
  • increaseGiftAuctionBid — Increases a bid for an auction gift without changing gift text and receiver
  • inviteGroupCallParticipant — Invites a user to an active group call; for group calls not bound to a chat only. Sends a service message of the type...
  • inviteVideoChatParticipants — Invites users to an active video chat. Sends a service message of the type messageInviteVideoChatParticipants to the ...
  • isLoginEmailAddressRequired — Checks whether the current user is required to set login email address
  • isProfileAudio — Checks whether a file is in the profile audio files of the current user. Returns a 404 error if it isn't

J

  • joinChat — Adds the current user as a new member to a chat. Private and secret chats can't be joined using this method
  • joinChatByInviteLink — Uses an invite link to add the current user to the chat if possible
  • joinGroupCall — Joins a regular group call that is not bound to a chat
  • joinLiveStory — Joins a group call of an active live story. Returns join response payload for tgcalls
  • joinVideoChat — Joins an active video chat. Returns join response payload for tgcalls

L

  • launchPrepaidGiveaway — Launches a prepaid giveaway
  • leaveChat — Removes the current user from chat members. Private and secret chats can't be left using this method
  • leaveGroupCall — Leaves a group call
  • listenToAudio — Informs TDLib that an audio was listened by the user
  • loadActiveStories — Loads more active stories from a story list. The loaded stories will be sent through updates. Active stories are sort...
  • loadChats — Loads more chats from a chat list. The loaded chats and their positions in the chat list will be sent through updates...
  • loadChatWelcomeMessages — Loads welcome messages of a chat; requires can_send_welcome_messages administrator right in the chat. The loaded mess...
  • loadCommunityFullInfo — Returns full information about a community. The data will be sent through update.
  • loadDirectMessagesChatTopics — Loads more topics in a channel direct messages chat administered by the current user. The loaded topics will be sent ...
  • loadGroupCallParticipants — Loads more participants of a group call; not supported in live stories. The loaded participants will be received thro...
  • loadQuickReplyShortcutMessages — Loads quick reply messages that can be sent by a given quick reply shortcut. The loaded messages will be sent through...
  • loadQuickReplyShortcuts — Loads quick reply shortcuts created by the current user. The loaded data will be sent through updateQuickReplyShortcu...
  • loadSavedMessagesTopics — Loads more Saved Messages topics. The loaded topics will be sent through updateSavedMessagesTopic. Topics are sorted ...
  • logOut — Closes the TDLib instance after a proper logout. Requires an available network connection. All local data will be des...

M

O

  • openBotSimilarBot — Informs TDLib that a bot was opened from the list of similar bots
  • openChat — Informs TDLib that the chat is opened by the user. Many useful activities depend on the chat being opened or closed (...
  • openChatSimilarChat — Informs TDLib that a chat was opened from the list of similar chats. The method is independent of openChat and closeC...
  • openGiftAuction — Informs TDLib that a gift auction was opened by the user
  • openMessageContent — Informs TDLib that the message content has been opened (e.g., the user has opened a photo, video, document, location ...
  • openSponsoredChat — Informs TDLib that the user opened a sponsored chat
  • openStory — Informs TDLib that a story is opened and is being viewed by the user
  • openWebApp — Informs TDLib that a Web App is being opened from the attachment menu, a botMenuButton button, an internalLinkTypeAtt...
  • optimizeStorage — Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be...

P

  • parseMarkdown — Parses Markdown entities in a human-friendly format, ignoring markup errors. Can be called synchronously
  • parseTextEntities — Parses Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, BlockQuote, ExpandableBlockQuote, Code, Pre, Pre...
  • pinChatMessage — Pins a message in a chat. A message can be pinned only if messageProperties.can_be_pinned
  • pingProxy — Computes time needed to receive a response from a Telegram server through a proxy. Can be called before authorization
  • placeGiftAuctionBid — Places a bid on an auction gift
  • postStory — Posts a new story on behalf of a chat; requires can_post_stories administrator right for supergroup and channel chats...
  • preliminaryUploadFile — Preliminarily uploads a file to the cloud before sending it in a message, which can be useful for uploading of being ...
  • processChatFolderNewChats — Process new chats added to a shareable chat folder by its owner
  • processChatHasProtectedContentDisableRequest — Processes request to disable has_protected_content in a chat
  • processChatJoinRequest — Handles a pending join request in a chat
  • processChatJoinRequests — Handles all pending join requests for a given link in a chat
  • processGiftPurchaseOffer — Handles a pending gift purchase offer
  • processPushNotification — Handles a push notification. Returns error with code 406 if the push notification is not supported and connection to ...

R

  • rateSpeechRecognition — Rates recognized speech in a video note or a voice note message
  • readAllChatMentions — Marks all mentions in a chat as read
  • readAllChatPollVotes — Marks all poll votes in a chat as read
  • readAllChatReactions — Marks all reactions in a chat as read
  • readAllDirectMessagesChatTopicReactions — Removes all unread reactions in the topic in a channel direct messages chat administered by the current user
  • readAllForumTopicMentions — Marks all mentions in a topic in a forum supergroup chat as read
  • readAllForumTopicPollVotes — Marks all poll votes in a topic in a forum supergroup chat as read
  • readAllForumTopicReactions — Marks all reactions in a topic in a forum supergroup chat or a chat with a bot with topics as read
  • readBusinessMessage — Reads a message on behalf of a business account; for bots only
  • readChatList — Traverses all chats in a chat list and marks all messages in the chats as read
  • readdQuickReplyShortcutMessages — Re-adds quick reply messages which failed to add. Can be called only for messages for which messageSendingStateFailed...
  • readFilePart — Reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if t...
  • recognizeSpeech — Recognizes speech in a video note or a voice note message
  • recoverAuthenticationPassword — Recovers the 2-step verification password with a password recovery code sent to an email address that was previously ...
  • recoverPassword — Recovers the 2-step verification password using a recovery code sent to an email address that was previously set up
  • refundStarPayment — Refunds a previously done payment in Telegram Stars; for bots only
  • registerDevice — Registers the currently used device for receiving push notifications. Returns a globally unique identifier of the pus...
  • registerUser — Finishes user registration. Works only when the current authorization state is authorizationStateWaitRegistration
  • removeAllFilesFromDownloads — Removes all files from the file download list
  • removeAllWebBrowserSettingsExceptions — Removes special handling for the opening of all links
  • removeBusinessConnectedBotFromChat — Removes the connected business bot from a specific chat by adding the chat to businessRecipients.excluded_chat_ids
  • removeChatActionBar — Removes a chat action bar without any other action
  • removeContacts — Removes users from the contact list
  • removeFavoriteSticker — Removes a sticker from the list of favorite stickers
  • removeFileFromDownloads — Removes a file from the file download list
  • removeGiftCollectionGifts — Removes gifts from a collection. If the collection is owned by a channel chat, then requires can_post_messages admini...
  • removeInstalledBackground — Removes background from the list of installed backgrounds
  • removeLoginPasskey — Removes a passkey from the list of passkeys allowed to be used for the login by the current user
  • removeMessageReaction — Removes a reaction from a message. A chosen reaction can always be removed
  • removeMessageSenderBotVerification — Removes the verification status of a user or a chat by an owned bot
  • removeNotification — Removes an active notification from notification list. Needs to be called only if the notification is removed by the ...
  • removeNotificationGroup — Removes a group of active notifications. Needs to be called only if the notification group is removed by the current ...
  • removePendingLiveStoryReactions — Removes all pending paid reactions in a live story group call
  • removePendingPaidMessageReactions — Removes all pending paid reactions on a message
  • removeProfileAudio — Removes an audio file from the profile audio files of the current user
  • removeProxy — Removes a proxy server. Can be called before authorization
  • removeRecentHashtag — Removes a hashtag from the list of recently used hashtags
  • removeRecentlyFoundChat — Removes a chat from the list of recently found chats
  • removeRecentSticker — Removes a sticker from the list of recently used stickers
  • removeSavedAnimation — Removes an animation from the list of saved animations
  • removeSavedNotificationSound — Removes a notification sound from the list of saved notification sounds
  • removeSearchedForTag — Removes a hashtag or a cashtag from the list of recently searched for hashtags or cashtags
  • removeStickerFromSet — Removes a sticker from the set to which it belongs. The sticker set must be owned by the current user
  • removeStoryAlbumStories — Removes stories from an album. If the album is owned by a supergroup or a channel chat, then requires can_edit_storie...
  • removeTextCompositionStyle — Removes a custom text composition style from the list of used by the user styles. If the style was created by the cur...
  • removeTopChat — Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled
  • removeWebBrowserSettingsException — Removes a special handling for the opening of the specified URL
  • reorderActiveUsernames — Changes order of active usernames of the current user
  • reorderBotActiveUsernames — Changes order of active usernames of a bot. Can be called only if userTypeBot.can_be_edited == true
  • reorderBotMediaPreviews — Changes order of media previews in the list of media previews of a bot
  • reorderChatFolders — Changes the order of chat folders
  • reorderGiftCollectionGifts — Changes order of gifts in a collection. If the collection is owned by a channel chat, then requires can_post_messages...
  • reorderGiftCollections — Changes order of gift collections. If the collections are owned by a channel chat, then requires can_post_messages ad...
  • reorderInstalledStickerSets — Changes the order of installed sticker sets
  • reorderQuickReplyShortcuts — Changes the order of quick reply shortcuts
  • reorderStoryAlbums — Changes order of story albums. If the albums are owned by a supergroup or a channel chat, then requires can_edit_stor...
  • reorderStoryAlbumStories — Changes order of stories in an album. If the album is owned by a supergroup or a channel chat, then requires can_edit...
  • reorderSupergroupActiveUsernames — Changes order of active usernames of a supergroup or channel, requires owner privileges in the supergroup or channel
  • replaceLiveStoryRtmpUrl — Replaces the current RTMP URL for streaming to a live story; requires owner privileges for channel chats
  • replacePrimaryChatInviteLink — Replaces current primary invite link for a chat with a new primary invite link. Available for basic groups, supergrou...
  • replaceStickerInSet — Replaces existing sticker in a set. The function is equivalent to removeStickerFromSet, then addStickerToSet, then se...
  • replaceVideoChatRtmpUrl — Replaces the current RTMP URL for streaming to the video chat of a chat; requires owner privileges in the chat
  • reportAuthenticationCodeMissing — Reports that authentication code wasn't delivered via SMS; for official mobile applications only. Works only when the...
  • reportChat — Reports a chat to the Telegram moderators. A chat can be reported only from the chat action bar, or if chat.can_be_re...
  • reportChatPhoto — Reports a chat photo to the Telegram moderators. A chat photo can be reported only if chat.can_be_reported
  • reportChatSponsoredMessage — Reports a sponsored message to Telegram moderators
  • reportMessageReactions — Reports reactions set on a message to the Telegram moderators. Reactions on a message can be reported only if message...
  • reportPhoneNumberCodeMissing — Reports that authentication code wasn't delivered via SMS to the specified phone number; for official mobile applicat...
  • reportSponsoredChat — Reports a sponsored chat to Telegram moderators
  • reportStory — Reports a story to the Telegram moderators
  • reportSupergroupAntiSpamFalsePositive — Reports a false deletion of a message by aggressive anti-spam checks; requires administrator rights in the supergroup...
  • reportSupergroupSpam — Reports messages in a supergroup as spam; requires administrator rights in the supergroup
  • reportVideoMessageAdvertisement — Reports a video message advertisement to Telegram moderators
  • requestAuthenticationPasswordRecovery — Requests to send a 2-step verification password recovery code to an email address that was previously set up. Works o...
  • requestPasswordRecovery — Requests to send a 2-step verification password recovery code to an email address that was previously set up
  • requestQrCodeAuthentication — Requests QR code authentication by scanning a QR code on another logged in device. Works only when the current author...
  • resendAuthenticationCode — Resends an authentication code to the user. Works only when the current authorization state is authorizationStateWait...
  • resendEmailAddressVerificationCode — Resends the code to verify an email address to be added to a user's Telegram Passport
  • resendLoginEmailAddressCode — Resends the login email address verification code
  • resendMessages — Resends messages which failed to send. Can be called only for messages for which messageSendingStateFailed.can_retry ...
  • resendPhoneNumberCode — Resends the authentication code sent to a phone number. Works only if the previously received authenticationCodeInfo ...
  • resendRecoveryEmailAddressCode — Resends the 2-step verification recovery email address verification code
  • resetAllNotificationSettings — Resets all chat and scope notification settings to their default values. By default, all chats are unmuted and messag...
  • resetAuthenticationEmailAddress — Resets the login email address. May return an error with a message "TASK_ALREADY_EXISTS" if reset is still pending. W...
  • resetInstalledBackgrounds — Resets list of installed backgrounds to its default value
  • resetNetworkStatistics — Resets all network data usage statistics to zero. Can be called before authorization
  • resetPassword — Removes 2-step verification password without previous password and access to recovery email address. The password can...
  • reuseStarSubscription — Reuses an active Telegram Star subscription to a channel chat and joins the chat again
  • revokeChatInviteLink — Revokes invite link for a chat. Available in basic groups, supergroups, and channels. Requires administrator privileg...
  • revokeGroupCallInviteLink — Revokes invite link for a group call. Requires groupCall.can_be_managed right for video chats or groupCall.is_owned o...

S

  • saveApplicationLogEvent — Saves application log event on the server. Can be called before authorization
  • savePreparedInlineMessage — Saves an inline message to be sent by the given user; for bots only
  • savePreparedKeyboardButton — Saves a keyboard button to be shown to the given user; for bots only
  • searchAffiliatePrograms — Searches affiliate programs that can be connected to the given affiliate
  • searchBackground — Searches for a background by its name
  • searchCallMessages — Searches for call and group call messages. Returns the results in reverse chronological order (i.e., in order of decr...
  • searchChatAffiliateProgram — Searches a chat with an affiliate program. Returns the chat if found and the program is active
  • searchChatMembers — Searches for a specified query in the first name, last name and usernames of the members of a specified chat. Require...
  • searchChatMessages — Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order...
  • searchChatRecentLocationMessages — Returns information about the recent live locations of chat members that were sent to the chat. Returns at most one l...
  • searchChats — Searches for the specified query in the title and username of already known chats. This is an offline method. Returns...
  • searchChatsOnServer — Searches for the specified query in the title and username of already known chats via request to the server. Returns ...
  • searchContacts — Searches for the specified query in the first names, last names and usernames of the known user contacts
  • searchEmojis — Searches for emojis by keywords. Supported only if the file database is enabled. Order of results is unspecified
  • searchFileDownloads — Searches for files in the file download list or recently downloaded files from the list
  • searchGiftsForResale — Returns upgraded gifts that can be bought from other owners using sendResoldGift
  • searchHashtags — Searches for recently used hashtags by their prefix
  • searchInstalledStickerSets — Searches for installed sticker sets by looking for specified query in their title and name
  • searchMessages — Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in ...
  • searchOutgoingDocumentMessages — Searches for outgoing messages with content of the type messageDocument in all chats except secret chats. Returns the...
  • searchPublicChat — Searches a public chat by its username. Currently, only private chats, supergroups and channels can be public. Return...
  • searchPublicChats — Searches public chats by looking for specified query in their username and title. Currently, only private chats, supe...
  • searchPublicMessagesByTag — Searches for public channel posts containing the given hashtag or cashtag. For optimal performance, the number of ret...
  • searchPublicPosts — Searches for public channel posts using the given query. For optimal performance, the number of returned messages is ...
  • searchPublicStoriesByLocation — Searches for public stories by the given address location. For optimal performance, the number of returned stories is...
  • searchPublicStoriesByTag — Searches for public stories containing the given hashtag or cashtag. For optimal performance, the number of returned ...
  • searchPublicStoriesByVenue — Searches for public stories from the given venue. For optimal performance, the number of returned stories is chosen b...
  • searchQuote — Searches for a given quote in a text. Returns found quote start position in UTF-16 code units. Returns a 404 error if...
  • searchRecentlyFoundChats — Searches for the specified query in the title and username of up to 50 recently found chats. This is an offline method
  • searchSavedMessages — Searches for messages tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram ...
  • searchSecretMessages — Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance, t...
  • searchStickers — Searches for stickers from public sticker sets that correspond to any of the given emoji
  • searchStickerSet — Searches for a sticker set by its name
  • searchStickerSets — Searches for sticker sets by looking for specified query in their title and name. Excludes installed sticker sets fro...
  • searchStringsByPrefix — Searches specified query by word prefixes in the provided strings. Returns 0-based positions of strings that matched....
  • searchTextCompositionStyle — Searches a custom text composition style by its name
  • searchUserByPhoneNumber — Searches a user by their phone number. Returns a 404 error if the user can't be found
  • searchUserByToken — Searches a user by a token from the user's link
  • searchWebApp — Returns information about a Web App by its short name. Returns a 404 error if the Web App is not found
  • sellGift — Sells a gift for Telegram Stars; requires owner privileges for gifts owned by a chat
  • sendAuthenticationFirebaseSms — Sends Firebase Authentication SMS to the phone number of the user. Works only when the current authorization state is...
  • sendBotStartMessage — Invites a bot to a chat (if it is not yet a member) and sends it the /start command; requires can_invite_users member...
  • sendBusinessMessage — Sends a message on behalf of a business account; for bots only. Returns the message after it was sent
  • sendBusinessMessageAlbum — Sends 2-10 messages grouped together into an album on behalf of a business account; for bots only. Currently, only au...
  • sendCallDebugInformation — Sends debug information for a call to Telegram servers
  • sendCallLog — Sends log file for a call to Telegram servers
  • sendCallRating — Sends a call rating
  • sendCallSignalingData — Sends call signaling data
  • sendChatAction — Sends a notification about user activity in a chat
  • sendCustomRequest — Sends a custom request; for bots only
  • sendEmailAddressVerificationCode — Sends a code to verify an email address to be added to a user's Telegram Passport
  • sendEphemeralMessage — Sends an ephemeral message which will be received only by one bot in a chat. Currently, only ephemeral bot commands a...
  • sendGift — Sends a gift to another user or channel chat. May return an error with a message "STARGIFT_USAGE_LIMITED" if the gift...
  • sendGiftPurchaseOffer — Sends an offer to purchase an upgraded gift
  • sendGroupCallMessage — Sends a message to other participants of a group call. Requires groupCall.can_send_messages right
  • sendInlineQueryResultMessage — Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message
  • sendMessage — Sends a message. Returns the sent message
  • sendMessageAlbum — Sends 2-10 messages grouped together into an album. Currently, only audio, document, photo and video messages can be ...
  • sendMessageViewMetrics — Informs TDLib about details of a message view by the user from a chat, a message thread or a forum topic history. The...
  • sendPassportAuthorizationForm — Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called a...
  • sendPaymentForm — Sends a filled-out payment form to the bot for final verification
  • sendPhoneNumberCode — Sends a code to the specified phone number. Aborts previous phone number verification if there was one. On success, r...
  • sendPhoneNumberFirebaseSms — Sends Firebase Authentication SMS to the specified phone number. Works only when received a code of the type authenti...
  • sendQuickReplyShortcutMessages — Sends messages from a quick reply shortcut. Requires Telegram Business subscription. Can't be used to send paid messages
  • sendResoldGift — Sends an upgraded gift that is available for resale to another user or channel chat; gifts already owned by the curre...
  • sendRichMessageDraft — Sends a draft for a being generated rich message; for bots only
  • sendTextMessageDraft — Sends a draft for a being generated text message; for bots only
  • sendWebAppCustomRequest — Sends a custom request from a Web App
  • sendWebAppData — Sends data received from a keyboardButtonTypeWebApp Web App to a bot
  • setAccentColor — Changes accent color and background custom emoji for the current user; for Telegram Premium users only
  • setAccountTtl — Changes the period of inactivity after which the account of the current user will automatically be deleted
  • setAlarm — Succeeds after a specified amount of time has passed. Can be called before initialization
  • setApplicationVerificationToken — Informs TDLib that application or reCAPTCHA verification has been completed. Can be called before authorization
  • setArchiveChatListSettings — Changes settings for automatic moving of chats to and from the Archive chat lists
  • setAuthenticationEmailAddress — Sets the email address of the user and sends an authentication code to the email address. Works only when the current...
  • setAuthenticationPhoneNumber — Sets the phone number of the user and sends an authentication code to the user. Works only when the current authoriza...
  • setAuthenticationPremiumPurchaseTransaction — Informs server about an in-store purchase of Telegram Premium before authorization. Works only when the current autho...
  • setAutoDownloadSettings — Sets auto-download settings
  • setAutosaveSettings — Sets autosave settings for the given scope. The method is guaranteed to work only after at least one call to getAutos...
  • setBio — Changes the bio of the current user
  • setBirthdate — Changes the birthdate of the current user
  • setBotInfoDescription — 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
  • setBotInfoShortDescription — Sets the text shown on a bot's profile page and sent together with the link when users share the bot. Can be called o...
  • setBotName — Sets the name of a bot. Can be called only if userTypeBot.can_be_edited == true
  • setBotProfilePhoto — Changes a profile photo for a bot
  • setBotUpdatesStatus — Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only
  • setBusinessAccountBio — Changes the bio of a business account; for bots only
  • setBusinessAccountGiftSettings — Changes settings for gift receiving of a business account; for bots only
  • setBusinessAccountName — Changes the first and last name of a business account; for bots only
  • setBusinessAccountProfilePhoto — Changes a profile photo of a business account; for bots only
  • setBusinessAccountUsername — Changes the editable username of a business account; for bots only
  • setBusinessAwayMessageSettings — Changes the business away message settings of the current user. Requires Telegram Business subscription
  • setBusinessConnectedBot — Adds or changes business bot that is connected to the current user account
  • setBusinessGreetingMessageSettings — Changes the business greeting message settings of the current user. Requires Telegram Business subscription
  • setBusinessLocation — Changes the business location of the current user. Requires Telegram Business subscription
  • setBusinessMessageIsPinned — Pins or unpins a message sent on behalf of a business account; for bots only
  • setBusinessOpeningHours — Changes the business opening hours of the current user. Requires Telegram Business subscription
  • setBusinessStartPage — Changes the business start page of the current user. Requires Telegram Business subscription
  • setChatAccentColor — Changes accent color and background custom emoji of a channel chat. Requires can_change_info administrator right
  • setChatActiveStoriesList — Changes story list in which stories from the chat are shown
  • setChatAffiliateProgram — Changes affiliate program for a bot
  • setChatAvailableReactions — Changes reactions, available in a chat. Available for basic groups, supergroups, and channels. Requires can_change_in...
  • setChatBackground — Sets the background in a specific chat. Supported only in private and secret chats with non-deleted users, and in cha...
  • setChatClientData — Changes application-specific data associated with a chat
  • setChatDescription — Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info mem...
  • setChatDirectMessagesGroup — Changes direct messages group settings for a channel chat; requires owner privileges in the chat
  • setChatDiscussionGroup — Changes the discussion group of a channel chat; requires can_change_info administrator right in the channel if it is ...
  • setChatDraftMessage — Changes the draft message in a chat or a topic
  • setChatEmojiStatus — Changes the emoji status of a chat. Use chatBoostLevelFeatures.can_set_emoji_status to check whether an emoji status ...
  • setChatLocation — Changes the location of a chat. Available only for some location-based supergroups, use supergroupFullInfo.can_set_lo...
  • setChatMemberStatus — Changes the status of a chat member; requires can_invite_users member right to add a chat member, can_promote_members...
  • setChatMemberTag — Changes the tag or custom title of a chat member; requires can_manage_tags administrator right to change tag of other...
  • setChatMessageAutoDeleteTime — Changes the message auto-delete or self-destruct (for secret chats) time in a chat. Requires change_info administrato...
  • setChatMessageSender — Selects a message sender to send messages in a chat
  • setChatNotificationSettings — Changes the notification settings of a chat. Notification settings of a chat with the current user (Saved Messages) c...
  • setChatPaidMessageStarCount — Changes the Telegram Star amount that must be paid to send a message to a supergroup chat; requires can_restrict_memb...
  • setChatPermissions — Changes the chat members permissions. Supported only for basic groups and supergroups. Requires can_restrict_members ...
  • setChatPhoto — Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info memb...
  • setChatPinnedStories — Changes the list of pinned stories on a chat page; requires can_edit_stories administrator right in the chat
  • setChatProfileAccentColor — Changes accent color and background custom emoji for profile of a supergroup or channel chat. Requires can_change_inf...
  • setChatSlowModeDelay — Changes the slow mode delay of a chat. Available only for supergroups; requires can_restrict_members administrator right
  • setChatTheme — Changes the chat theme. Supported only in private and secret chats
  • setChatTitle — Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info member right
  • setCloseFriends — Changes the list of close friends of the current user
  • setCommands — Sets the list of commands supported by the bot for the given user scope and language; for bots only
  • setCommunityName — Changes name of the given community; requires can_change_info administrator right in the community
  • setCustomEmojiStickerSetThumbnail — Sets a custom emoji sticker set thumbnail
  • setCustomLanguagePack — Adds or changes a custom local language pack to the current localization target
  • setCustomLanguagePackString — Adds, edits or deletes a string in a custom local language pack. Can be called before authorization
  • setDatabaseEncryptionKey — Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain
  • setDefaultBackground — Sets default background for chats; adds the background to the list of installed backgrounds
  • setDefaultChannelAdministratorRights — Sets default administrator rights for adding the bot to channel chats; for bots only
  • setDefaultGroupAdministratorRights — Sets default administrator rights for adding the bot to basic group and supergroup chats; for bots only
  • setDefaultMessageAutoDeleteTime — Changes the default message auto-delete time for new chats
  • setDefaultReactionType — Changes type of default reaction for the current user
  • setDirectMessagesChatTopicIsMarkedAsUnread — Changes the marked as unread state of the topic in a channel direct messages chat administered by the current user
  • setEmojiStatus — Changes the emoji status of the current user; for Telegram Premium users only
  • setFileGenerationProgress — Informs TDLib on a file generation progress
  • setForumTopicNotificationSettings — Changes the notification settings of a forum topic in a forum supergroup chat or a chat with a bot with topics
  • setGameScore — Updates the game score of the specified user in the game; for bots only
  • setGiftCollectionName — Changes name of a gift collection. If the collection is owned by a channel chat, then requires can_post_messages admi...
  • setGiftResalePrice — Changes resale price of a unique gift owned by the current user
  • setGiftSettings — Changes settings for gift receiving for the current user
  • setGroupCallPaidMessageStarCount — Changes the minimum number of Telegram Stars that must be paid by general participant for each sent message to a live...
  • setGroupCallParticipantIsSpeaking — Informs TDLib that speaking state of a participant of an active group call has changed. Returns identifier of the par...
  • setGroupCallParticipantVolumeLevel — Changes volume level of a participant of an active group call; not supported for live stories. If the current user ca...
  • setInactiveSessionTtl — Changes the period of inactivity after which sessions will automatically be terminated
  • setInlineGameScore — Updates the game score of the specified user in a game; for bots only
  • setLiveStoryMessageSender — Selects a message sender to send messages in a live story call
  • setLoginEmailAddress — Changes the login email address of the user. The email address can be changed only if the current user already has lo...
  • setLogStream — Sets new log stream for internal logging of TDLib. Can be called synchronously
  • setLogTagVerbosityLevel — Sets the verbosity level for a specified TDLib internal log tag. Can be called synchronously
  • setLogVerbosityLevel — Sets the verbosity level of the internal logging of TDLib. Can be called synchronously
  • setMainProfileTab — Changes the main profile tab of the current user
  • setManagedBotAccessSettings — Sets access settings of a managed bot; for bots only
  • setMenuButton — Sets menu button for the given user or for all users; for bots only
  • setMessageFactCheck — Changes the fact-check of a message. Can be only used if messageProperties.can_set_fact_check == true
  • setMessageReactions — Sets reactions on a message; for bots only
  • setMessageSenderBlockList — Changes the block list of a message sender. Currently, only users and supergroup chats can be blocked
  • setMessageSenderBotVerification — Changes the verification status of a user or a chat by an owned bot
  • setName — Changes the first and last name of the current user
  • setNetworkType — Sets the current network type. Can be called before authorization. Calling this method forces all network connections...
  • setNewChatPrivacySettings — Changes privacy settings for new chat creation; can be used only if getOption("can_set_new_chat_privacy_settings")
  • setOption — Sets the value of an option. (Check the list of available options on https://core.telegram.org/tdlib/options.) Only w...
  • setPaidMessageReactionType — Changes type of paid message reaction of the current user on a message. The message must have paid reaction added by ...
  • setPassportElement — Adds an element to the user's Telegram Passport. May return an error with a message "PHONE_VERIFICATION_NEEDED" or "E...
  • setPassportElementErrors — Informs the user that some of the elements in their Telegram Passport contain errors; for bots only. The user will no...
  • setPassword — Changes the 2-step verification password for the current user. If a new recovery email address is specified, then the...
  • setPersonalChat — Changes the personal chat of the current user
  • setPinnedChats — Changes the order of pinned chats
  • setPinnedForumTopics — Changes the order of pinned topics in a forum supergroup chat or a chat with a bot with topics; requires can_manage_t...
  • setPinnedGifts — Changes the list of pinned gifts on the current user's or the channel's profile page; requires can_post_messages admi...
  • setPinnedSavedMessagesTopics — Changes the order of pinned Saved Messages topics
  • setPollAnswer — Changes the user answer to a poll
  • setProfileAccentColor — Changes accent color and background custom emoji for profile of the current user; for Telegram Premium users only
  • setProfileAudioPosition — Changes position of an audio file in the profile audio files of the current user
  • setProfilePhoto — Changes a profile photo for the current user
  • setQuickReplyShortcutName — Changes name of a quick reply shortcut
  • setReactionNotificationSettings — Changes notification settings for reactions
  • setReadDatePrivacySettings — Changes privacy settings for message read date
  • setRecoveryEmailAddress — Changes the 2-step verification recovery email address of the user. If a new recovery email address is specified, the...
  • setSavedMessagesTagLabel — Changes label of a Saved Messages tag; for Telegram Premium users only
  • setScopeNotificationSettings — Changes notification settings for chats of a given type
  • setStickerEmojis — Changes the list of emojis corresponding to a sticker. The sticker must belong to a regular or custom emoji sticker s...
  • setStickerKeywords — Changes the list of keywords of a sticker. The sticker must belong to a regular or custom emoji sticker set that is o...
  • setStickerMaskPosition — Changes the mask position of a mask sticker. The sticker must belong to a mask sticker set that is owned by the curre...
  • setStickerPositionInSet — Changes the position of a sticker in the set to which it belongs. The sticker set must be owned by the current user
  • setStickerSetThumbnail — Sets a sticker set thumbnail
  • setStickerSetTitle — Sets a sticker set title
  • setStoryAlbumName — Changes name of an album of stories. If the album is owned by a supergroup or a channel chat, then requires can_edit_...
  • setStoryPrivacySettings — Changes privacy settings of a story. The method can be called only for stories posted on behalf of the current user a...
  • setStoryReaction — Changes chosen reaction on a story that has already been sent; not supported for live stories
  • setSupergroupCustomEmojiStickerSet — Changes the custom emoji sticker set of a supergroup; requires can_change_info administrator right. The chat must hav...
  • setSupergroupMainProfileTab — Changes the main profile tab of the channel; requires can_change_info administrator right
  • setSupergroupStickerSet — Changes the sticker set of a supergroup; requires can_change_info administrator right
  • setSupergroupUnrestrictBoostCount — Changes the number of times the supergroup must be boosted by a user to ignore slow mode and chat permission restrict...
  • setSupergroupUsername — Changes the editable username of a supergroup or channel, requires owner privileges in the supergroup or channel
  • setTdlibParameters — Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWa...
  • setUpgradedGiftColors — Changes color scheme for the current user based on an owned or a hosted upgraded gift; for Telegram Premium users only
  • setUserEmojiStatus — Changes the emoji status of a user; for bots only
  • setUsername — Changes the editable username of the current user
  • setUserNote — Changes a note of a contact user
  • setUserPersonalProfilePhoto — Changes a personal profile photo of a contact user
  • setUserPrivacySettingRules — Changes user privacy settings
  • setUserSupportInfo — Sets support information for the given user; for Telegram support only
  • setVideoChatDefaultParticipant — Changes default participant identifier, on whose behalf a video chat in the chat will be joined
  • setVideoChatTitle — Sets title of a video chat; requires groupCall.can_be_managed right
  • shareChatWithBot — Shares a chat after pressing a keyboardButtonTypeRequestChat button with the bot
  • sharePhoneNumber — Shares the phone number of the current user with a mutual contact. Supposed to be called when the user clicks on chat...
  • shareUsersWithBot — Shares users after pressing a keyboardButtonTypeRequestUsers button with the bot
  • startGroupCallRecording — Starts recording of an active group call; for video chats only. Requires groupCall.can_be_managed right
  • startGroupCallScreenSharing — Starts screen sharing in a joined group call; not supported in live stories. Returns join response payload for tgcalls
  • startLiveStory — Starts a new live story on behalf of a chat; requires can_post_stories administrator right for channel chats
  • startScheduledVideoChat — Starts a scheduled video chat
  • stopBusinessPoll — Stops a poll sent on behalf of a business account; for bots only
  • stopPendingMessage — Stops a pending message generation by a bot
  • stopPoll — Stops a poll
  • suggestUserBirthdate — Suggests a birthdate to another regular user with common messages and allowing non-paid messages
  • suggestUserProfilePhoto — Suggests a profile photo to another regular user with common messages and allowing non-paid messages
  • summarizeMessage — Summarizes content of the message with non-empty summary_language_code
  • synchronizeLanguagePack — Fetches the latest versions of all strings from a language pack in the current localization target from the server. T...

T

  • terminateAllOtherSessions — Terminates all other sessions of the current user. Additionally, the user must be suggested to delete the connected b...
  • terminateSession — Terminates a session of the current user
  • testCallBytes — Returns the received bytes; for testing only. This is an offline method. Can be called before authorization
  • testCallEmpty — Does nothing; for testing only. This is an offline method. Can be called before authorization
  • testCallString — Returns the received string; for testing only. This is an offline method. Can be called before authorization
  • testCallVectorInt — Returns the received vector of numbers; for testing only. This is an offline method. Can be called before authorization
  • testCallVectorIntObject — Returns the received vector of objects containing a number; for testing only. This is an offline method. Can be calle...
  • testCallVectorString — Returns the received vector of strings; for testing only. This is an offline method. Can be called before authorization
  • testCallVectorStringObject — Returns the received vector of objects containing a string; for testing only. This is an offline method. Can be calle...
  • testGetDifference — Forces an updates.getDifference call to the Telegram servers; for testing only
  • testNetwork — Sends a simple network request to the Telegram servers; for testing only. Can be called before authorization
  • testProxy — Sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization
  • testReturnError — Returns the specified error and ensures that the Error object is used; for testing only. Can be called synchronously
  • testSquareInt — Returns the squared received number; for testing only. This is an offline method. Can be called before authorization
  • testUseUpdate — Does nothing and ensures that the Update object is used; for testing only. This is an offline method. Can be called b...
  • toggleAllDownloadsArePaused — Changes pause state of all files in the file download list
  • toggleBotCanManageEmojiStatus — Toggles whether the bot can manage emoji status of the current user
  • toggleBotIsAddedToAttachmentMenu — Adds or removes a bot to attachment and side menu. Bot can be added to the menu, only if userTypeBot.can_be_added_to_...
  • toggleBotUsernameIsActive — Changes active state for a username of a bot. The editable username can be disabled only if there are other active us...
  • toggleBusinessConnectedBotChatIsPaused — Pauses or resumes the connected business bot in a specific chat
  • toggleChatDefaultDisableNotification — Changes the value of the default disable_notification parameter, used when a message is sent to a chat
  • toggleChatFolderTags — Toggles whether chat folder tags are enabled
  • toggleChatGiftNotifications — Toggles whether notifications for new gifts received by a channel chat are sent to the current user; requires can_pos...
  • toggleChatHasProtectedContent — Changes the ability of users to save, forward, or copy chat content. Requires owner privileges in basic groups, super...
  • toggleChatIsMarkedAsUnread — Changes the marked as unread state of a chat
  • toggleChatIsPinned — Changes the pinned state of a chat. There can be up to getOption("pinned_chat_count_max")/getOption("pinned_archived_...
  • toggleChatIsTranslatable — Changes the translatable state of a chat
  • toggleChatViewAsTopics — Changes the view_as_topics setting of a forum chat or Saved Messages
  • toggleDirectMessagesChatTopicCanSendUnpaidMessages — Allows to send unpaid messages to the given topic of the channel direct messages chat administered by the current user
  • toggleDownloadIsPaused — Changes pause state of a file in the file download list
  • toggleForumTopicIsClosed — Toggles whether a topic is closed in a forum supergroup chat; requires can_manage_topics administrator right in the s...
  • toggleForumTopicIsPinned — Changes the pinned state of a topic in a forum supergroup chat or a chat with a bot with topics; requires can_manage_...
  • toggleGeneralForumTopicIsHidden — Toggles whether a General topic is hidden in a forum supergroup chat; requires can_manage_topics administrator right ...
  • toggleGiftIsSaved — Toggles whether a gift is shown on the current user's or the channel's profile page; requires can_post_messages admin...
  • toggleGroupCallAreMessagesAllowed — Toggles whether participants of a group call can send messages there. Requires groupCall.can_toggle_are_messages_allo...
  • toggleGroupCallIsMyVideoEnabled — Toggles whether current user's video is enabled
  • toggleGroupCallIsMyVideoPaused — Toggles whether current user's video is paused
  • toggleGroupCallParticipantIsHandRaised — Toggles whether a group call participant hand is rased; for video chats only
  • toggleGroupCallParticipantIsMuted — Toggles whether a participant of an active group call is muted, unmuted, or allowed to unmute themselves; not support...
  • toggleGroupCallScreenSharingIsPaused — Pauses or unpauses screen sharing in a joined group call; not supported in live stories
  • toggleHasSponsoredMessagesEnabled — Toggles whether the current user has sponsored messages enabled. The setting has no effect for users without Telegram...
  • toggleSavedMessagesTopicIsPinned — Changes the pinned state of a Saved Messages topic. There can be up to getOption("pinned_saved_messages_topic_count_m...
  • toggleSessionCanAcceptCalls — Toggles whether a session can accept incoming calls
  • toggleSessionCanAcceptSecretChats — Toggles whether a session can accept incoming secret chats
  • toggleStoryIsPostedToChatPage — Toggles whether a story is accessible after expiration. Can be called only if story.can_toggle_is_posted_to_chat_page...
  • toggleSupergroupCanHaveSponsoredMessages — Toggles whether sponsored messages are shown in the channel chat; requires owner privileges in the channel. The chat ...
  • toggleSupergroupHasAggressiveAntiSpamEnabled — Toggles whether aggressive anti-spam checks are enabled in the supergroup. Can be called only if supergroupFullInfo.c...
  • toggleSupergroupHasAutomaticTranslation — Toggles whether messages are automatically translated in the channel chat; requires can_change_info administrator rig...
  • toggleSupergroupHasHiddenMembers — Toggles whether non-administrators can receive only administrators and bots using getSupergroupMembers or searchChatM...
  • toggleSupergroupIsAllHistoryAvailable — Toggles whether the message history of a supergroup is available to new members; requires can_change_info member right
  • toggleSupergroupIsBroadcastGroup — Upgrades supergroup to a broadcast group; requires owner privileges in the supergroup
  • toggleSupergroupIsForum — Toggles whether the supergroup is a forum; requires owner privileges in the supergroup. Discussion supergroups can't ...
  • toggleSupergroupJoinByRequest — Toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires ...
  • toggleSupergroupJoinToSendMessages — Toggles whether joining is mandatory to send messages to a discussion supergroup; requires can_restrict_members admin...
  • toggleSupergroupSignMessages — Toggles whether sender signature or link to the account is added to sent messages in a channel; requires can_change_i...
  • toggleSupergroupUsernameIsActive — Changes active state for a username of a supergroup or channel, requires owner privileges in the supergroup or channe...
  • toggleUsernameIsActive — Changes active state for a username of the current user. The editable username can't be disabled. May return an error...
  • toggleVideoChatEnabledStartNotification — Toggles whether the current user will receive a notification when the video chat starts; for scheduled video chats only
  • toggleVideoChatMuteNewParticipants — Toggles whether new participants of a video chat can be unmuted only by administrators of the video chat. Requires gr...
  • transferBusinessAccountStars — Transfers Telegram Stars from the business account to the business bot; for bots only
  • transferChatOwnership — Changes the owner of a chat; for basic groups, supergroups and channel chats only; requires owner privileges in the c...
  • transferGift — Sends an upgraded gift to another user or channel chat
  • translateMessageRichMessage — Extracts rich message of the given message and translates it to the given language
  • translateMessageText — Extracts text or caption of the given message and translates it to the given language; must not be used in secret cha...
  • translateRichMessage — Translates a rich message to the given language
  • translateText — Translates a text to the given language; must not be used in secret chats. If the current user is a Telegram Premium ...

U

  • unpinAllChatMessages — Removes all pinned messages from a chat; requires can_pin_messages member right if the chat is a basic group or super...
  • unpinAllDirectMessagesChatTopicMessages — Removes all pinned messages from the topic in a channel direct messages chat administered by the current user
  • unpinAllForumTopicMessages — Removes all pinned messages from a topic in a forum supergroup chat or a chat with a bot with topics; requires can_pi...
  • unpinChatMessage — Removes a pinned message from a chat; requires can_pin_messages member right if the chat is a basic group or supergro...
  • upgradeBasicGroupChatToSupergroupChat — Creates a new supergroup from an existing basic group and sends a corresponding messageChatUpgradeTo and messageChatU...
  • upgradeGift — Upgrades a regular gift
  • uploadStickerFile — Uploads a file with a sticker; returns the uploaded file

V

  • validateOrderInfo — Validates the order information provided by a user and returns the available shipping options for a flexible invoice
  • viewMessages — Informs TDLib that messages are being viewed by the user. Sponsored messages must be marked as viewed only when the e...
  • viewPremiumFeature — Informs TDLib that the user viewed detailed information about a Premium feature on the Premium features screen
  • viewSponsoredChat — Informs TDLib that the user fully viewed a sponsored chat
  • viewTrendingStickerSets — Informs the server that some trending sticker sets have been viewed by the user
  • viewVideoMessageAdvertisement — Informs TDLib that the user viewed a video message advertisement

W

  • writeGeneratedFilePart — Writes a part of a generated file. This method is intended to be used only if the application has no direct access to...