Boolean type.
boolFalse#bc799737 = Bool;
boolTrue#997275b5 = Bool;
---functions---
auth.logOut#5717da40 = Bool;
auth.resetAuthorizations#9fab0d1a = Bool;
auth.bindTempAuthKey#cdd42a05 perm_auth_key_id:long nonce:long expires_at:int encrypted_message:bytes = Bool;
account.registerDevice#446c712c token_type:int token:string device_model:string system_version:string app_version:string app_sandbox:Bool lang_code:string = Bool;
account.unregisterDevice#65c55b40 token_type:int token:string = Bool;
account.updateNotifySettings#84be5b93 peer:InputNotifyPeer settings:InputPeerNotifySettings = Bool;
account.resetNotifySettings#db7e1747 = Bool;
account.updateStatus#6628562c offline:Bool = Bool;
account.reportPeer#ae189d5f peer:InputPeer reason:ReportReason = Bool;
contacts.deleteContacts#59ab389e id:Vector<InputUser> = Bool;
contacts.deleteByPhones#1013fd9e phones:Vector<string> = Bool;
contacts.block#332b49fc id:InputUser = Bool;
contacts.unblock#e54100bd id:InputUser = Bool;
messages.setTyping#719839e9 peer:InputPeer typing:Bool = Bool;
messages.reportSpam#cf1592db peer:InputPeer = Bool;
messages.hideReportSpam#a8f1709b peer:InputPeer = Bool;
messages.report#bd82b658 peer:InputPeer id:Vector<int> reason:ReportReason = Bool;
upload.saveFilePart#b304a621 file_id:long file_part:int bytes:bytes = Bool;
Constructor | Description |
---|---|
boolFalse | Constructor may be interpreted as a booleanfalse value. |
boolTrue | The constructor can be interpreted as a booleantrue value. |
Method | Description |
---|---|
auth.resetAuthorizations | Terminates all user's authorized sessions except for the current one. After calling this method it is necessary to reregister the current device using the method account.registerDevice |
auth.bindTempAuthKey | Binds a temporary authorization key temp_auth_key_id to the permanent authorization key perm_auth_key_id . Each permanent key may only be bound to one temporary key at a time, binding a new temporary key overwrites the previous one.For more information, see Perfect Forward Secrecy. |
account.registerDevice | Register device to receive PUSH notifications |
account.unregisterDevice | Deletes a device by its token, stops sending PUSH-notifications to it. |
account.updateNotifySettings | Edits notification settings from a given user/group, from all users/all groups. |
account.resetNotifySettings | Resets all notification settings from users and groups. |
account.updateStatus | Updates online user status. |
account.reportPeer | Report a peer for violation of telegram's Terms of Service |
contacts.deleteByPhones | Delete contacts by phone number |
contacts.block | Adds a peer to a blocklist, see here » for more info. |
contacts.unblock | Deletes a peer from a blocklist, see here » for more info. |
messages.setTyping | Sends a current user typing event (see SendMessageAction for all event types) to a conversation partner or group. |
messages.reportSpam | Report a new incoming chat for spam, if the peer settings of the chat allow us to do that |
messages.report | Report a message in a chat for violation of telegram's Terms of Service |
upload.saveFilePart | Saves a part of file for further sending to one of the methods. |
messages.discardEncryption | Cancels a request for creation and/or delete info on secret chat. |
messages.setEncryptedTyping | Send typing event by the current user to a secret chat. |
messages.readEncryptedHistory | Marks message history within a secret chat as read. |
messages.reportEncryptedSpam | Report a secret chat for spam |
upload.saveBigFilePart | Saves a part of a large file (over 10 MB in size) to be later passed to one of the methods. |
account.checkUsername | Validates a username and checks availability. |
account.deleteAccount | Delete the user's account from the telegram servers. Can also be used to delete the account of a user that provided the login code, but forgot the 2FA password and no recovery method is configured, see here » for more info on password recovery, and here » for more info on account deletion. |
account.setAccountTTL | Set account self-destruction period |
account.updateDeviceLocked | When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications. |
account.resetAuthorization | Log out an active authorized session by its hash |
account.updatePasswordSettings | Set a new 2FA password |
messages.uninstallStickerSet | Uninstall a stickerset |
channels.readHistory | Mark channel/supergroup history as read |
channels.reportSpam | Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup |
channels.checkUsername | Check if a username is free and can be assigned to a channel/supergroup |
channels.updateUsername | Change or remove the username of a supergroup/channel |
messages.editChatAdmin | Make a user admin in a basic group. |
messages.reorderStickerSets | Reorder installed stickersets |
messages.saveGif | Add GIF to saved gifs list |
messages.setInlineBotResults | Answer an inline query, for bots only |
auth.cancelCode | Cancel the login verification code |
messages.editInlineBotMessage | Edit an inline bot message |
messages.setBotCallbackAnswer | Set the callback answer to a user button press (bots only) |
contacts.resetTopPeerRating | Reset rating of top peer |
messages.saveDraft | Save a message draft associated to a chat. |
messages.readFeaturedStickers | Mark new featured stickers as read |
messages.saveRecentSticker | Add/remove sticker from recent stickers list |
messages.clearRecentStickers | Clear recent stickers |
account.confirmPhone | Confirm a phone number to cancel account deletion, for more info click here » |
auth.dropTempAuthKeys | Delete all temporary authorization keys except for the ones specified |
messages.setInlineGameScore | Use this method to set the score of the specified user in a game sent as an inline message (bots only). |
help.setBotUpdatesStatus | Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only |
messages.toggleDialogPin | Pin/unpin a dialog |
messages.reorderPinnedDialogs | Reorder pinned dialogs |
bots.answerWebhookJSONQuery | Answers a custom query; for bots only |
payments.clearSavedInfo | Clear saved payment information |
messages.setBotShippingResults | If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the bot will receive an updateBotShippingQuery update. Use this method to reply to shipping queries. |
messages.setBotPrecheckoutResults | Once the user has confirmed their payment and shipping details, the bot receives an updateBotPrecheckoutQuery update. Use this method to respond to such pre-checkout queries. Note: Telegram must receive an answer within 10 seconds after the pre-checkout query was sent. |
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.saveCallDebug | Send phone call debug data to server |
channels.setStickers | Associate a stickerset to the supergroup |
messages.faveSticker | Mark or unmark a sticker as favorite |
channels.readMessageContents | Mark channel/supergroup message contents as read |
contacts.resetSaved | Removes all contacts without an associated Telegram account. |
account.resetWebAuthorization | Log out an active web telegram login session |
account.resetWebAuthorizations | Reset all active web telegram login sessions |
help.acceptTermsOfService | Accept the new terms of service |
account.deleteSecureValue | Delete stored Telegram Passport documents, for more info see the passport docs » |
users.setSecureValueErrors | Notify the user that the sent passport data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change). Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. |
account.acceptAuthorization | Sends a Telegram Passport authorization form, effectively sharing data with the service |
account.verifyPhone | Verify a phone number for telegram passport. |
account.finishTakeoutSession | Terminate a takeout session, see here » for more info. |
messages.markDialogUnread | Manually mark dialog as unread |
contacts.toggleTopPeers | Enable/disable top peers |
messages.clearAllDrafts | Clear all drafts. |
help.saveAppLog | Saves logs of application on the server. |
account.confirmPasswordEmail | Verify an email to use as 2FA recovery method. |
account.resendPasswordEmail | Resend the code to verify an email to use as 2FA recovery method. |
account.cancelPasswordEmail | Cancel the code that was sent to verify an email to use as 2FA recovery method. |
account.getContactSignUpNotification | Whether the user will receive notifications when contacts sign up |
account.setContactSignUpNotification | Toggle contact sign up notifications |
messages.editChatAbout | Edit the description of a group/supergroup/channel. |
account.saveWallPaper | Install/uninstall wallpaper |
account.installWallPaper | Install wallpaper |
account.resetWallPapers | Delete all installed wallpapers, reverting to the default wallpaper set. |
account.saveAutoDownloadSettings | Change media autodownload settings |
channels.setDiscussionGroup | Associate a group to a channel as discussion group for that channel |
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 action bar ». |
channels.editLocation | Edit location of geogroup, see here » for more info on geogroups. |
account.saveTheme | Save a theme |
account.installTheme | Install a theme |
account.setContentSettings | Set sensitive content settings (for viewing or hiding NSFW content) |
messages.toggleStickerSets | Apply changes to multiple stickersets |
messages.updateDialogFilter | Update folder |
messages.updateDialogFiltersOrder | Reorder folders |
bots.setBotCommands | Set bot command list |
help.hidePromoData | Hide MTProxy/Public Service Announcement information |
phone.sendSignalingData | Send VoIP signaling data |
help.dismissSuggestion | Dismiss a suggestion, see here for more info ». |
messages.readDiscussion | Mark a thread as read |
messages.deleteChat | Delete a chat |
messages.startHistoryImport | Complete the history import process, importing all messages into the chat. To be called only after initializing the import with messages.initHistoryImport and uploading all files using messages.uploadImportedMedia. |
messages.deleteRevokedExportedChatInvites | Delete all revoked chat invites |
messages.deleteExportedChatInvite | Delete a chat invite |
account.reportProfilePhoto | Report a profile photo of a dialog |
phone.saveDefaultGroupCallJoinAs | Set the default peer that will be used to join a group call in a specific dialog. |
stickers.checkShortName | Check whether the given short name is available |
bots.resetBotCommands | Clear bot commands for the specified bot scope and language code |
account.declinePasswordReset | Abort a pending 2FA password reset, see here for more info » |
auth.checkRecoveryPassword | Check if the 2FA recovery code sent using auth.requestPasswordRecovery is valid, before passing it to auth.recoverPassword. |
channels.viewSponsoredMessage | Mark a specific sponsored message as read |
messages.saveDefaultSendAs | Change the default peer that should be used when sending messages, reactions, poll votes to a specific group |
account.setAuthorizationTTL | Set time-to-live of current session |
account.changeAuthorizationSettings | Change settings related to a session. |
messages.setDefaultReaction | Change default emoji reaction to use in the quick reaction menu: the value is synced across devices and can be fetched using help.getConfig, reactions_default field. |
messages.toggleBotInAttachMenu | Enable or disable web bot attachment menu » |
messages.prolongWebView | Indicate to the server (from the user side) that the user is still using a web app. If the method returns a QUERY_ID_INVALID error, the webview must be closed. |
bots.setBotMenuButton | Sets the menu button action » for a given user or for all users |
bots.setBotBroadcastDefaultAdminRights | Set the default suggested admin rights for bots being added as admins to channels, see here for more info on how to handle them ». |
bots.setBotGroupDefaultAdminRights | Set the default suggested admin rights for bots being added as admins to groups, see here for more info on how to handle them ». |
phone.saveCallLog | Save phone call debug information |
messages.rateTranscribedAudio | Rate transcribed voice message |
payments.canPurchasePremium | Checks whether Telegram Premium purchase is possible. Must be called before in-store Premium purchase, official apps only. |
account.updateEmojiStatus | Set an emoji status |
account.clearRecentEmojiStatuses | Clears list of recently used emoji statuses |
messages.reportReaction | Report a message reaction |
messages.clearRecentReactions | Clear recently used message reactions |
account.reorderUsernames | Reorder usernames associated with the currently logged-in user. |
account.toggleUsername | Activate or deactivate a purchased fragment.com username associated to the currently logged-in user. |
channels.reorderUsernames | Reorder active usernames |
channels.toggleUsername | Activate or deactivate a purchased fragment.com username associated to a supergroup or channel we own. |
channels.deactivateAllUsernames | Disable all purchased usernames of a supergroup or channel |
channels.reportAntiSpamFalsePositive | Report a native antispam false positive |
messages.setDefaultHistoryTTL | Changes the default value of the Time-To-Live setting, applied to all new chats. |
auth.requestFirebaseSms | Request an SMS code via Firebase. |
messages.togglePeerTranslations | Show or hide the real-time chat translation popup for a certain chat |
account.saveAutoSaveSettings | Modify autosave settings |
account.deleteAutoSaveExceptions | Clear all peer-specific autosave settings. |
stickers.deleteStickerSet | Deletes a stickerset we created. |
bots.setBotInfo | Set localized name, about text and description of a bot (or of the current account, if called by a bot). |
chatlists.deleteExportedInvite | Delete a previously created chat folder deep link ». |
chatlists.hideChatlistUpdates | Dismiss new pending peers recently added to a chat folder deep link ». |
bots.reorderUsernames | Reorder usernames associated to a bot we own. |
bots.toggleUsername | Activate or deactivate a purchased fragment.com username associated to a bot we own. |
account.invalidateSignInCodes | Invalidate the specified login codes, see here » for more info. |
channels.clickSponsoredMessage | Informs the server that the user has either: - Clicked on a link in the sponsored message - Has opened a sponsored chat or a sponsored website via the associated button - Has opened the sponsored chat via the sponsored message name, the sponsored message photo, or a mention in the sponsored message |
contacts.editCloseFriends | Edit the close friends list, see here » for more info. |
stories.canSendStory | Check whether we can post stories as the specified peer. |
stories.toggleAllStoriesHidden | Hide the active stories of a specific peer, preventing them from being displayed on the action bar on the homescreen. |
stories.incrementStoryViews | Increment the view counter of one or more stories. |
stories.report | Report a story. |
contacts.setBlocked | Replace the contents of an entire blocklist, see here for more info ». |
bots.canSendMessage | Check whether the specified bot can send us messages |
stories.togglePeerStoriesHidden | Hide the active stories of a user, preventing them from being displayed on the action bar on the homescreen, see here » for more info. |
account.updateColor | Update the accent color and background custom emoji » of the current account. |
messages.toggleSavedDialogPin | Pin or unpin a saved message dialog ». |
messages.reorderPinnedSavedDialogs | Reorder pinned saved message dialogs ». |
messages.updateSavedReactionTag | Update the description of a saved message tag ». |
channels.setEmojiStickers | Set a custom emoji stickerset for supergroups. Only usable after reaching at least the boost level » specified in the group_emoji_stickers_level_min » config parameter. |
smsjobs.join | Enable SMS jobs (official clients only). |
smsjobs.leave | Disable SMS jobs (official clients only). |
smsjobs.updateSettings | Update SMS job settings (official clients only). |
smsjobs.finishJob | Finish an SMS job (official clients only). |
account.updateBusinessWorkHours | Specify a set of Telegram Business opening hours. This info will be contained in userFull. business_work_hours .To remove all opening hours, invoke the method without setting the business_work_hours field.Note that the opening hours specified by the user must be appropriately validated and transformed before invoking the method, as specified here ». |
account.updateBusinessLocation | Businesses » may advertise their location using this method, see here » for more info. To remove business location information invoke the method without setting any of the parameters. |
account.updateBusinessGreetingMessage | Set a list of Telegram Business greeting messages. |
account.updateBusinessAwayMessage | Set a list of Telegram Business away messages. |
messages.reorderQuickReplies | Reorder quick reply shortcuts. This will emit an updateQuickReplies update to other logged-in sessions. |
messages.checkQuickReplyShortcut | Before offering the user the choice to add a message to a quick reply shortcut, to make sure that none of the limits specified here » were reached. |
messages.editQuickReplyShortcut | Rename a quick reply shortcut. This will emit an updateQuickReplies update to other logged-in sessions. |
messages.deleteQuickReplyShortcut | Completely delete a quick reply shortcut. This will also emit an updateDeleteQuickReply update to other logged-in sessions (and no updateDeleteQuickReplyMessages updates, even if all the messages in the shortcuts are also deleted by this method). |
messages.toggleDialogFilterTags | Enable or disable folder tags ». |
account.updateBusinessIntro | Set or remove the Telegram Business introduction ». |
account.toggleConnectedBotPaused | Pause or unpause a specific chat, temporarily disconnecting it from all business bots ». |
account.disablePeerConnectedBot | Permanently disconnect a specific chat from all business bots » (equivalent to specifying it in recipients.exclude_users during initial configuration with account.updateConnectedBot »); to reconnect of a chat disconnected using this method the user must reconnect the entire bot by invoking account.updateConnectedBot ». |
account.updateBirthday | Update our birthday, see here » for more info. |
account.deleteBusinessChatLink | Delete a business chat deep link ». |
account.updatePersonalChannel | Associate (or remove) a personal channel », that will be listed on our personal profile page ». Changing it will emit an updateUser update. |
account.toggleSponsoredMessages | Disable or re-enable Telegram ads for the current Premium account. Useful for business owners that may want to launch and view their own Telegram ads via the Telegram ad platform ». |
stories.togglePinnedToTop | Pin some stories to the top of the profile, see here » for more info. |
auth.reportMissingCode | Official apps only, reports that the SMS authentication code wasn't delivered. |
bots.deletePreviewMedia | Delete a main mini app preview, see here » for more info. Only owners of bots with a configured Main Mini App can use this method, see see here » for more info on how to check if you can invoke this method. |
bots.reorderPreviewMedias | Reorder a main mini app previews, see here » for more info. Only owners of bots with a configured Main Mini App can use this method, see see here » for more info on how to check if you can invoke this method. |