From 8df6b720699b22d634d4218e7bb29f4fdedd5176 Mon Sep 17 00:00:00 2001 From: Daniil Gentili Date: Fri, 27 Dec 2019 18:07:55 +0100 Subject: [PATCH] Fix docs --- docs/API_docs/methods/index.md | 174 +++++++++++------------ docs/index.md | 168 +++++++++++----------- old_docs/API_docs_v100/methods/README.md | 172 +++++++++++----------- old_docs/API_docs_v102/methods/README.md | 174 +++++++++++------------ old_docs/API_docs_v103/methods/README.md | 174 +++++++++++------------ old_docs/API_docs_v104/methods/README.md | 174 +++++++++++------------ old_docs/API_docs_v105/methods/README.md | 174 +++++++++++------------ old_docs/API_docs_v18/methods/README.md | 98 +++++++------ old_docs/API_docs_v23/methods/README.md | 102 +++++++------ old_docs/API_docs_v25/methods/README.md | 102 +++++++------ old_docs/API_docs_v27/methods/README.md | 106 +++++++------- old_docs/API_docs_v33/methods/README.md | 108 +++++++------- old_docs/API_docs_v38/methods/README.md | 112 +++++++-------- old_docs/API_docs_v40/methods/README.md | 108 +++++++------- old_docs/API_docs_v41/methods/README.md | 114 ++++++++------- old_docs/API_docs_v42/methods/README.md | 114 ++++++++------- old_docs/API_docs_v44/methods/README.md | 114 ++++++++------- old_docs/API_docs_v45/methods/README.md | 116 ++++++++------- old_docs/API_docs_v46/methods/README.md | 116 ++++++++------- old_docs/API_docs_v51/methods/README.md | 118 ++++++++------- old_docs/API_docs_v53/methods/README.md | 122 ++++++++-------- old_docs/API_docs_v55/methods/README.md | 122 ++++++++-------- old_docs/API_docs_v57/methods/README.md | 128 ++++++++--------- old_docs/API_docs_v62/methods/README.md | 130 +++++++++-------- old_docs/API_docs_v65/methods/README.md | 138 +++++++++--------- old_docs/API_docs_v66/methods/README.md | 140 +++++++++--------- old_docs/API_docs_v68/methods/README.md | 148 ++++++++++--------- old_docs/API_docs_v70/methods/README.md | 148 ++++++++++--------- old_docs/API_docs_v71/methods/README.md | 148 ++++++++++--------- old_docs/API_docs_v72/methods/README.md | 148 ++++++++++--------- old_docs/API_docs_v73/methods/README.md | 148 ++++++++++--------- old_docs/API_docs_v75/methods/README.md | 148 ++++++++++--------- old_docs/API_docs_v81/methods/README.md | 160 ++++++++++----------- old_docs/API_docs_v82/methods/README.md | 160 ++++++++++----------- old_docs/API_docs_v86/methods/README.md | 162 ++++++++++----------- old_docs/API_docs_v89/methods/README.md | 168 +++++++++++----------- old_docs/API_docs_v91/methods/README.md | 168 +++++++++++----------- old_docs/API_docs_v95/methods/README.md | 172 +++++++++++----------- old_docs/API_docs_v97/methods/README.md | 172 +++++++++++----------- 39 files changed, 2662 insertions(+), 2806 deletions(-) diff --git a/docs/API_docs/methods/index.md b/docs/API_docs/methods/index.md index ff794628..abf380cc 100644 --- a/docs/API_docs/methods/index.md +++ b/docs/API_docs/methods/index.md @@ -34,15 +34,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * 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 +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults @@ -52,13 +52,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change media autodownload settings: account.saveAutoDownloadSettings @@ -74,13 +74,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -88,17 +88,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet * Create a theme: account.createTheme * Create and upload a new wallpaper: account.uploadWallPaper -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -122,21 +122,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -146,13 +146,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit peers in folder: folders.editPeerFolders -* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights +* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights -* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout +* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers @@ -164,11 +164,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -202,7 +202,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -320,17 +320,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden * If the [peer settings](../constructors/peerSettings.md) 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](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -344,7 +344,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install/uninstall wallpaper: account.saveWallPaper -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -356,7 +356,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -364,7 +364,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -376,7 +376,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -390,27 +390,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -424,7 +420,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -440,67 +436,67 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers * Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save a theme: account.saveTheme -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -512,7 +508,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -524,15 +520,15 @@ Use this method to respond to such pre-checkout queries. * Send scheduled messages right away: messages.sendScheduledMessages -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -540,23 +536,21 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * 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](../constructors/peerSettings.md).: messages.hidePeerSettingsBar +* 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](../constructors/peerSettings.md): messages.hidePeerSettingsBar * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -570,11 +564,11 @@ After calling this method it is necessary to reregister the current device using * Update theme: account.updateTheme -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia @@ -582,25 +576,25 @@ After calling this method it is necessary to reregister the current device using * Upload theme: account.uploadTheme -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore * Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization): messages.acceptUrlAuth -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification diff --git a/docs/index.md b/docs/index.md index 19f40ed9..ac012237 100644 --- a/docs/index.md +++ b/docs/index.md @@ -184,19 +184,19 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) * Accept the new terms of service: help.acceptTermsOfService * Add GIF to saved gifs list: messages.saveGif - * Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet + * Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * 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 - * Adds the user to the blacklist.: contacts.block + * Adds a user to a chat and sends a service message on it: messages.addChatUser + * Adds the user to the blacklist: contacts.block * 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](https://telegram.org/blog/privacy-discussions-web-bots) for that channel: channels.setDiscussionGroup * Associate a stickerset to the supergroup: channels.setStickers - * Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned - * Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail + * Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned + * Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode - * Chanages chat name and sends a service message on it.: messages.editChatTitle + * 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 @@ -204,19 +204,19 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * Change the username of a supergroup/channel: channels.updateUsername * Changes chat photo and sends a service message on it: messages.editChatPhoto * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition - * Changes username for the current user.: account.updateUsername + * 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 - * Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts + * Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers * Clear saved payment information: payments.clearSavedInfo * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone - * Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages - * Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel - * Create a stickerset, bots only.: stickers.createStickerSet + * Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages + * Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel + * Create a stickerset, bots only: stickers.createStickerSet * Create a theme: account.createTheme * Create and upload a new wallpaper: account.uploadWallPaper - * Creates a new chat.: messages.createChat + * Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel * Delete a folder: folders.deleteFolder * Delete all messages sent by a certain user in a [supergroup](https://core.telegram.org/api/channel): channels.deleteUserHistory @@ -228,30 +228,30 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * Delete scheduled messages: messages.deleteScheduledMessages * Delete stored [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption): account.deleteSecureValue * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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 communication history.: messages.deleteHistory - * Deletes messages by their identifiers.: messages.deleteMessages - * Deletes profile photos.: photos.deletePhotos - * Deletes several contacts from the list.: contacts.deleteContacts - * Deletes the user from the blacklist.: contacts.unblock + * 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](https://core.telegram.org/api/srp): 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 communication history: messages.deleteHistory + * Deletes messages by their identifiers: messages.deleteMessages + * Deletes profile photos: photos.deletePhotos + * Deletes several contacts from the list: contacts.deleteContacts + * Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage * Edit location of geogroup: channels.editLocation * Edit message: messages.editMessage * Edit peers in folder: folders.editPeerFolders - * Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights - * Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout + * Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights + * Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle - * Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings + * Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers * Enable/disable message signatures in channels: channels.toggleSignatures * Export an invite link for a chat: messages.exportChatInvite * Find out if a media message's caption can be edited: messages.getMessageEditData * Finish account takeout session: account.finishTakeoutSession - * Forwards messages by their IDs.: messages.forwardMessages + * Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages - * Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels + * Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage * Get [passport](https://core.telegram.org/passport) configuration: help.getPassportConfig * Get a document by its SHA256 hash, mainly used for gifs: messages.getDocumentByHash @@ -268,7 +268,7 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * Get changed emoji keywords: messages.getEmojiKeywordsDifference * Get changelog of current app: help.getAppChangelog * Get chats in common with a user: messages.getCommonChats - * Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig + * Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs * Get contacts near you: contacts.getLocated * Get count of online users in a chat: messages.getOnlines @@ -327,57 +327,57 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * Get web [login widget](https://core.telegram.org/widgets/login) authorizations: account.getWebAuthorizations * Gets back found messages: messages.search * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory - * Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings + * Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden * If the [peer settings](../constructors/peerSettings.md) 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](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults + * If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite - * 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 + * 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet * Install a theme: account.installTheme * Install wallpaper: account.installWallPaper * Install/uninstall wallpaper: account.saveWallPaper - * Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto + * Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo * Internal use: help.getUserInfo * Intialize account takeout session: account.initTakeoutSession * Invite users to a channel/supergroup: channels.inviteToChannel * Invoke a method within a takeout session: invokeWithTakeout - * Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates + * Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 + * Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel * Leave a [channel/supergroup](https://core.telegram.org/api/channel): channels.leaveChannel * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization * Log out an active web [telegram login](https://core.telegram.org/widgets/login) session: account.resetWebAuthorization * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate - * Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin + * Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory * Mark [channel/supergroup](https://core.telegram.org/api/channel) message contents as read: channels.readMessageContents * Mark a sticker as favorite: messages.faveSticker * Mark mentions as read: messages.readMentions * Mark new featured stickers as read: messages.readFeaturedStickers - * Marks message history as read.: messages.readHistory - * Marks message history within a secret chat as read.: messages.readEncryptedHistory - * Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin - * Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents + * Marks message history as read: messages.readHistory + * Marks message history within a secret chat as read: messages.readEncryptedHistory + * Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin + * Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification - * Notify the user that the sent [passport](https://core.telegram.org/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). + * Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) update. - * Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall + * Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults + * Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage * Pin/unpin a dialog: messages.toggleDialogPin * Press an inline callback button and get a callback answer from the bot: messages.getBotCallbackAnswer * Query an inline bot: messages.getInlineBotResults * Rate a call: phone.setCallRating * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice - * Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet + * Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets * Reorder pinned dialogs: messages.reorderPinnedDialogs * Report a message in a chat for violation of telegram's Terms of Service: messages.report @@ -385,86 +385,86 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * Report a peer for violation of telegram's Terms of Service: account.reportPeer * Report a secret chat for spam: messages.reportEncryptedSpam * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam - * Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery - * Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode + * Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery + * Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations - * Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword - * Resets all notification settings from users and groups.: account.resetNotifySettings + * Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword + * Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm - * Returns a list of available wallpapers.: account.getWallPapers + * Returns a list of available wallpapers: account.getWallPapers * Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL - * Returns basic user info according to their identifiers.: users.getUsers - * Returns chat basic info on their IDs.: messages.getChats - * Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile - * 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 basic user info according to their identifiers: users.getUsers + * Returns chat basic info on their IDs: messages.getChats + * Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile + * 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 dialog list.: messages.getDialogs - * Returns the current user's contact list.: contacts.getContacts - * Returns the list of blocked users.: contacts.getBlocked - * Returns the list of contact statuses.: contacts.getStatuses - * Returns the list of messages by their IDs.: messages.getMessages - * Returns the list of user photos.: photos.getUserPhotos - * Returns the support user for the 'ask a question' feature.: help.getSupport - * Returns users found by username substring.: contacts.search - * Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft + * Returns text of a text message with an invitation: help.getInviteText + * Returns the current user dialog list: messages.getDialogs + * Returns the current user's contact list: contacts.getContacts + * Returns the list of blocked users: contacts.getBlocked + * Returns the list of contact statuses: contacts.getStatuses + * Returns the list of messages by their IDs: messages.getMessages + * Returns the list of user photos: photos.getUserPhotos + * Returns the support user for the 'ask a question' feature: help.getSupport + * Returns users found by username substring: contacts.search + * Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save a theme: account.saveTheme - * Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts - * Saves logs of application on the server.: help.saveAppLog + * Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts + * Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs * Search for messages and peers globally: messages.searchGlobal * Search for stickersets: messages.searchStickerSets * Securely save [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption): account.saveSecureValue * Send a media: messages.sendMedia - * Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult + * Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia * Send compiled payment form: payments.sendPaymentForm * Send confirmation code to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.sendConfirmPhoneCode * Send phone call debug data to server: phone.saveCallDebug * Send scheduled messages right away: messages.sendScheduledMessages - * Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode - * Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode - * Send typing event by the current user to a secret chat.: messages.setEncryptedTyping + * Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode + * Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode + * Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization - * Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping + * Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest * Sends a message to a chat: messages.sendMessage * 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 + * Sends a service message to a secret chat: messages.sendEncryptedService + * Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * 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](../constructors/peerSettings.md).: messages.hidePeerSettingsBar + * 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](../constructors/peerSettings.md): messages.hidePeerSettingsBar * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot * Submit requested order information for validation: payments.validateRequestedInfo - * Terminates all user's authorized sessions except for the current one. + * Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification * Toggle supergroup slow mode: if enabled, users will only be able to send one message every `seconds` seconds: channels.toggleSlowMode * Transfer channel ownership: channels.editCreator * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet * Update theme: account.updateTheme - * Updates current user profile photo.: photos.uploadProfilePhoto - * Updates online user status.: account.updateStatus - * Updates user profile.: account.updateProfile + * Updates current user profile photo: photos.uploadProfilePhoto + * Updates online user status: account.updateStatus + * Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile * Upload theme: account.uploadTheme - * Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore - * Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore + * Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore + * Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore * Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization): messages.acceptUrlAuth - * Validates a username and checks availability.: account.checkUsername + * 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](https://core.telegram.org/passport).: account.verifyPhone - * Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail - * Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail + * Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone + * Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail + * Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote - * When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked + * When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification * 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 * You cannot use this method directly, instead use $MadelineProto->getDhConfig();: messages.getDhConfig diff --git a/old_docs/API_docs_v100/methods/README.md b/old_docs/API_docs_v100/methods/README.md index dcc5b571..899410c3 100644 --- a/old_docs/API_docs_v100/methods/README.md +++ b/old_docs/API_docs_v100/methods/README.md @@ -34,13 +34,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults @@ -50,13 +50,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change media autodownload settings: account.saveAutoDownloadSettings @@ -72,13 +72,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -86,15 +86,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet * Create and upload a new wallpaper: account.uploadWallPaper -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -118,21 +118,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -140,13 +140,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit peers in folder: folders.editPeerFolders -* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights +* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights -* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout +* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers @@ -158,11 +158,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -198,7 +198,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -306,17 +306,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -328,7 +328,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install/uninstall wallpaper: account.saveWallPaper -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -340,7 +340,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -348,7 +348,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -360,7 +360,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -374,27 +374,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -408,7 +404,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -424,65 +420,65 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers * Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -494,7 +490,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -504,15 +500,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -520,9 +516,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -532,9 +528,7 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -542,35 +536,35 @@ After calling this method it is necessary to reregister the current device using * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore * Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization): messages.acceptUrlAuth -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification diff --git a/old_docs/API_docs_v102/methods/README.md b/old_docs/API_docs_v102/methods/README.md index b698192e..294f1102 100644 --- a/old_docs/API_docs_v102/methods/README.md +++ b/old_docs/API_docs_v102/methods/README.md @@ -34,15 +34,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * 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 +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults @@ -52,13 +52,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change media autodownload settings: account.saveAutoDownloadSettings @@ -74,13 +74,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -88,15 +88,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet * Create and upload a new wallpaper: account.uploadWallPaper -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -118,21 +118,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -142,13 +142,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit peers in folder: folders.editPeerFolders -* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights +* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights -* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout +* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers @@ -160,11 +160,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -198,7 +198,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -308,17 +308,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden * If the [peer settings](../constructors/peerSettings.md) 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](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -330,7 +330,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install/uninstall wallpaper: account.saveWallPaper -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -342,7 +342,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -350,7 +350,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -362,7 +362,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -376,27 +376,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -410,7 +406,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -426,65 +422,65 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers * Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -496,7 +492,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -506,15 +502,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -522,23 +518,21 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * 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](../constructors/peerSettings.md).: messages.hidePeerSettingsBar +* 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](../constructors/peerSettings.md): messages.hidePeerSettingsBar * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -548,35 +542,35 @@ After calling this method it is necessary to reregister the current device using * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore * Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization): messages.acceptUrlAuth -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification diff --git a/old_docs/API_docs_v103/methods/README.md b/old_docs/API_docs_v103/methods/README.md index b698192e..294f1102 100644 --- a/old_docs/API_docs_v103/methods/README.md +++ b/old_docs/API_docs_v103/methods/README.md @@ -34,15 +34,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * 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 +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults @@ -52,13 +52,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change media autodownload settings: account.saveAutoDownloadSettings @@ -74,13 +74,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -88,15 +88,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet * Create and upload a new wallpaper: account.uploadWallPaper -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -118,21 +118,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -142,13 +142,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit peers in folder: folders.editPeerFolders -* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights +* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights -* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout +* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers @@ -160,11 +160,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -198,7 +198,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -308,17 +308,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden * If the [peer settings](../constructors/peerSettings.md) 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](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -330,7 +330,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install/uninstall wallpaper: account.saveWallPaper -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -342,7 +342,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -350,7 +350,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -362,7 +362,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -376,27 +376,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -410,7 +406,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -426,65 +422,65 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers * Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -496,7 +492,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -506,15 +502,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -522,23 +518,21 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * 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](../constructors/peerSettings.md).: messages.hidePeerSettingsBar +* 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](../constructors/peerSettings.md): messages.hidePeerSettingsBar * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -548,35 +542,35 @@ After calling this method it is necessary to reregister the current device using * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore * Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization): messages.acceptUrlAuth -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification diff --git a/old_docs/API_docs_v104/methods/README.md b/old_docs/API_docs_v104/methods/README.md index 43686b7c..0690cd8a 100644 --- a/old_docs/API_docs_v104/methods/README.md +++ b/old_docs/API_docs_v104/methods/README.md @@ -34,15 +34,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * 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 +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults @@ -52,13 +52,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change media autodownload settings: account.saveAutoDownloadSettings @@ -74,13 +74,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -88,15 +88,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet * Create and upload a new wallpaper: account.uploadWallPaper -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -118,21 +118,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -142,13 +142,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit peers in folder: folders.editPeerFolders -* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights +* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights -* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout +* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers @@ -160,11 +160,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -198,7 +198,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -308,17 +308,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden * If the [peer settings](../constructors/peerSettings.md) 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](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -330,7 +330,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install/uninstall wallpaper: account.saveWallPaper -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -342,7 +342,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -350,7 +350,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -362,7 +362,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -376,27 +376,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -410,7 +406,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -426,65 +422,65 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers * Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -496,7 +492,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -506,15 +502,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -522,23 +518,21 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * 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](../constructors/peerSettings.md).: messages.hidePeerSettingsBar +* 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](../constructors/peerSettings.md): messages.hidePeerSettingsBar * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -550,35 +544,35 @@ After calling this method it is necessary to reregister the current device using * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore * Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization): messages.acceptUrlAuth -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification diff --git a/old_docs/API_docs_v105/methods/README.md b/old_docs/API_docs_v105/methods/README.md index 8e525987..d5d2a5df 100644 --- a/old_docs/API_docs_v105/methods/README.md +++ b/old_docs/API_docs_v105/methods/README.md @@ -34,15 +34,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * 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 +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults @@ -52,13 +52,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change media autodownload settings: account.saveAutoDownloadSettings @@ -74,13 +74,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -88,17 +88,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet * Create a theme: account.createTheme * Create and upload a new wallpaper: account.uploadWallPaper -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -122,21 +122,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -146,13 +146,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit peers in folder: folders.editPeerFolders -* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights +* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights -* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout +* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers @@ -164,11 +164,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -202,7 +202,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -320,17 +320,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden * If the [peer settings](../constructors/peerSettings.md) 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](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -344,7 +344,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install/uninstall wallpaper: account.saveWallPaper -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -356,7 +356,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -364,7 +364,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -376,7 +376,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -390,27 +390,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -424,7 +420,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -440,67 +436,67 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers * Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save a theme: account.saveTheme -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -512,7 +508,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -524,15 +520,15 @@ Use this method to respond to such pre-checkout queries. * Send scheduled messages right away: messages.sendScheduledMessages -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -540,23 +536,21 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * 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](../constructors/peerSettings.md).: messages.hidePeerSettingsBar +* 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](../constructors/peerSettings.md): messages.hidePeerSettingsBar * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -570,11 +564,11 @@ After calling this method it is necessary to reregister the current device using * Update theme: account.updateTheme -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia @@ -582,25 +576,25 @@ After calling this method it is necessary to reregister the current device using * Upload theme: account.uploadTheme -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore * Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization): messages.acceptUrlAuth -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification diff --git a/old_docs/API_docs_v18/methods/README.md b/old_docs/API_docs_v18/methods/README.md index 46e85461..899ac33a 100644 --- a/old_docs/API_docs_v18/methods/README.md +++ b/old_docs/API_docs_v18/methods/README.md @@ -30,45 +30,45 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if this phone number is registered on telegram: auth.checkPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a contact: contacts.deleteContact -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Export contact as card: contacts.exportCard * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get suggested contacts: contacts.getSuggested @@ -76,15 +76,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites @@ -92,51 +92,51 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice * Report a new incoming chat for spam, if the [peer settings](../constructors/peerSettings.md) of the chat allow us to do that: messages.reportSpam -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Send SMS verification code: auth.sendSms @@ -144,31 +144,29 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted -* Terminates all user's authorized sessions except for the current one. +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations -After calling this method it is necessary to reregister the current device using the method [account.registerDevice](../methods/account.registerDevice.md): auth.resetAuthorizations +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates online user status: account.updateStatus -* Updates online user status.: account.updateStatus +* Updates user profile: account.updateProfile -* Updates user profile.: account.updateProfile - -* Validates a username and checks availability.: account.checkUsername +* Validates a username and checks availability: account.checkUsername * 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 diff --git a/old_docs/API_docs_v23/methods/README.md b/old_docs/API_docs_v23/methods/README.md index 0396b733..0504cb1a 100644 --- a/old_docs/API_docs_v23/methods/README.md +++ b/old_docs/API_docs_v23/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -42,39 +42,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if this phone number is registered on telegram: auth.checkPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a contact: contacts.deleteContact -* 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Export contact as card: contacts.exportCard * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get all installed stickers: messages.getAllStickers @@ -90,15 +90,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites @@ -106,13 +106,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice @@ -120,39 +120,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Report a peer for violation of telegram's Terms of Service: account.reportPeer -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Send SMS verification code: auth.sendSms @@ -160,37 +160,35 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL -* Terminates all user's authorized sessions except for the current one. +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations -After calling this method it is necessary to reregister the current device using the method [account.registerDevice](../methods/account.registerDevice.md): auth.resetAuthorizations +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates online user status: account.updateStatus -* Updates online user status.: account.updateStatus +* Updates user profile: account.updateProfile -* Updates user profile.: account.updateProfile - -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v25/methods/README.md b/old_docs/API_docs_v25/methods/README.md index 8364cbf9..7739094a 100644 --- a/old_docs/API_docs_v25/methods/README.md +++ b/old_docs/API_docs_v25/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -42,45 +42,45 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if this phone number is registered on telegram: auth.checkPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages * Create geochat: geochats.createGeoChat -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a contact: contacts.deleteContact -* 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit geochat photo: geochats.editChatPhoto * Edit geochat title: geochats.editChatTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Export contact as card: contacts.exportCard * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get all installed stickers: messages.getAllStickers @@ -104,15 +104,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites @@ -120,53 +120,53 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a geochat: geochats.checkin -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search messages in geocha: geochats.search @@ -180,41 +180,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send message to geochat: geochats.sendMessage -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send typing notification to geochat: geochats.setTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set 2FA password: account.setPassword * Set account self-destruction period: account.setAccountTTL -* Terminates all user's authorized sessions except for the current one. +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations -After calling this method it is necessary to reregister the current device using the method [account.registerDevice](../methods/account.registerDevice.md): auth.resetAuthorizations +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates online user status: account.updateStatus -* Updates online user status.: account.updateStatus +* Updates user profile: account.updateProfile -* Updates user profile.: account.updateProfile - -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v27/methods/README.md b/old_docs/API_docs_v27/methods/README.md index 4d2d36eb..d3b2ba34 100644 --- a/old_docs/API_docs_v27/methods/README.md +++ b/old_docs/API_docs_v27/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -42,45 +42,45 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if this phone number is registered on telegram: auth.checkPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages * Create geochat: geochats.createGeoChat -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a contact: contacts.deleteContact -* 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit geochat photo: geochats.editChatPhoto * Edit geochat title: geochats.editChatTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Export contact as card: contacts.exportCard * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get all installed stickers: messages.getAllStickers @@ -108,15 +108,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites @@ -124,59 +124,59 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a geochat: geochats.checkin * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search messages in geocha: geochats.search @@ -190,39 +190,37 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send message to geochat: geochats.sendMessage -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send typing notification to geochat: geochats.setTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL -* Terminates all user's authorized sessions except for the current one. +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations -After calling this method it is necessary to reregister the current device using the method [account.registerDevice](../methods/account.registerDevice.md): auth.resetAuthorizations +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates online user status: account.updateStatus -* Updates online user status.: account.updateStatus +* Updates user profile: account.updateProfile -* Updates user profile.: account.updateProfile - -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v33/methods/README.md b/old_docs/API_docs_v33/methods/README.md index 7b6118d5..d52b9904 100644 --- a/old_docs/API_docs_v33/methods/README.md +++ b/old_docs/API_docs_v33/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -42,41 +42,41 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * 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 -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages * Create geochat: geochats.createGeoChat -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a contact: contacts.deleteContact -* 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit geochat photo: geochats.editChatPhoto * Edit geochat title: geochats.editChatTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Export an invite link for a chat: messages.exportChatInvite @@ -84,7 +84,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get all installed stickers: messages.getAllStickers @@ -116,81 +116,81 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a geochat: geochats.checkin * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search messages in geocha: geochats.search @@ -204,43 +204,41 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send message to geochat: geochats.sendMessage -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send typing notification to geochat: geochats.setTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v38/methods/README.md b/old_docs/API_docs_v38/methods/README.md index 12c5cdc9..223056b3 100644 --- a/old_docs/API_docs_v38/methods/README.md +++ b/old_docs/API_docs_v38/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -46,7 +46,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -54,11 +54,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -68,27 +68,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit the about text of a channel/supergroup: channels.editAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable channel comments: channels.toggleComments @@ -100,7 +100,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -138,31 +138,31 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -174,13 +174,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -190,43 +190,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Send SMS verification code: auth.sendSms @@ -234,41 +234,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v40/methods/README.md b/old_docs/API_docs_v40/methods/README.md index 39d0c0e9..aff1613e 100644 --- a/old_docs/API_docs_v40/methods/README.md +++ b/old_docs/API_docs_v40/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -42,39 +42,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * 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 -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages * Create channel: messages.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a contact: contacts.deleteContact * Delete channel messages: messages.deleteChannelMessages -* 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Export an invite link for a chat: messages.exportChatInvite @@ -82,7 +82,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get all installed stickers: messages.getAllStickers @@ -110,81 +110,81 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization * Mark channel/supergroup history as read: messages.readChannelHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Send SMS verification code: auth.sendSms @@ -192,41 +192,39 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v41/methods/README.md b/old_docs/API_docs_v41/methods/README.md index caebbce5..6578b162 100644 --- a/old_docs/API_docs_v41/methods/README.md +++ b/old_docs/API_docs_v41/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -46,7 +46,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -54,11 +54,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Deactivate chat: messages.deactivateChat @@ -70,27 +70,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit the about text of a channel/supergroup: channels.editAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -104,7 +104,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -142,31 +142,31 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -176,17 +176,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -196,43 +196,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for messages and peers globally: messages.searchGlobal @@ -242,43 +242,41 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v42/methods/README.md b/old_docs/API_docs_v42/methods/README.md index feeddd35..8a563ea8 100644 --- a/old_docs/API_docs_v42/methods/README.md +++ b/old_docs/API_docs_v42/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -46,7 +46,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -54,11 +54,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -68,27 +68,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit the about text of a channel/supergroup: channels.editAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -102,7 +102,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -140,31 +140,31 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -174,17 +174,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -194,43 +194,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for messages and peers globally: messages.searchGlobal @@ -240,43 +240,41 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v44/methods/README.md b/old_docs/API_docs_v44/methods/README.md index e455d0ca..8d001a08 100644 --- a/old_docs/API_docs_v44/methods/README.md +++ b/old_docs/API_docs_v44/methods/README.md @@ -30,11 +30,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -46,7 +46,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -54,11 +54,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -68,27 +68,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit the about text of a channel/supergroup: channels.editAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -102,7 +102,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -144,31 +144,31 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -178,17 +178,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -202,43 +202,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -250,43 +250,41 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v45/methods/README.md b/old_docs/API_docs_v45/methods/README.md index 06da5c88..55b2d956 100644 --- a/old_docs/API_docs_v45/methods/README.md +++ b/old_docs/API_docs_v45/methods/README.md @@ -32,13 +32,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -50,7 +50,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -58,11 +58,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -72,27 +72,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit the about text of a channel/supergroup: channels.editAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -106,7 +106,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -150,31 +150,31 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -184,17 +184,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -210,43 +210,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -258,45 +258,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v46/methods/README.md b/old_docs/API_docs_v46/methods/README.md index 06da5c88..55b2d956 100644 --- a/old_docs/API_docs_v46/methods/README.md +++ b/old_docs/API_docs_v46/methods/README.md @@ -32,13 +32,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -50,7 +50,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -58,11 +58,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -72,27 +72,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit the about text of a channel/supergroup: channels.editAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -106,7 +106,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -150,31 +150,31 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -184,17 +184,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -210,43 +210,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -258,45 +258,43 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Send verification phone call: auth.sendCall -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v51/methods/README.md b/old_docs/API_docs_v51/methods/README.md index d959601d..78d86a0d 100644 --- a/old_docs/API_docs_v51/methods/README.md +++ b/old_docs/API_docs_v51/methods/README.md @@ -32,9 +32,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -42,7 +42,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -54,7 +54,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -62,11 +62,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -76,21 +76,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -100,7 +100,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -118,7 +118,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -164,7 +164,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam @@ -172,25 +172,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -200,17 +200,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -228,45 +228,45 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -276,19 +276,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -298,25 +298,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v53/methods/README.md b/old_docs/API_docs_v53/methods/README.md index b8c2876b..b6375fd8 100644 --- a/old_docs/API_docs_v53/methods/README.md +++ b/old_docs/API_docs_v53/methods/README.md @@ -32,9 +32,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -42,7 +42,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -54,7 +54,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -62,11 +62,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -76,21 +76,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -100,7 +100,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -116,7 +116,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -162,7 +162,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam @@ -170,25 +170,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -198,17 +198,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -226,51 +226,51 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -280,19 +280,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -302,25 +302,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v55/methods/README.md b/old_docs/API_docs_v55/methods/README.md index c1ec380e..29c2e30a 100644 --- a/old_docs/API_docs_v55/methods/README.md +++ b/old_docs/API_docs_v55/methods/README.md @@ -34,9 +34,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -44,7 +44,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -56,7 +56,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -68,11 +68,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -82,21 +82,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -106,7 +106,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -122,7 +122,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages @@ -176,7 +176,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam @@ -184,25 +184,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -212,19 +212,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -242,51 +242,51 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -296,21 +296,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a message to all users in the chat list: messages.sendBroadcast -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send confirmation code to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.sendConfirmPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -320,25 +320,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v57/methods/README.md b/old_docs/API_docs_v57/methods/README.md index 2e1cf9c8..c2c18ca5 100644 --- a/old_docs/API_docs_v57/methods/README.md +++ b/old_docs/API_docs_v57/methods/README.md @@ -34,9 +34,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -44,7 +44,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -56,7 +56,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -68,11 +68,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -84,21 +84,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -108,7 +108,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -124,11 +124,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get a document by its SHA256 hash, mainly used for gifs: messages.getDocumentByHash @@ -184,7 +184,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam @@ -192,25 +192,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Import card as contact: contacts.importCard -* 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 +* 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 * Initialize connection: initConnection * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -220,19 +220,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword @@ -250,51 +250,51 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -302,21 +302,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send confirmation code to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.sendConfirmPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -326,29 +326,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v62/methods/README.md b/old_docs/API_docs_v62/methods/README.md index 7eb1274f..86b7097f 100644 --- a/old_docs/API_docs_v62/methods/README.md +++ b/old_docs/API_docs_v62/methods/README.md @@ -34,9 +34,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -44,7 +44,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -56,7 +56,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -68,11 +68,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -84,21 +84,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Destroy current authorization key: destroy_auth_key @@ -110,7 +110,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -126,11 +126,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -194,7 +194,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam @@ -202,7 +202,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -210,19 +210,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -232,23 +232,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Obtain configuration for two-factor authorization with password: account.getPassword -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -270,51 +270,51 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -322,21 +322,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send confirmation code to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.sendConfirmPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a message to a chat: messages.sendMessage * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -346,29 +346,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking): messages.startBot -* 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v65/methods/README.md b/old_docs/API_docs_v65/methods/README.md index d35e3dfd..7bd68c89 100644 --- a/old_docs/API_docs_v65/methods/README.md +++ b/old_docs/API_docs_v65/methods/README.md @@ -34,9 +34,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -46,7 +46,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -58,7 +58,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -72,11 +72,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -88,21 +88,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Destroy current authorization key: destroy_auth_key @@ -118,7 +118,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -134,11 +134,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -214,17 +214,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -232,19 +232,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -254,27 +254,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -302,59 +300,59 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery * Requests Diffie-hellman parameters for key exchange: req_DH_params * Requests PQ for factorization: req_pq -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save developer info for telegram contest: contest.saveDeveloperInfo -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -362,7 +360,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send compiled payment form: payments.sendPaymentForm @@ -370,9 +368,9 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -380,9 +378,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -396,29 +394,27 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v66/methods/README.md b/old_docs/API_docs_v66/methods/README.md index ccb6e154..d6850226 100644 --- a/old_docs/API_docs_v66/methods/README.md +++ b/old_docs/API_docs_v66/methods/README.md @@ -34,9 +34,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -46,7 +46,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -58,7 +58,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes chat photo and sends a service message on it: messages.editChatPhoto -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -72,11 +72,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -88,21 +88,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Destroy current authorization key: destroy_auth_key @@ -118,7 +118,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -134,11 +134,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -158,7 +158,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -216,17 +216,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -234,19 +234,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -256,27 +256,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -304,59 +302,59 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery * Requests Diffie-hellman parameters for key exchange: req_DH_params * Requests PQ for factorization: req_pq -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save developer info for telegram contest: contest.saveDeveloperInfo -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -364,7 +362,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send compiled payment form: payments.sendPaymentForm @@ -372,9 +370,9 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -382,9 +380,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -398,29 +396,27 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v68/methods/README.md b/old_docs/API_docs_v68/methods/README.md index bed67a90..e7f078ea 100644 --- a/old_docs/API_docs_v68/methods/README.md +++ b/old_docs/API_docs_v68/methods/README.md @@ -32,13 +32,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -46,11 +46,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Answers a custom query; for bots only: bots.answerWebhookJSONQuery -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -64,7 +64,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -78,13 +78,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -96,21 +96,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Destroy current authorization key: destroy_auth_key @@ -126,7 +126,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -142,11 +142,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -166,7 +166,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -234,17 +234,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -252,19 +252,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -272,27 +272,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -308,7 +306,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -322,59 +320,59 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery * Requests Diffie-hellman parameters for key exchange: req_DH_params * Requests PQ for factorization: req_pq -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save developer info for telegram contest: contest.saveDeveloperInfo -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -382,7 +380,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send compiled payment form: payments.sendPaymentForm @@ -390,9 +388,9 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -400,9 +398,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -416,31 +414,29 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v70/methods/README.md b/old_docs/API_docs_v70/methods/README.md index 727b905c..fc52edb1 100644 --- a/old_docs/API_docs_v70/methods/README.md +++ b/old_docs/API_docs_v70/methods/README.md @@ -32,13 +32,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -46,11 +46,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Answers a custom query; for bots only: bots.answerWebhookJSONQuery -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -64,7 +64,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -78,13 +78,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -96,21 +96,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Destroy current authorization key: destroy_auth_key @@ -126,7 +126,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -142,11 +142,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -166,7 +166,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -234,17 +234,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -252,19 +252,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -272,29 +272,27 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification * 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -310,7 +308,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -324,59 +322,59 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery * Requests Diffie-hellman parameters for key exchange: req_DH_params * Requests PQ for factorization: req_pq -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save developer info for telegram contest: contest.saveDeveloperInfo -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -384,7 +382,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send compiled payment form: payments.sendPaymentForm @@ -392,9 +390,9 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -402,9 +400,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -418,31 +416,29 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v71/methods/README.md b/old_docs/API_docs_v71/methods/README.md index bcccc038..787b5e1e 100644 --- a/old_docs/API_docs_v71/methods/README.md +++ b/old_docs/API_docs_v71/methods/README.md @@ -32,13 +32,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -48,11 +48,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -66,7 +66,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -80,13 +80,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -100,21 +100,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete saved contacts: contacts.resetSaved -* 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Destroy current authorization key: destroy_auth_key @@ -130,7 +130,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -146,11 +146,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -170,7 +170,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -242,17 +242,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -260,19 +260,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -280,7 +280,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory @@ -290,23 +290,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification * 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -322,7 +320,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -336,59 +334,59 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery * Requests Diffie-hellman parameters for key exchange: req_DH_params * Requests PQ for factorization: req_pq -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save developer info for telegram contest: contest.saveDeveloperInfo -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -396,7 +394,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send compiled payment form: payments.sendPaymentForm @@ -404,9 +402,9 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -414,9 +412,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -430,31 +428,29 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v72/methods/README.md b/old_docs/API_docs_v72/methods/README.md index 65e339e9..b712563a 100644 --- a/old_docs/API_docs_v72/methods/README.md +++ b/old_docs/API_docs_v72/methods/README.md @@ -32,13 +32,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -48,11 +48,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -66,7 +66,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -80,13 +80,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -102,21 +102,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Destroy current authorization key: destroy_auth_key @@ -132,7 +132,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -148,11 +148,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -172,7 +172,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -248,19 +248,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -268,19 +268,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -288,7 +288,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory @@ -300,23 +300,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification * 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -332,7 +330,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -346,59 +344,59 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery * Requests Diffie-hellman parameters for key exchange: req_DH_params * Requests PQ for factorization: req_pq -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft * Save developer info for telegram contest: contest.saveDeveloperInfo -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -406,7 +404,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send compiled payment form: payments.sendPaymentForm @@ -414,9 +412,9 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -424,9 +422,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -440,31 +438,29 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v73/methods/README.md b/old_docs/API_docs_v73/methods/README.md index 3682c08e..e6e179f3 100644 --- a/old_docs/API_docs_v73/methods/README.md +++ b/old_docs/API_docs_v73/methods/README.md @@ -32,13 +32,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -48,11 +48,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -66,7 +66,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -80,13 +80,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -102,21 +102,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -126,7 +126,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -142,11 +142,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Forward message: messages.forwardMessage -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -166,7 +166,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -240,19 +240,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -260,19 +260,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -280,7 +280,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash: account.resetAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory @@ -292,23 +292,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification * 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -320,7 +318,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -334,53 +332,53 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -388,7 +386,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -398,9 +396,9 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -408,9 +406,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -422,33 +420,31 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v75/methods/README.md b/old_docs/API_docs_v75/methods/README.md index a499a8ff..efda293e 100644 --- a/old_docs/API_docs_v75/methods/README.md +++ b/old_docs/API_docs_v75/methods/README.md @@ -32,13 +32,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -48,11 +48,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -66,7 +66,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -80,13 +80,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -102,21 +102,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -126,7 +126,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -140,11 +140,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Find out if a media message's caption can be edited: messages.getMessageEditData -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -164,7 +164,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -242,19 +242,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -262,19 +262,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Invite friends to telegram!: auth.sendInvites * Invite users to a channel/supergroup: channels.inviteToChannel -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): 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 +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -284,7 +284,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Log out an active web [telegram login](https://core.telegram.org/widgets/login) session: account.resetWebAuthorization -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory @@ -296,23 +296,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification * 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -324,7 +322,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -338,55 +336,55 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -394,7 +392,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -404,9 +402,9 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -414,9 +412,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -428,33 +426,31 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v81/methods/README.md b/old_docs/API_docs_v81/methods/README.md index f2d2e5eb..a95b7dbb 100644 --- a/old_docs/API_docs_v81/methods/README.md +++ b/old_docs/API_docs_v81/methods/README.md @@ -34,13 +34,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -50,11 +50,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -68,7 +68,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -80,13 +80,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -104,21 +104,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -128,7 +128,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -144,11 +144,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -174,7 +174,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -258,19 +258,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -278,7 +278,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Intialize account takeout session: account.initTakeoutSession @@ -286,7 +286,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -294,7 +294,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -306,7 +306,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read: channels.readHistory @@ -318,27 +318,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -350,7 +346,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -366,57 +362,57 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -428,7 +424,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -438,15 +434,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -454,9 +450,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -468,37 +464,35 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v82/methods/README.md b/old_docs/API_docs_v82/methods/README.md index 712c6ad6..de675abd 100644 --- a/old_docs/API_docs_v82/methods/README.md +++ b/old_docs/API_docs_v82/methods/README.md @@ -34,13 +34,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -50,11 +50,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -68,7 +68,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* Changes username for the current user: account.updateUsername * Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername @@ -80,13 +80,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -104,21 +104,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -128,7 +128,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -146,11 +146,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -176,7 +176,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -262,19 +262,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -282,7 +282,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Intialize account takeout session: account.initTakeoutSession @@ -290,7 +290,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -298,7 +298,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -310,7 +310,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -324,27 +324,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -356,7 +352,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -372,57 +368,57 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -434,7 +430,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -444,15 +440,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -460,9 +456,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -474,37 +470,35 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v86/methods/README.md b/old_docs/API_docs_v86/methods/README.md index 6a90a953..3b253bd1 100644 --- a/old_docs/API_docs_v86/methods/README.md +++ b/old_docs/API_docs_v86/methods/README.md @@ -34,13 +34,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -50,11 +50,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -68,13 +68,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -82,13 +82,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -106,21 +106,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -130,7 +130,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -148,11 +148,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -180,7 +180,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get days to live of account: account.getAccountTTL @@ -266,19 +266,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -286,7 +286,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Intialize account takeout session: account.initTakeoutSession @@ -294,7 +294,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -302,7 +302,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -314,7 +314,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -328,27 +328,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin/unpin a dialog: messages.toggleDialogPin @@ -360,7 +356,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -376,57 +372,57 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -438,7 +434,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -448,15 +444,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -464,9 +460,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -478,37 +474,35 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v89/methods/README.md b/old_docs/API_docs_v89/methods/README.md index b220fab5..6973c86d 100644 --- a/old_docs/API_docs_v89/methods/README.md +++ b/old_docs/API_docs_v89/methods/README.md @@ -34,13 +34,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -50,13 +50,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -70,13 +70,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -84,13 +84,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -108,21 +108,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -132,7 +132,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -150,11 +150,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -182,7 +182,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -274,19 +274,19 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite * Import card as contact: contacts.importCard -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -294,7 +294,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -306,7 +306,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -314,7 +314,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -326,7 +326,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -340,27 +340,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -374,7 +370,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -390,59 +386,59 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* Returns information on update availability for the current application: help.getAppUpdate -* Returns text of a text message with an invitation.: help.getInviteText +* Returns text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -454,7 +450,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -464,15 +460,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -480,9 +476,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -494,39 +490,37 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel): messages.migrateChat * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * 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 diff --git a/old_docs/API_docs_v91/methods/README.md b/old_docs/API_docs_v91/methods/README.md index cb710367..45072e01 100644 --- a/old_docs/API_docs_v91/methods/README.md +++ b/old_docs/API_docs_v91/methods/README.md @@ -34,13 +34,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites @@ -50,13 +50,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -70,13 +70,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -84,13 +84,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -110,21 +110,21 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage @@ -134,7 +134,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins @@ -150,11 +150,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -184,7 +184,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -280,17 +280,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -298,7 +298,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install a stickerset: messages.installStickerSet -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -310,7 +310,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -318,7 +318,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -330,7 +330,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -344,27 +344,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -378,7 +374,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -394,63 +390,63 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -462,7 +458,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -472,15 +468,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -488,9 +484,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -500,9 +496,7 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -510,33 +504,33 @@ After calling this method it is necessary to reregister the current device using * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification diff --git a/old_docs/API_docs_v95/methods/README.md b/old_docs/API_docs_v95/methods/README.md index b8881dab..00f6dab0 100644 --- a/old_docs/API_docs_v95/methods/README.md +++ b/old_docs/API_docs_v95/methods/README.md @@ -34,13 +34,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults @@ -48,13 +48,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change privacy settings of current account: account.setPrivacy @@ -68,13 +68,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -82,15 +82,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet * Create and upload a new wallpaper: account.uploadWallPaper -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -112,33 +112,33 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage * Edit message: messages.editMessage -* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights +* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights -* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout +* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers @@ -150,11 +150,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -184,7 +184,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -282,17 +282,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -304,7 +304,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install/uninstall wallpaper: account.saveWallPaper -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -316,7 +316,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -324,7 +324,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -336,7 +336,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -350,27 +350,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -384,7 +380,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -400,63 +396,63 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -468,7 +464,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -478,15 +474,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -494,9 +490,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -506,9 +502,7 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -516,33 +510,33 @@ After calling this method it is necessary to reregister the current device using * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification diff --git a/old_docs/API_docs_v97/methods/README.md b/old_docs/API_docs_v97/methods/README.md index 789d64e4..57b3417b 100644 --- a/old_docs/API_docs_v97/methods/README.md +++ b/old_docs/API_docs_v97/methods/README.md @@ -34,13 +34,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Add GIF to saved gifs list: messages.saveGif -* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot.: stickers.addStickerToSet +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet * Add/remove sticker from recent stickers list: messages.saveRecentSticker -* Adds a user to a chat and sends a service message on it.: messages.addChatUser +* Adds a user to a chat and sends a service message on it: messages.addChatUser -* Adds the user to the blacklist.: contacts.block +* Adds the user to the blacklist: contacts.block * Answer an inline query, for bots only: messages.setInlineBotResults @@ -48,13 +48,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Associate a stickerset to the supergroup: channels.setStickers -* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editBanned +* Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editBanned -* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.cancelPasswordEmail +* Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.cancelPasswordEmail * Cancel the login verification code: auth.cancelCode -* Chanages chat name and sends a service message on it.: messages.editChatTitle +* Chanages chat name and sends a service message on it: messages.editChatTitle * Change media autodownload settings: account.saveAutoDownloadSettings @@ -70,13 +70,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition -* Changes username for the current user.: account.updateUsername +* 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 -* Clear all [drafts](https://core.telegram.org/api/drafts).: messages.clearAllDrafts +* Clear all [drafts](https://core.telegram.org/api/drafts): messages.clearAllDrafts * Clear recent stickers: messages.clearRecentStickers @@ -84,15 +84,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion): account.confirmPhone -* Confirms receipt of messages by a client, cancels PUSH-notification sending.: messages.receivedMessages +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages -* Create a [supergroup/channel](https://core.telegram.org/api/channel).: channels.createChannel +* Create a [supergroup/channel](https://core.telegram.org/api/channel): channels.createChannel -* Create a stickerset, bots only.: stickers.createStickerSet +* Create a stickerset, bots only: stickers.createStickerSet * Create and upload a new wallpaper: account.uploadWallPaper -* Creates a new chat.: messages.createChat +* Creates a new chat: messages.createChat * Delete a [channel/supergroup](https://core.telegram.org/api/channel): channels.deleteChannel @@ -114,33 +114,33 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Delete the history of a [supergroup](https://core.telegram.org/api/channel): 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](https://core.telegram.org/api/srp).: 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](https://core.telegram.org/api/srp): account.deleteAccount -* Deletes a device by its token, stops sending PUSH-notifications to it.: account.unregisterDevice +* 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 a user from a chat and sends a service message on it: messages.deleteChatUser -* Deletes communication history.: messages.deleteHistory +* Deletes communication history: messages.deleteHistory -* Deletes messages by their identifiers.: messages.deleteMessages +* Deletes messages by their identifiers: messages.deleteMessages -* Deletes profile photos.: photos.deletePhotos +* Deletes profile photos: photos.deletePhotos -* Deletes several contacts from the list.: contacts.deleteContacts +* Deletes several contacts from the list: contacts.deleteContacts -* Deletes the user from the blacklist.: contacts.unblock +* Deletes the user from the blacklist: contacts.unblock * Edit an inline bot message: messages.editInlineBotMessage * Edit message: messages.editMessage -* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel).: messages.editChatDefaultBannedRights +* Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel): messages.editChatDefaultBannedRights -* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel).: messages.editChatAbout +* Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel): messages.editChatAbout * Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel): channels.editTitle -* Edits notification settings from a given user/group, from all users/all groups.: account.updateNotifySettings +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings * Enable/disable [top peers](https://core.telegram.org/api/top-rating): contacts.toggleTopPeers @@ -152,11 +152,11 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Finish account takeout session: account.finishTakeoutSession -* Forwards messages by their IDs.: messages.forwardMessages +* Forwards messages by their IDs: messages.forwardMessages * Get [channel/supergroup](https://core.telegram.org/api/channel) messages: channels.getMessages -* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups.: channels.getAdminedPublicChannels +* Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels * Get [instant view](https://instantview.telegram.org) page: messages.getWebPage @@ -188,7 +188,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get chats in common with a user: messages.getCommonChats -* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads.: help.getCdnConfig +* Get configuration for [CDN](https://core.telegram.org/cdn) file downloads: help.getCdnConfig * Get contact by telegram IDs: contacts.getContactIDs @@ -290,17 +290,17 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Gets back the conversation history with one interlocutor / within a chat: messages.getHistory -* Gets current notification settings for a given user/group, from all users/all groups.: account.getNotifySettings +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings * Hide report spam popup: messages.hideReportSpam * Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden -* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries.: messages.setBotShippingResults +* If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries: messages.setBotShippingResults * Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite -* 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 +* 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 * Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus @@ -312,7 +312,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Install/uninstall wallpaper: account.saveWallPaper -* Installs a previously uploaded photo as a profile photo.: photos.updateProfilePhoto +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto * Internal use: help.editUserInfo @@ -324,7 +324,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invoke a method within a takeout session: invokeWithTakeout -* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)).: invokeWithoutUpdates +* Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)): invokeWithoutUpdates * Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers): invokeWithLayer @@ -332,7 +332,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Invokes a query after a successfull completion of previous queries: invokeAfterMsgs -* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg * Join a channel/supergroup: channels.joinChannel @@ -344,7 +344,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate -* Make a user admin in a [legacy group](https://core.telegram.org/api/channel).: messages.editChatAdmin +* Make a user admin in a [legacy group](https://core.telegram.org/api/channel): messages.editChatAdmin * Manually mark dialog as unread: messages.markDialogUnread @@ -358,27 +358,23 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Mark new featured stickers as read: messages.readFeaturedStickers -* Marks message history as read.: messages.readHistory +* Marks message history as read: messages.readHistory -* Marks message history within a secret chat as read.: messages.readEncryptedHistory +* Marks message history within a secret chat as read: messages.readEncryptedHistory -* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel).: channels.editAdmin +* Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel): channels.editAdmin -* Notifies the sender about the recipient having listened a voice message or watched a video.: messages.readMessageContents +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents * Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification -* Notify the user that the sent [passport](https://core.telegram.org/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 +* Notify the user that the sent [passport](https://core.telegram.org/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): 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](../constructors/updateBotPrecheckoutQuery.md) 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 +* Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. : messages.setBotPrecheckoutResults -* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended.: phone.receivedCall +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall * Pin a message: messages.updatePinnedMessage @@ -392,7 +388,7 @@ Use this method to respond to such pre-checkout queries. * Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates): account.registerDevice -* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot.: stickers.removeStickerFromSet +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet * Reorder installed stickersets: messages.reorderStickerSets @@ -408,65 +404,65 @@ Use this method to respond to such pre-checkout queries. * Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam -* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification).: auth.requestPasswordRecovery +* Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification): auth.requestPasswordRecovery -* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.resendPasswordEmail +* Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): 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](https://core.telegram.org/api/auth) for more info.: auth.resendCode +* 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](https://core.telegram.org/api/auth) for more info: auth.resendCode * Reset [rating](https://core.telegram.org/api/top-rating) of top peer: contacts.resetTopPeerRating * Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions: account.resetWebAuthorizations -* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md).: auth.recoverPassword +* Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md): auth.recoverPassword -* Resets all notification settings from users and groups.: account.resetNotifySettings +* Resets all notification settings from users and groups: account.resetNotifySettings * Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL * Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm -* Returns a list of available wallpapers.: account.getWallPapers +* Returns a list of available wallpapers: account.getWallPapers * Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL -* Returns basic user info according to their identifiers.: users.getUsers +* Returns basic user info according to their identifiers: users.getUsers -* Returns chat basic info on their IDs.: messages.getChats +* Returns chat basic info on their IDs: messages.getChats -* Returns content of an HTTP file or a part, by proxying the request through telegram.: upload.getWebFile +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile -* Returns current configuration, icluding data center configuration.: help.getConfig +* Returns current configuration, icluding data center configuration: help.getConfig -* Returns info on data centre nearest to the user.: help.getNearestDc +* Returns info on data centre nearest to the user: help.getNearestDc -* Returns information on update availability for the current application.: help.getAppUpdate +* 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 text of a text message with an invitation: help.getInviteText -* Returns the current user dialog list.: messages.getDialogs +* Returns the current user dialog list: messages.getDialogs -* Returns the current user's contact list.: contacts.getContacts +* Returns the current user's contact list: contacts.getContacts -* Returns the list of blocked users.: contacts.getBlocked +* Returns the list of blocked users: contacts.getBlocked -* Returns the list of contact statuses.: contacts.getStatuses +* Returns the list of contact statuses: contacts.getStatuses -* Returns the list of messages by their IDs.: messages.getMessages +* Returns the list of messages by their IDs: messages.getMessages -* Returns the list of user photos.: photos.getUserPhotos +* Returns the list of user photos: photos.getUserPhotos -* Returns the support user for the 'ask a question' feature.: help.getSupport +* Returns the support user for the 'ask a question' feature: help.getSupport -* Returns users found by username substring.: contacts.search +* Returns users found by username substring: contacts.search -* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat.: messages.saveDraft +* Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat: messages.saveDraft -* Save get all message [drafts](https://core.telegram.org/api/drafts).: messages.getAllDrafts +* Save get all message [drafts](https://core.telegram.org/api/drafts): messages.getAllDrafts -* Saves logs of application on the server.: help.saveAppLog +* Saves logs of application on the server: help.saveAppLog * Search for GIFs: messages.searchGifs @@ -478,7 +474,7 @@ Use this method to respond to such pre-checkout queries. * Send a media: messages.sendMedia -* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md).: messages.sendInlineBotResult +* Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md): messages.sendInlineBotResult * Send an album of media: messages.sendMultiMedia @@ -488,15 +484,15 @@ Use this method to respond to such pre-checkout queries. * Send phone call debug data to server: phone.saveCallDebug -* Send the verification email code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyEmailCode +* Send the verification email code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyEmailCode -* Send the verification phone code for telegram [passport](https://core.telegram.org/passport).: account.sendVerifyPhoneCode +* Send the verification phone code for telegram [passport](https://core.telegram.org/passport): account.sendVerifyPhoneCode -* Send typing event by the current user to a secret chat.: messages.setEncryptedTyping +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping * Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization -* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group.: messages.setTyping +* Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group: messages.setTyping * Sends a custom request; for bots only: bots.sendCustomRequest @@ -504,9 +500,9 @@ Use this method to respond to such pre-checkout queries. * 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 service message to a secret chat: messages.sendEncryptedService -* Sends a text message to a secret chat.: messages.sendEncrypted +* Sends a text message to a secret chat: messages.sendEncrypted * Set account self-destruction period: account.setAccountTTL @@ -516,9 +512,7 @@ Use this method to respond to such pre-checkout queries. * 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](../methods/account.registerDevice.md): auth.resetAuthorizations +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations * Toggle contact sign up notifications: account.setContactSignUpNotification @@ -526,33 +520,33 @@ After calling this method it is necessary to reregister the current device using * Uninstall a stickerset: messages.uninstallStickerSet -* Updates current user profile photo.: photos.uploadProfilePhoto +* Updates current user profile photo: photos.uploadProfilePhoto -* Updates online user status.: account.updateStatus +* Updates online user status: account.updateStatus -* Updates user profile.: account.updateProfile +* Updates user profile: account.updateProfile * Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia * Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile -* Use this method to set the score of the specified user in a game sent as a normal message (bots only).: messages.setGameScore +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore -* Use this method to set the score of the specified user in a game sent as an inline message (bots only).: messages.setInlineGameScore +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore -* Validates a username and checks availability.: account.checkUsername +* 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](https://core.telegram.org/passport).: account.verifyPhone +* Verify a phone number for telegram [passport](https://core.telegram.org/passport): account.verifyPhone -* Verify an email address for telegram [passport](https://core.telegram.org/passport).: account.verifyEmail +* Verify an email address for telegram [passport](https://core.telegram.org/passport): account.verifyEmail -* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp).: account.confirmPasswordEmail +* Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp): account.confirmPasswordEmail * Vote in a [poll](../constructors/poll.md): messages.sendVote -* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates).: account.updateDeviceLocked +* When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates): account.updateDeviceLocked * Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification