53 KiB
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
-
Add an existing telegram user as contact: contacts.addContact
-
Add/remove sticker from recent stickers list: messages.saveRecentSticker
-
Adds a user to a chat and sends a service message on it.: messages.addChatUser
-
Answer an inline query, for bots only: messages.setInlineBotResults
-
Answers a custom query; for bots only: bots.answerWebhookJSONQuery
-
Associate a group to a channel as discussion group for that channel: channels.setDiscussionGroup
-
Associate a stickerset to the supergroup: channels.setStickers
-
Ban/unban/kick a user in a supergroup/channel.: channels.editBanned
-
Cancel the code that was sent to verify an email to use as 2FA recovery method.: account.cancelPasswordEmail
-
Chanages chat name and sends a service message on it.: messages.editChatTitle
-
Change media autodownload settings: account.saveAutoDownloadSettings
-
Change privacy settings of current account: account.setPrivacy
-
Change the phone number of the current account: account.changePhone
-
Change the photo of a channel/supergroup: channels.editPhoto
-
Change the username of a supergroup/channel: channels.updateUsername
-
Changes chat photo and sends a service message on it: messages.editChatPhoto
-
Changes username for the current user.: account.updateUsername
-
Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername
-
Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite
-
Confirm a phone number to cancel account deletion, for more info click here »: account.confirmPhone
-
Create a supergroup/channel.: channels.createChannel
-
Delete a channel/supergroup: channels.deleteChannel
-
Delete all messages sent by a certain user in a supergroup: channels.deleteUserHistory
-
Delete all temporary authorization keys except for the ones specified: auth.dropTempAuthKeys
-
Delete messages in a channel/supergroup: channels.deleteMessages
-
Delete stored Telegram Passport documents, for more info see the passport docs »: account.deleteSecureValue
-
Delete the history of a supergroup: channels.deleteHistory
-
Delete the user's account from the telegram servers. Can be used, for example, to delete the account of a user that provided the login code, but forgot the 2FA password and no recovery method is configured.: account.deleteAccount
-
Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice
-
Deletes a user from a chat and sends a service message on it.: messages.deleteChatUser
-
Deletes messages by their identifiers.: messages.deleteMessages
-
Deletes several contacts from the list.: contacts.deleteContacts
-
Edit the default banned rights of a channel/supergroup/group.: messages.editChatDefaultBannedRights
-
Edit the description of a group/supergroup/channel.: messages.editChatAbout
-
Edit the name of a channel/supergroup: channels.editTitle
-
Enable/disable top peers: contacts.toggleTopPeers
-
Enable/disable message signatures in channels: channels.toggleSignatures
-
Find out if a media message's caption can be edited: messages.getMessageEditData
-
Finish account takeout session: account.finishTakeoutSession
-
Get channel/supergroup messages: channels.getMessages
-
Get channels/supergroups/geogroups we're admin in. Usually called when the user exceeds the limit for owned public channels/supergroups/geogroups, and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels
-
Get instant view page: messages.getWebPage
-
Get a document by its SHA256 hash, mainly used for gifs: messages.getDocumentByHash
-
Get a list of channels/supergroups we left: channels.getLeftChannels
-
Get all chats, channels and supergroups: messages.getAllChats
-
Get all groups that can be used as discussion groups: channels.getGroupsForDiscussion
-
Get all saved Telegram Passport documents, for more info see the passport docs »: account.getAllSecureValues
-
Get and increase the view counter of a message sent or forwarded from a channel: messages.getMessagesViews
-
Get changed emoji keywords: messages.getEmojiKeywordsDifference
-
Get configuration for CDN file downloads.: help.getCdnConfig
-
Get dialogs manually marked as unread: messages.getDialogUnreadMarks
-
Get highscores of a game sent using an inline bot: messages.getInlineGameHighScores
-
Get info about channels/supergroups: channels.getChannels
-
Get info about a channel/supergroup participant: channels.getParticipant
-
Get info about an emoji keyword localization: messages.getEmojiKeywordsLanguages
-
Get information about a language in a localization pack: langpack.getLanguage
-
Get information about all languages in a localization pack: langpack.getLanguages
-
Get link and embed info of a message in a channel/supergroup: channels.exportMessageLink
-
Get live location history of a certain user: messages.getRecentLocations
-
Get localized name of the telegram support user: help.getSupportName
-
Get media autodownload settings: account.getAutoDownloadSettings
-
Get message ranges for saving the user's chat history: messages.getSplitRanges
-
Get more info about a Seamless Telegram Login authorization request, for more info click here »: messages.requestUrlAuth
-
Get phone call configuration to be passed to libtgvoip's shared config: phone.getCallConfig
-
Get promotion info of the currently-used MTProxy: help.getProxyData
-
Get saved Telegram Passport document, for more info see the passport docs »: account.getSecureValue
-
Get stickers attached to a photo or video: messages.getAttachedStickers
-
Get the admin log of a channel/supergroup: channels.getAdminLog
-
Get the number of results that would be found by a messages.search call with the same parameters: messages.getSearchCounters
-
Get unread messages where we were mentioned: messages.getUnreadMentions
-
Get web login widget authorizations: account.getWebAuthorizations
-
Gets back the conversation history with one interlocutor / within a chat: messages.getHistory
-
Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden
-
If the peer settings of a new user allow us to add him as contact, add that user as contact: contacts.acceptContact
-
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the bot will receive an updateBotShippingQuery update. Use this method to reply to shipping queries.: messages.setBotShippingResults
-
Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite
-
Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto
-
Intialize account takeout session: account.initTakeoutSession
-
Invite users to a channel/supergroup: channels.inviteToChannel
-
Invoke a request without subscribing the used connection for updates (this is enabled by default for file queries).: invokeWithoutUpdates
-
Invoke the specified query using the specified API layer: invokeWithLayer
-
Invoke with the given message range: invokeWithMessagesRange
-
Invokes a query after a successfull completion of previous queries: invokeAfterMsgs
-
Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg
-
Leave a channel/supergroup: channels.leaveChannel
-
Log out an active authorized session by its hash: account.resetAuthorization
-
Log out an active web telegram login session: account.resetWebAuthorization
-
Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate
-
Make a user admin in a legacy group.: messages.editChatAdmin
-
Mark channel/supergroup history as read: channels.readHistory
-
Mark channel/supergroup message contents as read: channels.readMessageContents
-
Mark new featured stickers as read: messages.readFeaturedStickers
-
Marks message history within a secret chat as read.: messages.readEncryptedHistory
-
Modify the admin rights of a user in a supergroup/channel.: channels.editAdmin
-
Notify the user that the sent passport data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change).
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.: users.setSecureValueErrors
-
Obtain configuration for two-factor authorization with password: account.getPassword
-
Once the user has confirmed their payment and shipping details, the bot receives an updateBotPrecheckoutQuery update.
Use this method to respond to such pre-checkout queries.
Note: Telegram must receive an answer within 10 seconds after the pre-checkout query was sent.: messages.setBotPrecheckoutResults -
Register device to receive PUSH notifications: account.registerDevice
-
Report a message in a chat for violation of telegram's Terms of Service: messages.report
-
Report a new incoming chat for spam, if the peer settings of the chat allow us to do that: messages.reportSpam
-
Report a peer for violation of telegram's Terms of Service: account.reportPeer
-
Request recovery code of a 2FA password, only for accounts with a recovery email configured.: auth.requestPasswordRecovery
-
Resend the code to verify an email to use as 2FA recovery method.: account.resendPasswordEmail
-
Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see login for more info.: auth.resendCode
-
Reset all active web telegram login sessions: account.resetWebAuthorizations
-
Reset the 2FA password using the recovery code sent using auth.requestPasswordRecovery.: auth.recoverPassword
-
Resets all notification settings from users and groups.: account.resetNotifySettings
-
Returns a list of available wallpapers.: account.getWallPapers
-
Returns basic user info according to their identifiers.: users.getUsers
-
Returns current configuration, icluding data center configuration.: help.getConfig
-
Returns info on data centre nearest to the user.: help.getNearestDc
-
Returns information on update availability for the current application.: help.getAppUpdate
-
Returns list of chats with non-default notification settings: account.getNotifyExceptions
-
Returns text of a text message with an invitation.: help.getInviteText
-
Returns the current user's contact list.: contacts.getContacts
-
Returns the list of messages by their IDs.: messages.getMessages
-
Returns the support user for the 'ask a question' feature.: help.getSupport
-
Save a message draft associated to a chat.: messages.saveDraft
-
Save get all message drafts.: messages.getAllDrafts
-
Search for messages and peers globally: messages.searchGlobal
-
Securely save Telegram Passport document, for more info see the passport docs »: account.saveSecureValue
-
Send a result obtained using messages.getInlineBotResults.: messages.sendInlineBotResult
-
Send confirmation code to cancel account deletion, for more info click here »: account.sendConfirmPhoneCode
-
Send the verification email code for telegram passport.: account.sendVerifyEmailCode
-
Send the verification phone code for telegram passport.: account.sendVerifyPhoneCode
-
Send typing event by the current user to a secret chat.: messages.setEncryptedTyping
-
Sends a current user typing event (see SendMessageAction for all event types) to a conversation partner or group.: messages.setTyping
-
Sends a custom request; for bots only: bots.sendCustomRequest
-
Sends a message with a file attachment to a secret chat: messages.sendEncryptedFile
-
Sends a service message to a secret chat.: messages.sendEncryptedService
-
Sends a text message to a secret chat.: messages.sendEncrypted
-
Set the callback answer to a user button press (bots only): messages.setBotCallbackAnswer
-
Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the peer's settings.: messages.hidePeerSettingsBar
-
Start a conversation with a bot using a deep linking parameter: messages.startBot
-
Submit requested order information for validation: payments.validateRequestedInfo
-
Terminates all user's authorized sessions except for the current one.
After calling this method it is necessary to reregister the current device using the method account.registerDevice: auth.resetAuthorizations
-
Toggle contact sign up notifications: account.setContactSignUpNotification
-
Turn a legacy group into a supergroup: messages.migrateChat
-
Updates current user profile photo.: photos.uploadProfilePhoto
-
Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile
-
Use this to accept a Seamless Telegram Login authorization request, for more info click here »: messages.acceptUrlAuth
-
Validates a username and checks availability.: account.checkUsername
-
Verify a new phone number to associate to the current account: account.sendChangePhoneCode
-
Verify a phone number for telegram passport.: account.verifyPhone
-
Verify an email address for telegram passport.: account.verifyEmail
-
Verify an email to use as 2FA recovery method.: account.confirmPasswordEmail
-
When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications.: account.updateDeviceLocked