MadelineProtoDocs/docs/TD_docs/methods/index.md

title	description	image
Methods	What do you want to do?	https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

What do you want to do?

Go back to API documentation index

Go to the old code-version method index

• Logout

• Login

• Get all chats, broadcast a message to all chats

• Get the full participant list of a channel/group/supergroup

• Get full info about a user/chat/supergroup/channel

• Get info about a user/chat/supergroup/channel

• Get info about the currently logged-in user

• Upload or download files up to 1.5 GB

• Make a phone call and play a song

• Create a secret chat bot

• Accepts incoming call: acceptCall

• Adds chat to the list of recently found chats. The chat is added to the beginning of the list. If the chat is already in the list, at first it is removed from the list: addRecentlyFoundChat

• Adds many new members to the chat. Currently, available only for channels. Can't be used to join the channel. Members can't be added to broadcast channel if it has more than 200 members. Members will not be added until chat state will be synchronized with the server: addChatMembers

• Adds new contacts/edits existing contacts, contacts user identifiers are ignored: importContacts

• Adds new member to chat. Members can't be added to private or secret chats. Member will not be added until chat state will be synchronized with the server: addChatMember

• Adds new sticker to the list of favorite stickers. New sticker is added to the beginning of the list. If the sticker is already in the list, at first it is removed from the list. Only stickers belonging to a sticker set can be added to the list: addFavoriteSticker

• Adds specified data to data usage statistics. Can be called before authorization: addNetworkStatistics

• Adds user to black list: blockUser

• Asynchronously downloads file from cloud. Updates updateFile will notify about download progress and successful download: downloadFile

• Asynchronously uploads file to the cloud without sending it in a message. Updates updateFile will notify about upload progress and successful upload. The file will not have persistent identifier until it will be sent in a message: uploadFile

• Bots only. Adds new sticker to a set. Returns the sticker set: addStickerToSet

• Bots only. Answers a custom query: answerCustomQuery

• Bots only. Changes position of a sticker in the set it belongs to. Sticker set should be created by the bot: setStickerPositionInSet

• Bots only. Creates new sticker set. Returns created sticker set: createNewStickerSet

• Bots only. Deletes a sticker from the set it belongs to. Sticker set should be created by the bot: deleteStickerFromSet

• Bots only. Edits caption of an inline message content sent via bot: editInlineMessageCaption

• Bots only. Edits message reply markup. Returns edited message after edit is complete server side: editMessageReplyMarkup

• Bots only. Edits reply markup of an inline message sent via bot: editInlineMessageReplyMarkup

• Bots only. Edits text of an inline text or game message sent via bot: editInlineMessageText

• Bots only. Informs server about number of pending bot updates if they aren't processed for a long time: setBotUpdatesStatus

• Bots only. Returns game high scores and some part of the score table around of the specified user in the game: getGameHighScores

• Bots only. Returns game high scores and some part of the score table around of the specified user in the game: getInlineGameHighScores

• Bots only. Sends custom request: sendCustomRequest

• Bots only. Sets result of a callback query: answerCallbackQuery

• Bots only. Sets result of a pre checkout query: answerPreCheckoutQuery

• Bots only. Sets result of a shipping query: answerShippingQuery

• Bots only. Sets result of an inline query: answerInlineQuery

• Bots only. Updates game score of the specified user in the game: setGameScore

• Bots only. Updates game score of the specified user in the game: setInlineGameScore

• Bots only. Uploads a png image with a sticker. Returns uploaded file: uploadStickerFile

• Changes about information of logged in user: changeAbout

• Changes chat draft message: changeChatDraftMessage

• Changes chat photo. Works only for group and channel chats. Requires administrator rights in groups and appropriate administrator right in channels. Photo will not change before request to the server completes: changeChatPhoto

• Changes chat pinned state. You can pin up to getOption("pinned_chat_count_max") non-secret chats and the same number of secret chats: toggleChatIsPinned

• Changes chat title. Works only for group and channel chats. Requires administrator rights in groups and appropriate administrator right in channels. Title will not change before request to the server completes: changeChatTitle

• Changes client data associated with a chat: setChatClientData

• Changes current ttl setting in a secret chat and sends corresponding message: sendChatSetTtlMessage

• Changes first and last names of logged in user. If something changes, updateUser will be sent: changeName

• Changes information about the channel. Needs appropriate rights in the channel: changeChannelDescription

• Changes list or order of pinned chats: setPinnedChats

• Changes notification settings for a given scope: setNotificationSettings

• Changes period of inactivity, after which the account of currently logged in user will be automatically deleted: changeAccountTtl

• Changes privacy settings: setPrivacy

• Changes status of the chat member, need appropriate privileges. This function is currently not suitable for adding new members to the chat, use addChatMember instead. Status will not be changed until chat state will be synchronized with the server: changeChatMemberStatus

• Changes sticker set of the channel. Needs appropriate rights in the channel: setChannelStickerSet

• Changes the order of installed sticker sets: reorderInstalledStickerSets

• Changes user password. If new recovery email is specified, then error EMAIL_UNCONFIRMED is returned and password change will not be applied until email confirmation. Application should call getPasswordState from time to time to check if email is already confirmed: setPassword

• Changes user recovery email. If new recovery email is specified, then error EMAIL_UNCONFIRMED is returned and email will not be changed until email confirmation. Application should call getPasswordState from time to time to check if email is already confirmed. -If new_recovery_email coincides with the current set up email succeeds immediately and aborts all other requests waiting for email confirmation: setRecoveryEmail

• Changes user's phone number and sends authentication code to the new user's phone number. Returns authStateWaitCode with information about sent code on success: changePhoneNumber

• Changes username of logged in user. If something changes, updateUser will be sent: changeUsername

• Changes username of the channel. Needs creator privileges in the channel: changeChannelUsername

• Chat is closed by the user. Many useful activities depends on chat being opened or closed.: closeChat

• Chat is opened by the user. Many useful activities depends on chat being opened or closed. For example, in channels all updates are received only for opened chats: openChat

• Check bot's authentication token to log in as a bot. Works only when getAuthState returns authStateWaitPhoneNumber. Can be used instead of setAuthPhoneNumber and checkAuthCode to log in. Returns authStateOk on success: checkAuthBotToken

• Checks authentication code sent to change user's phone number. Returns authStateOk on success: checkChangePhoneNumberCode

• Checks authentication code. Works only when getAuthState returns authStateWaitCode. Returns authStateWaitPassword or authStateOk on success: checkAuthCode

• Checks chat invite link for validness and returns information about the corresponding chat: checkChatInviteLink

• Checks password for correctness. Works only when getAuthState returns authStateWaitPassword. Returns authStateOk on success: checkAuthPassword

• Clears list of recently found chats: deleteRecentlyFoundChats

• Clears list of recently used stickers: clearRecentStickers

• Closes secret chat, effectively transfering its state to "Closed": closeSecretChat

• Creates new call: createCall

• Creates new channel chat and send corresponding messageChannelChatCreate, returns created chat: createNewChannelChat

• Creates new channel supergroup chat from existing group chat and send corresponding messageChatMigrateTo and messageChatMigrateFrom. Deactivates group: migrateGroupChatToChannelChat

• Creates new group chat and send corresponding messageGroupChatCreate, returns created chat: createNewGroupChat

• Creates new secret chat, returns created chat: createNewSecretChat

• Creates new temporary password for payments processing: createTemporaryPassword

• Delete a chat from a list of frequently used chats. Supported only if chat info database is enabled: deleteTopChat

• Deletes a file from TDLib file cache: deleteFile

• Deletes a hashtag from the list of recently used hashtags: deleteRecentHashtag

• Deletes all imported contacts: deleteImportedContacts

• Deletes all messages in the chat sent by the specified user. Works only in supergroup channel chats, needs can_delete_messages administrator privileges: deleteMessagesFromUser

• Deletes all messages in the chat. Can't be used for channel chats: deleteChatHistory

• Deletes channel along with all messages in corresponding chat. Releases channel username and removes all members. Needs creator privileges in the channel. Channels with more than 1000 members can't be deleted: deleteChannel

• Deletes chat from the list of recently found chats: deleteRecentlyFoundChat

• Deletes default reply markup from chat. This method needs to be called after one-time keyboard or ForceReply reply markup has been used. UpdateChatReplyMarkup will be send if reply markup will be changed: deleteChatReplyMarkup

• Deletes messages: deleteMessages

• Deletes profile photo. If something changes, updateUser will be sent: deleteProfilePhoto

• Deletes saved credentials for all payments provider bots: deleteSavedCredentials

• Deletes saved order info: deleteSavedOrderInfo

• Deletes the account of currently logged in user, deleting from the server all information associated with it. Account's phone number can be used to create new account, but only once in two weeks: deleteAccount

• Deletes users from contacts list: deleteContacts

• Discards a call: discardCall

• Edits message content caption. Non-bots can edit message in a limited period of time. Returns edited message after edit is complete server side: editMessageCaption

• Edits text of text or game message. Non-bots can edit message in a limited period of time. Returns edited message after edit is complete server side: editMessageText

• Enables or disables sender signature on sent messages in the channel. Needs appropriate rights in the channel. Not available for supergroups: toggleChannelSignMessages

• Finishes file generation: finishFileGeneration

• Forwards previously sent messages. Returns forwarded messages in the same order as message identifiers passed in message_ids. If message can't be forwarded, null will be returned instead of the message: forwardMessages

• Generates new chat invite link, previously generated link is revoked. Available for group and channel chats. In groups can be called only by creator, in channels requires appropriate rights: exportChatInviteLink

• Gives or revokes all members of the group administrator rights. Needs creator privileges in the group: toggleGroupAdministrators

• Gives or revokes right to invite new members to all current members of the channel. Needs appropriate rights in the channel. Available only for supergroups: toggleChannelInvites

• Handles DC_UPDATE push service notification. Can be called before authorization: processDcUpdate

• Imports chat invite link, adds current user to a chat if possible. Member will not be added until chat state will be synchronized with the server: importChatInviteLink

• Informs that some trending sticker sets are viewed by the user: viewTrendingStickerSets

• Installs/uninstalls or enables/archives sticker set: changeStickerSet

• Invites bot to a chat (if it is not in the chat) and send /start to it. Bot can't be invited to a private chat other than chat with the bot. Bots can't be invited to broadcast channel chats and secret chats. Returns sent message: sendBotStartMessage

• Logs out user. If force == false, begins to perform soft log out, returns authStateLoggingOut after completion. If force == true then succeeds almost immediately without cleaning anything at the server, but returns error with code 401 and description "Unauthorized": resetAuth

• Manually adds new animation to the list of saved animations. New animation is added to the beginning of the list. If the animation is already in the list, at first it is removed from the list. Only non-secret video animations with MIME type "video/mp4" can be added to the list: addSavedAnimation

• Manually adds new sticker to the list of recently used stickers. New sticker is added to the beginning of the list. If the sticker is already in the list, at first it is removed from the list. Only stickers belonging to a sticker set can be added to the list: addRecentSticker

• Message content is opened, for example the user has opened a photo, a video, a document, a location or a venue or have listened to an audio or a voice message. You will receive updateOpenMessageContent if something has changed: openMessageContent

• Messages are viewed by the user. Many useful activities depends on message being viewed. For example, marking messages as read, incrementing of view counter, updating of view counter, removing of deleted messages in channels: viewMessages

• Next part of a file was generated: setFileGenerationProgress

• Optimizes storage usage, i.e. deletes some files and return new storage usage statistics. Secret thumbnails can't be deleted: optimizeStorage

• Pins a message in a supergroup channel chat. Needs appropriate rights in the channel: pinChannelMessage

• Quickly returns approximate storage usage statistics: getStorageStatisticsFast

• Recovers password with recovery code sent to email. Works only when getAuthState returns authStateWaitPassword. Returns authStateOk on success: recoverAuthPassword

• Recovers password with recovery code sent to email: recoverPassword

• Registers current used device for receiving push notifications: registerDevice

• Removes a sticker from the list of favorite stickers: deleteFavoriteSticker

• Removes a sticker from the list of recently used stickers: deleteRecentSticker

• Removes an animation from the list of saved animations: deleteSavedAnimation

• Removes pinned message in the supergroup channel. Needs appropriate rights in the channel: unpinChannelMessage

• Removes user from black list: unblockUser

• Reports chat as a spam chat or as not a spam chat. Can be used only if ChatReportSpamState.can_report_spam is true. After this request ChatReportSpamState.can_report_spam became false forever: changeChatReportSpamState

• Reports chat to Telegram moderators. Can be used only for a channel chat or a private chat with a bot, because all other chats can't be checked by moderators: reportChat

• Reports some supergroup channel messages from a user as spam messages: reportChannelSpam

• Requests to send password recovery code to email. Works only when getAuthState returns authStateWaitPassword. Returns authStateWaitPassword on success: requestAuthPasswordRecovery

• Requests to send password recovery code to email: requestPasswordRecovery

• Resends authentication code sent to change user's phone number. Wotks only if in previously received authStateWaitCode next_code_type was not null. Returns authStateWaitCode on success: resendChangePhoneNumberCode

• Resends authentication code to the user. Works only when getAuthState returns authStateWaitCode and next_code_type of result is not null. Returns authStateWaitCode on success: resendAuthCode

• Resets all network data usage statistics to zero. Can be called before authorization: resetNetworkStatistics

• Resets all notification settings to the default value. By default the only muted chats are supergroups, sound is set to 'default' and message previews are showed: resetAllNotificationSettings

• Returns Ok after specified amount of the time passed. Can be called before authorization: setAlarm

• Returns a list of frequently used chats. Supported only if chat info database is enabled: getTopChats

• Returns all active sessions of logged in user: getActiveSessions

• Returns all mentions, hashtags, bot commands, URLs and emails contained in the text. Offline method. Can be called before authorization. Can be called synchronously: getTextEntities

• Returns background wallpapers: getWallpapers

• Returns current authorization state, offline request: getAuthState

• Returns current chat report spam state: getChatReportSpamState

• Returns current logged in user: getMe

• Returns current privacy settings: getPrivacy

• Returns current set up proxy. Can be called before authorization: getProxy

• Returns current state of two-step verification: getPasswordState

• Returns emojis corresponding to a sticker: getStickerEmojis

• Returns existing chat corresponding to the given user: createPrivateChat

• Returns existing chat corresponding to the known channel: createChannelChat

• Returns existing chat corresponding to the known group: createGroupChat

• Returns existing chat corresponding to the known secret chat: createSecretChat

• Returns favorite stickers: getFavoriteStickers

• Returns file's extension guessing only by its mime type. Returns empty string on failure. Offline method. Can be called before authorization. Can be called synchronously: getFileExtension

• Returns file's mime type guessing only by its extension. Returns empty string on failure. Offline method. Can be called before authorization. Can be called synchronously: getFileMimeType

• Returns full information about a channel by its identifier, cached for at most 1 minute: getChannelFull

• Returns full information about a group by its identifier: getGroupFull

• Returns full information about a user by its identifier: getUserFull

• Returns information about a channel by its identifier, offline request if current user is not a bot: getChannel

• Returns information about a chat by its identifier, offline request if current user is not a bot: getChat

• Returns information about a file by its persistent id, offline request. May be used to register a URL as a file for further uploading or sending as message: getFilePersistent

• Returns information about a file, offline request: getFile

• Returns information about a group by its identifier, offline request if current user is not a bot: getGroup

• Returns information about a message: getMessage

• Returns information about a secret chat by its identifier, offline request: getSecretChat

• Returns information about a user by its identifier, offline request if current user is not a bot: getUser

• Returns information about channel members or banned users. Can be used only if channel_full->can_get_members == true. Administrator privileges may be additionally needed for some filters: getChannelMembers

• Returns information about current temporary password: getTemporaryPasswordState

• Returns information about messages. If message is not found, returns null on the corresponding position of the result: getMessages

• Returns information about one participant of the chat: getChatMember

• Returns information about sticker set by its identifier: getStickerSet

• Returns information about successful payment: getPaymentReceipt

• Returns invite text for invitation of new users: getInviteText

• Returns invoice payment form. The method should be called when user presses inlineKeyboardButtonBuy: getPaymentForm

• Returns list of archived sticker sets: getArchivedStickerSets

• Returns list of chats in the right order, chats are sorted by (order, chat_id) in decreasing order. For example, to get list of chats from the beginning, the offset_order should be equal 2^63 - 1: getChats

• Returns list of common chats with an other given user. Chats are sorted by their type and creation date: getCommonChats

• Returns list of created public chats: getCreatedPublicChats

• Returns list of installed sticker sets: getInstalledStickerSets

• Returns list of recently used stickers: getRecentStickers

• Returns list of service actions taken by chat members and administrators in the last 48 hours, available only in channels. Requires administrator rights. Returns result in reverse chronological order, i. e. in order of decreasing event_id: getChatEventLog

• Returns list of sticker sets attached to a file, currently only photos and videos can have attached sticker sets: getAttachedStickerSets

• Returns list of trending sticker sets: getTrendingStickerSets

• Returns messages in a chat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id. Offline request if only_local is true: getChatHistory

• Returns network data usage statistics. Can be called before authorization: getNetworkStatistics

• Returns notification settings for a given scope: getNotificationSettings

• Returns period of inactivity, after which the account of currently logged in user will be automatically deleted: getAccountTtl

• Returns profile photos of the user. Result of this query may be outdated: some photos may be already deleted: getUserProfilePhotos

• Returns public HTTPS link to a message. Available only for messages in public channels: getPublicMessageLink

• Returns saved animations: getSavedAnimations

• Returns saved order info if any: getSavedOrderInfo

• Returns set up recovery email. This method can be used to verify a password provided by the user: getRecoveryEmail

• Returns stickers from installed ordinary sticker sets corresponding to the given emoji. If emoji is not empty, elso favorite and recently used stickers may be returned: getStickers

• Returns storage usage statistics: getStorageStatistics

• Returns terms of service. Can be called before authorization: getTermsOfService

• Returns total number of imported contacts: getImportedContactCount

• Returns up to 20 recently used inline bots in the order of the last usage: getRecentInlineBots

• Returns user that can be contacted to get support: getSupportUser

• Returns users blocked by the current user: getBlockedUsers

• Returns value of an option by its name. See list of available options on https: core.telegram.org/tdlib/options. Can be called before authorization: getOption

• Returns web page instant view if available. Returns error 404 if web page has no instant view: getWebPageInstantView

• Returns web page preview by text of the message. Do not call this function to often. Returns error 404 if web page has no preview: getWebPagePreview

• Searches for call messages. Returns result in reverse chronological order, i. e. in order of decreasing message_id: searchCallMessages

• Searches for messages in all chats except secret chats. Returns result in reverse chronological order, i. e. in order of decreasing (date, chat_id, message_id): searchMessages

• Searches for messages in secret chats. Returns result in reverse chronological order: searchSecretMessages

• Searches for messages with given words in the chat. Returns result in reverse chronological order, i. e. in order of decreasing message_id. Doesn't work in secret chats with non-empty query (searchSecretMessages should be used instead) or without enabled message database: searchChatMessages

• Searches for recently used hashtags by their prefix: searchHashtags

• Searches for specified query in the first name, last name and username of the known user contacts: searchContacts

• Searches for specified query in the title and username of known chats, offline request. Returns chats in the order of them in the chat list: searchChats

• Searches for the specified query in the first name, last name and username among members of the specified chat. Requires administrator rights in broadcast channels: searchChatMembers

• Searches public chat by its username. Currently only private and channel chats can be public. Returns chat if found, otherwise some error is returned: searchPublicChat

• Searches public chats by prefix of their username. Currently only private and channel (including supergroup) chats can be public. Returns meaningful number of results. Returns nothing if length of the searched username prefix is less than 5. Excludes private chats with contacts from the results: searchPublicChats

• Searches sticker set by its short name: searchStickerSet

• Sends a message. Returns sent message: sendMessage

• Sends call debug information: debugCall

• Sends call rating: rateCall

• Sends callback query to a bot and returns answer to it. Returns error with code 502 if bot fails to answer the query before query timeout expires. Unavailable for bots: getCallbackQueryAnswer

• Sends filled payment form to the bot for the final verification: sendPaymentForm

• Sends inline query to a bot and returns its results. Returns error with code 502 if bot fails to answer the query before query timeout expires. Unavailable for bots: getInlineQueryResults

• Sends notification about screenshot taken in a chat. Works only in private and secret chats: sendChatScreenshotTakenNotification

• Sends notification about user activity in a chat: sendChatAction

• Sends result of the inline query as a message. Returns sent message. Always clears chat draft message: sendInlineQueryResultMessage

• Sets current network type. Can be called before authorization. Call to this method forces reopening of all network connections mitigating delay in switching between different networks, so it should be called whenever network is changed even network type remains the same. -Network type is used to check if library can use network at all and for collecting detailed network data usage statistics: setNetworkType

• Sets proxy server for network requests. Can be called before authorization: setProxy

• Sets user's phone number and sends authentication code to the user. Works only when getAuthState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode: setAuthPhoneNumber

• Sets value of an option. See list of available options on https: core.telegram.org/tdlib/options. Only writable options can be set. Can be called before authorization: setOption

• Stops file downloading. If file is already downloaded, does nothing: cancelDownloadFile

• Stops file uploading. Works only for files uploaded using uploadFile. For other files the behavior is undefined: cancelUploadFile

• Terminates all other sessions of logged in user: terminateAllOtherSessions

• Terminates another session of logged in user: terminateSession

• Test request. Does nothing, ensures that the Error object is used: testUseError

• Test request. Does nothing, ensures that the Update object is used: testUseUpdate

• Test request. Does nothing: testCallEmpty

• Test request. Forces updates.getDifference call to telegram servers: testGetDifference

• Test request. Returns back received bytes: testCallBytes

• Test request. Returns back received string: testCallString

• Test request. Returns back received vector of numbers: testCallVectorInt

• Test request. Returns back received vector of objects containing a number: testCallVectorIntObject

• Test request. Returns back received vector of objects containing a string: testCallVectorStringObject

• Test request. Returns back received vector of strings: testCallVectorString

• Test request. Returns squared received number: testSquareInt

• Test request. Sends simple network request to telegram servers: testNetwork

• Uploads new profile photo for logged in user. If something changes, updateUser will be sent: setProfilePhoto

• Validates order information provided by the user and returns available shipping options for flexible invoice: validateOrderInfo