MadelineProtoDocs/old_docs/API_docs_v23/methods/README.md

233 lines
17 KiB
Markdown
Raw Normal View History

2018-04-01 13:24:46 +02:00
---
title: Methods
description: What do you want to do?
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:24:46 +02:00
---
# What do you want to do?
[Go back to API documentation index](..)
[Go to the old code-version method index](api_README.md)
* [Logout](https://docs.madelineproto.xyz/logout.html)
* [Login](https://docs.madelineproto.xyz/docs/LOGIN.html)
2019-12-27 17:48:04 +01:00
* [Change 2FA password](https://docs.madelineproto.xyz/update2fa.html)
2019-06-05 12:04:07 +02:00
2018-04-01 13:24:46 +02:00
* [Get all chats, broadcast a message to all chats](https://docs.madelineproto.xyz/docs/DIALOGS.html)
2019-10-29 22:23:35 +01:00
* [Get the full participant list of a channel/group/supergroup](https://docs.madelineproto.xyz/getPwrChat.html)
2018-04-01 13:24:46 +02:00
2019-10-29 22:23:35 +01:00
* [Get full info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/getFullInfo.html)
2018-04-01 13:24:46 +02:00
2019-10-29 22:23:35 +01:00
* [Get info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/getInfo.html)
2018-04-01 13:24:46 +02:00
2019-10-29 22:23:35 +01:00
* [Get info about the currently logged-in user](https://docs.madelineproto.xyz/getSelf.html)
2018-04-01 13:24:46 +02:00
* [Upload or download files up to 1.5 GB](https://docs.madelineproto.xyz/docs/FILES.html)
* [Make a phone call and play a song](https://docs.madelineproto.xyz/docs/CALLS.html)
* [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html)
2019-12-27 18:07:55 +01:00
* <a href="messages.addChatUser.html" name="messages.addChatUser">Adds a user to a chat and sends a service message on it: messages.addChatUser</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="contacts.block.html" name="contacts.block">Adds the user to the blacklist: contacts.block</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.editChatTitle.html" name="messages.editChatTitle">Chanages chat name and sends a service message on it: messages.editChatTitle</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="account.setPrivacy.html" name="account.setPrivacy">Change privacy settings of current account: account.setPrivacy</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="account.changePhone.html" name="account.changePhone">Change the phone number of the current account: account.changePhone</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.editChatPhoto.html" name="messages.editChatPhoto">Changes chat photo and sends a service message on it: messages.editChatPhoto</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.updateUsername.html" name="account.updateUsername">Changes username for the current user: account.updateUsername</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="auth.checkPhone.html" name="auth.checkPhone">Check if this phone number is registered on telegram: auth.checkPhone</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.receivedMessages.html" name="messages.receivedMessages">Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.createChat.html" name="messages.createChat">Creates a new chat: messages.createChat</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="contacts.deleteContact.html" name="contacts.deleteContact">Delete a contact: contacts.deleteContact</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:17:55 +01:00
* <a href="account.deleteAccount.html" name="account.deleteAccount">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</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.unregisterDevice.html" name="account.unregisterDevice">Deletes a device by its token, stops sending PUSH-notifications to it: account.unregisterDevice</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.deleteChatUser.html" name="messages.deleteChatUser">Deletes a user from a chat and sends a service message on it: messages.deleteChatUser</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.deleteHistory.html" name="messages.deleteHistory">Deletes communication history: messages.deleteHistory</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.deleteMessages.html" name="messages.deleteMessages">Deletes messages by their identifiers: messages.deleteMessages</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="photos.deletePhotos.html" name="photos.deletePhotos">Deletes profile photos: photos.deletePhotos</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="contacts.deleteContacts.html" name="contacts.deleteContacts">Deletes several contacts from the list: contacts.deleteContacts</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="contacts.unblock.html" name="contacts.unblock">Deletes the user from the blacklist: contacts.unblock</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.updateNotifySettings.html" name="account.updateNotifySettings">Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="contacts.exportCard.html" name="contacts.exportCard">Export contact as card: contacts.exportCard</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.forwardMessage.html" name="messages.forwardMessage">Forward message: messages.forwardMessage</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.forwardMessages.html" name="messages.forwardMessages">Forwards messages by their IDs: messages.forwardMessages</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.getAllStickers.html" name="messages.getAllStickers">Get all installed stickers: messages.getAllStickers</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="account.getAccountTTL.html" name="account.getAccountTTL">Get days to live of account: account.getAccountTTL</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="account.getPrivacy.html" name="account.getPrivacy">Get privacy settings of current account: account.getPrivacy</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.getStickers.html" name="messages.getStickers">Get stickers by emoji: messages.getStickers</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="contacts.getSuggested.html" name="contacts.getSuggested">Get suggested contacts: contacts.getSuggested</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.search.html" name="messages.search">Gets back found messages: messages.search</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.getHistory.html" name="messages.getHistory">Gets back the conversation history with one interlocutor / within a chat: messages.getHistory</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.getNotifySettings.html" name="account.getNotifySettings">Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="contacts.importCard.html" name="contacts.importCard">Import card as contact: contacts.importCard</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="contacts.importContacts.html" name="contacts.importContacts">Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info: contacts.importContacts</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="initConnection.html" name="initConnection">Initialize connection: initConnection</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="photos.updateProfilePhoto.html" name="photos.updateProfilePhoto">Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="auth.sendInvites.html" name="auth.sendInvites">Invite friends to telegram!: auth.sendInvites</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:17:55 +01:00
* <a href="invokeWithLayer.html" name="invokeWithLayer">Invoke the specified query using the specified API layer: invokeWithLayer</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="invokeAfterMsgs.html" name="invokeAfterMsgs">Invokes a query after a successfull completion of previous queries: invokeAfterMsgs</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="invokeAfterMsg.html" name="invokeAfterMsg">Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.readHistory.html" name="messages.readHistory">Marks message history as read: messages.readHistory</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.readEncryptedHistory.html" name="messages.readEncryptedHistory">Marks message history within a secret chat as read: messages.readEncryptedHistory</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.readMessageContents.html" name="messages.readMessageContents">Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents</a>
2019-12-27 17:48:04 +01:00
2019-12-27 18:17:55 +01:00
* <a href="account.registerDevice.html" name="account.registerDevice">Register device to receive PUSH notifications: account.registerDevice</a>
2019-12-27 17:48:04 +01:00
2019-12-27 18:17:55 +01:00
* <a href="messages.reportSpam.html" name="messages.reportSpam">Report a new incoming chat for spam, if the peer settings of the chat allow us to do that: messages.reportSpam</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="account.reportPeer.html" name="account.reportPeer">Report a peer for violation of telegram's Terms of Service: account.reportPeer</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.resetNotifySettings.html" name="account.resetNotifySettings">Resets all notification settings from users and groups: account.resetNotifySettings</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.getWallPapers.html" name="account.getWallPapers">Returns a list of available wallpapers: account.getWallPapers</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="users.getUsers.html" name="users.getUsers">Returns basic user info according to their identifiers: users.getUsers</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.getChats.html" name="messages.getChats">Returns chat basic info on their IDs: messages.getChats</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="help.getConfig.html" name="help.getConfig">Returns current configuration, icluding data center configuration: help.getConfig</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="help.getNearestDc.html" name="help.getNearestDc">Returns info on data centre nearest to the user: help.getNearestDc</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="help.getAppUpdate.html" name="help.getAppUpdate">Returns information on update availability for the current application: help.getAppUpdate</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="help.getInviteText.html" name="help.getInviteText">Returns text of a text message with an invitation: help.getInviteText</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.getDialogs.html" name="messages.getDialogs">Returns the current user dialog list: messages.getDialogs</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="contacts.getContacts.html" name="contacts.getContacts">Returns the current user's contact list: contacts.getContacts</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="contacts.getBlocked.html" name="contacts.getBlocked">Returns the list of blocked users: contacts.getBlocked</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="contacts.getStatuses.html" name="contacts.getStatuses">Returns the list of contact statuses: contacts.getStatuses</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.getMessages.html" name="messages.getMessages">Returns the list of messages by their IDs: messages.getMessages</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="photos.getUserPhotos.html" name="photos.getUserPhotos">Returns the list of user photos: photos.getUserPhotos</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="help.getSupport.html" name="help.getSupport">Returns the support user for the 'ask a question' feature: help.getSupport</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="contacts.search.html" name="contacts.search">Returns users found by username substring: contacts.search</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="help.saveAppLog.html" name="help.saveAppLog">Saves logs of application on the server: help.saveAppLog</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="auth.sendSms.html" name="auth.sendSms">Send SMS verification code: auth.sendSms</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.sendMedia.html" name="messages.sendMedia">Send a media: messages.sendMedia</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.sendBroadcast.html" name="messages.sendBroadcast">Send a message to all users in the chat list: messages.sendBroadcast</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.setEncryptedTyping.html" name="messages.setEncryptedTyping">Send typing event by the current user to a secret chat: messages.setEncryptedTyping</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="auth.sendCall.html" name="auth.sendCall">Send verification phone call: auth.sendCall</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:17:55 +01:00
* <a href="messages.setTyping.html" name="messages.setTyping">Sends a current user typing event (see SendMessageAction for all event types) to a conversation partner or group: messages.setTyping</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.sendMessage.html" name="messages.sendMessage">Sends a message to a chat: messages.sendMessage</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="messages.sendEncryptedFile.html" name="messages.sendEncryptedFile">Sends a message with a file attachment to a secret chat: messages.sendEncryptedFile</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.sendEncryptedService.html" name="messages.sendEncryptedService">Sends a service message to a secret chat: messages.sendEncryptedService</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="messages.sendEncrypted.html" name="messages.sendEncrypted">Sends a text message to a secret chat: messages.sendEncrypted</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="account.setAccountTTL.html" name="account.setAccountTTL">Set account self-destruction period: account.setAccountTTL</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="auth.resetAuthorizations.html" name="auth.resetAuthorizations">Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="photos.uploadProfilePhoto.html" name="photos.uploadProfilePhoto">Updates current user profile photo: photos.uploadProfilePhoto</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.updateStatus.html" name="account.updateStatus">Updates online user status: account.updateStatus</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.updateProfile.html" name="account.updateProfile">Updates user profile: account.updateProfile</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:07:55 +01:00
* <a href="account.checkUsername.html" name="account.checkUsername">Validates a username and checks availability: account.checkUsername</a>
2019-09-04 01:13:06 +02:00
2019-12-27 17:48:04 +01:00
* <a href="account.sendChangePhoneCode.html" name="account.sendChangePhoneCode">Verify a new phone number to associate to the current account: account.sendChangePhoneCode</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:17:55 +01:00
* <a href="account.updateDeviceLocked.html" name="account.updateDeviceLocked">When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications: account.updateDeviceLocked</a>
2019-09-04 01:13:06 +02:00
2019-12-27 18:02:36 +01:00
* <a href="auth.bindTempAuthKey.html" name="auth.bindTempAuthKey">You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info: auth.bindTempAuthKey</a>
* <a href="messages.getDhConfig.html" name="messages.getDhConfig">You cannot use this method directly, instead use $MadelineProto->getDhConfig();: messages.getDhConfig</a>
* <a href="messages.acceptEncryption.html" name="messages.acceptEncryption">You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.acceptEncryption</a>
* <a href="messages.discardEncryption.html" name="messages.discardEncryption">You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.discardEncryption</a>
* <a href="messages.requestEncryption.html" name="messages.requestEncryption">You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.requestEncryption</a>
* <a href="updates.getDifference.html" name="updates.getDifference">You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates: updates.getDifference</a>
* <a href="updates.getState.html" name="updates.getState">You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates: updates.getState</a>
* <a href="auth.exportAuthorization.html" name="auth.exportAuthorization">You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.exportAuthorization</a>
* <a href="auth.importAuthorization.html" name="auth.importAuthorization">You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.importAuthorization</a>
* <a href="auth.signIn.html" name="auth.signIn">You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info): auth.signIn</a>
* <a href="auth.signUp.html" name="auth.signUp">You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info): auth.signUp</a>
* <a href="messages.getFullChat.html" name="messages.getFullChat">You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): messages.getFullChat</a>
* <a href="users.getFullUser.html" name="users.getFullUser">You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): users.getFullUser</a>
* <a href="auth.logOut.html" name="auth.logOut">You cannot use this method directly, use the logout method instead (see https://docs.madelineproto.xyz for more info): auth.logOut</a>
* <a href="auth.sendCode.html" name="auth.sendCode">You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info): auth.sendCode</a>
* <a href="contacts.resolveUsername.html" name="contacts.resolveUsername">You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): contacts.resolveUsername</a>
* <a href="upload.getFile.html" name="upload.getFile">You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.getFile</a>
* <a href="upload.saveBigFilePart.html" name="upload.saveBigFilePart">You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.saveBigFilePart</a>
* <a href="upload.saveFilePart.html" name="upload.saveFilePart">You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.saveFilePart</a>
* <a href="messages.receivedQueue.html" name="messages.receivedQueue">You cannot use this method directly: messages.receivedQueue</a>