36 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/remove sticker from recent stickers list: messages.saveRecentSticker
-
Adds a user to a chat and sends a service message on it.: messages.addChatUser
-
Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites
-
Answer an inline query, for bots only: messages.setInlineBotResults
-
Answers a custom query; for bots only: bots.answerWebhookJSONQuery
For more information, see Perfect Forward Secrecy.: auth.bindTempAuthKey
-
Cancels a request for creation and/or delete info on secret chat.: messages.discardEncryption
-
Chanages chat name and sends a service message on it.: messages.editChatTitle
-
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 if this phone number is registered on telegram: auth.checkPhone
-
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
-
Confirms creation of a secret chat: messages.acceptEncryption
-
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 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 about text of a channel/supergroup: channels.editAbout
-
Edit the name of a channel/supergroup: channels.editTitle
-
Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins
-
Enable/disable message signatures in channels: channels.toggleSignatures
-
Find out if a media message's caption can be edited: messages.getMessageEditData
-
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 all chats, channels and supergroups: messages.getAllChats
-
Get and increase the view counter of a message sent or forwarded from a channel: messages.getMessagesViews
-
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 link and embed info of a message in a channel/supergroup: channels.exportMessageLink
-
Get phone call configuration to be passed to libtgvoip's shared config: phone.getCallConfig
-
Get private info associated to the password info (recovery email, telegram passport info & so on): account.getPasswordSettings
-
Get stickers attached to a photo or video: messages.getAttachedStickers
-
Gets back the conversation history with one interlocutor / within a chat: messages.getHistory
-
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
-
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
-
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
-
Logs in a user using a key transmitted from his native data-centre.: auth.importAuthorization
-
Make a user admin in a legacy group.: messages.editChatAdmin
-
Mark channel/supergroup history as read: channels.readHistory
-
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
-
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
-
Registers a validated phone number in the system.: auth.signUp
-
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
-
Requests Diffie-hellman parameters for key exchange: req_DH_params
-
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 the 2FA password using the recovery code sent using auth.requestPasswordRecovery.: auth.recoverPassword
-
Resets all notification settings from users and groups.: account.resetNotifySettings
-
Resolve a @username to get peer info: contacts.resolveUsername
-
Returns a list of available wallpapers.: account.getWallPapers
-
Returns basic user info according to their identifiers.: users.getUsers
-
Returns content of a whole file or its part.: upload.getFile
-
Returns current configuration, icluding data center configuration.: help.getConfig
-
Returns data for copying authorization to another data-centre.: auth.exportAuthorization
-
Returns full chat info according to its ID.: messages.getFullChat
-
Returns info on data centre nearest to the user.: help.getNearestDc
-
Returns information on update availability for the current application.: help.getAppUpdate
-
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 developer info for telegram contest: contest.saveDeveloperInfo
-
Save get all message drafts.: messages.getAllDrafts
-
Saves a part of file for futher sending to one of the methods.: upload.saveFilePart
-
Search for messages and peers globally: messages.searchGlobal
-
Send a result obtained using messages.getInlineBotResults.: messages.sendInlineBotResult
-
Send confirmation code to cancel account deletion, for more info click here »: account.sendConfirmPhoneCode
-
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 request to start a secret chat to the user.: messages.requestEncryption
-
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
-
Set the pinned message of a channel/supergroup: channels.updatePinnedMessage
-
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
-
Try logging to an account protected by a 2FA password.: auth.checkPassword
-
Turn a legacy group into a supergroup: messages.migrateChat
-
Updates current user profile photo.: photos.uploadProfilePhoto
-
Validates a username and checks availability.: account.checkUsername
-
Verify a new phone number to associate to the current account: account.sendChangePhoneCode
-
When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications.: account.updateDeviceLocked
-
Complete phone call E2E encryption key exchange »: phone.confirmCall