Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsInitialize connection
Optionalopts: ApiCallOptionsInvokes a query after successful completion of one of the previous queries.
Optionalopts: ApiCallOptionsInvokes a query after a successful completion of previous queries
Optionalopts: ApiCallOptionsOfficial clients only, invoke with Apple push verification.
Optionalopts: ApiCallOptionsInvoke a method using a Telegram Business Bot connection, see here » for more info, including a list of the methods that can be wrapped in this constructor . Make sure to always send queries wrapped in a invokeWithBusinessConnection to the datacenter ID, specified in the dc_id field of the botBusinessConnection that is being used.
Optionalopts: ApiCallOptionsOfficial clients only, invoke with Google Play Integrity token.
Optionalopts: ApiCallOptionsInvoke the specified query using the specified API layer
Optionalopts: ApiCallOptionsInvoke with the given message range
Optionalopts: ApiCallOptionsInvoke a request without subscribing the used connection for updates (this is enabled by default for file queries ).
Optionalopts: ApiCallOptionsOfficial clients only: re-execute a method call that required reCAPTCHA verification via a RECAPTCHA_CHECK_%s__%s , where the first placeholder is the action , and the second one is the reCAPTCHA key ID.
Optionalopts: ApiCallOptionsInvoke a method within a takeout session, see here » for more info .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsSends a Telegram Passport authorization form, effectively sharing data with the service
Optionalopts: ApiCallOptionsCancel the code that was sent to verify an email to use as 2FA recovery method .
Optionalopts: ApiCallOptionsChange settings related to a session.
Optionalopts: ApiCallOptionsChange the phone number of the current account
Optionalopts: ApiCallOptionsValidates a username and checks availability.
Optionalopts: ApiCallOptionsClears list of recently used emoji statuses
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsVerify an email to use as 2FA recovery method .
Optionalopts: ApiCallOptionsConfirm a phone number to cancel account deletion, for more info click here »
Optionalopts: ApiCallOptionsCreate a business chat deep link » .
Optionalopts: ApiCallOptionsCreate a theme
Optionalopts: ApiCallOptionsAbort a pending 2FA password reset, see here for more info »
Optionalopts: ApiCallOptionsDelete 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.
Optionalopts: ApiCallOptionsClear all peer-specific autosave settings.
Optionalopts: ApiCallOptionsDelete a business chat deep link » .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsDelete stored Telegram Passport documents, for more info see the passport docs »
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsPermanently 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 » .
Optionalopts: ApiCallOptionsEdit a created business chat deep link » .
Optionalopts: ApiCallOptionsTerminate a takeout session, see here » for more info .
Optionalopts: ApiCallOptionsGet all saved Telegram Passport documents, for more info see the passport docs »
Optionalopts: ApiCallOptionsReturns a Telegram Passport authorization form for sharing data with a service
Optionalopts: ApiCallOptionsGet media autodownload settings
Optionalopts: ApiCallOptionsGet autosave settings
Optionalopts: ApiCallOptionsBots may invoke this method to re-fetch the updateBotBusinessConnect constructor associated with a specific business connection_id , see here » for more info on connected business bots. This is needed for example for freshly logged in bots that are receiving some updateBotNewBusinessMessage , etc. updates because some users have already connected to the bot before it could login. In this case, the bot is receiving messages from the business connection, but it hasn't cached the associated updateBotBusinessConnect with info about the connection (can it reply to messages? etc.) yet, and cannot receive the old ones because they were sent when the bot wasn't logged into the session yet. This method can be used to fetch info about a not-yet-cached business connection, and should not be invoked if the info is already cached or to fetch changes, as eventual changes will automatically be sent as new updateBotBusinessConnect updates to the bot using the usual update delivery methods » .
Optionalopts: ApiCallOptionsList all created business chat deep links » .
Optionalopts: ApiCallOptionsGet a list of default suggested channel emoji statuses .
Optionalopts: ApiCallOptionsReturns fetch the full list of custom emoji IDs » that cannot be used in channel emoji statuses » .
Optionalopts: ApiCallOptionsGet all available chat themes » .
Optionalopts: ApiCallOptionsObtain a list of emoji statuses » for owned collectible gifts .
Optionalopts: ApiCallOptionsList all currently connected business bots »
Optionalopts: ApiCallOptionsWhether the user will receive notifications when contacts sign up
Optionalopts: ApiCallOptionsGet sensitive content settings
Optionalopts: ApiCallOptionsGet a set of suggested custom emoji stickers that can be used in an accent color pattern .
Optionalopts: ApiCallOptionsGet a list of default suggested emoji statuses
Optionalopts: ApiCallOptionsGet a set of suggested custom emoji stickers that can be used as group picture
Optionalopts: ApiCallOptionsGet a set of suggested custom emoji stickers that can be used as profile picture
Optionalopts: ApiCallOptionsGet global privacy settings
Optionalopts: ApiCallOptionsGet info about multiple wallpapers
Optionalopts: ApiCallOptionsReturns list of chats with non-default notification settings
Optionalopts: ApiCallOptionsGets current notification settings for a given user/group, from all users/all groups.
Optionalopts: ApiCallOptionsGet the number of stars we have received from the specified user thanks to paid messages » ; the received amount will be equal to the sent amount multiplied by stars_paid_message_commission_permille divided by 1000.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsObtain configuration for two-factor authorization with password
Optionalopts: ApiCallOptionsGet private info associated to the password info (recovery email, telegram passport info & so on)
Optionalopts: ApiCallOptionsGet privacy settings of current account
Optionalopts: ApiCallOptionsGet the current reaction notification settings » .
Optionalopts: ApiCallOptionsGet recently used emoji statuses
Optionalopts: ApiCallOptionsFetch the full list of only the IDs of songs currently added to the profile, see here » for more info.
Optionalopts: ApiCallOptionsFetch saved notification sounds
Optionalopts: ApiCallOptionsGet saved Telegram Passport document, for more info see the passport docs »
Optionalopts: ApiCallOptionsGet theme information
Optionalopts: ApiCallOptionsGet installed themes
Optionalopts: ApiCallOptionsGet temporary payment password
Optionalopts: ApiCallOptionsObtain all chat themes » associated to owned collectible gifts » .
Optionalopts: ApiCallOptionsGet info about a certain wallpaper
Optionalopts: ApiCallOptionsReturns a list of available wallpapers .
Optionalopts: ApiCallOptionsGet web login widget authorizations
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsInitialize a takeout session, see here » for more info .
Optionalopts: ApiCallOptionsInstall a theme
Optionalopts: ApiCallOptionsInstall wallpaper
Optionalopts: ApiCallOptionsInvalidate the specified login codes, see here » for more info.
Optionalopts: ApiCallOptionsRegister device to receive PUSH notifications
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsReorder usernames associated with the currently logged-in user.
Optionalopts: ApiCallOptionsReport a peer for violation of telegram's Terms of Service
Optionalopts: ApiCallOptionsReport a profile photo of a dialog
Optionalopts: ApiCallOptionsResend the code to verify an email to use as 2FA recovery method .
Optionalopts: ApiCallOptionsLog out an active authorized session by its hash
Optionalopts: ApiCallOptionsResets all notification settings from users and groups.
Optionalopts: ApiCallOptionsInitiate a 2FA password reset: can only be used if the user is already logged-in, see here for more info »
Optionalopts: ApiCallOptionsDelete all installed wallpapers , reverting to the default wallpaper set.
Optionalopts: ApiCallOptionsLog out an active web telegram login session
Optionalopts: ApiCallOptionsReset all active web telegram login sessions
Optionalopts: ApiCallOptionsResolve a business chat deep link » .
Optionalopts: ApiCallOptionsChange media autodownload settings
Optionalopts: ApiCallOptionsModify autosave settings
Optionalopts: ApiCallOptionsAdds or removes a song from the current user's profile see here » for more info on the music tab of the profile page.
Optionalopts: ApiCallOptionsSave or remove saved notification sound. If the notification sound is already in MP3 format, account.savedRingtone will be returned. Otherwise, it will be automatically converted and a account.savedRingtoneConverted will be returned, containing a new document object that should be used to refer to the ringtone from now on (ie when deleting it using the unsave parameter, or when downloading it).
Optionalopts: ApiCallOptionsSecurely save Telegram Passport document, for more info see the passport docs »
Optionalopts: ApiCallOptionsSave a theme
Optionalopts: ApiCallOptionsInstall/uninstall wallpaper
Optionalopts: ApiCallOptionsVerify a new phone number to associate to the current account
Optionalopts: ApiCallOptionsSend confirmation code to cancel account deletion, for more info click here »
Optionalopts: ApiCallOptionsSend an email verification code.
Optionalopts: ApiCallOptionsSend the verification phone code for telegram passport .
Optionalopts: ApiCallOptionsSet account self-destruction period
Optionalopts: ApiCallOptionsSet time-to-live of current session
Optionalopts: ApiCallOptionsToggle contact sign up notifications
Optionalopts: ApiCallOptionsSet sensitive content settings (for viewing or hiding NSFW content)
Optionalopts: ApiCallOptionsSet global privacy settings
Optionalopts: ApiCallOptionsChanges the main profile tab of the current user, see here » for more info.
Optionalopts: ApiCallOptionsChange privacy settings of current account
Optionalopts: ApiCallOptionsChange the reaction notification settings » .
Optionalopts: ApiCallOptionsPause or unpause a specific chat, temporarily disconnecting it from all business bots » .
Optionalopts: ApiCallOptionsAllow a user to send us messages without paying if paid messages » are enabled.
Optionalopts: ApiCallOptionsDisable 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 » .
Optionalopts: ApiCallOptionsActivate or deactivate a purchased fragment.com username associated to the currently logged-in user.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsDeletes a device by its token, stops sending PUSH-notifications to it.
Optionalopts: ApiCallOptionsUpdate our birthday, see here » for more info.
Optionalopts: ApiCallOptionsSet a list of Telegram Business away messages .
Optionalopts: ApiCallOptionsSet a list of Telegram Business greeting messages .
Optionalopts: ApiCallOptionsSet or remove the Telegram Business introduction » .
Optionalopts: ApiCallOptionsBusinesses » 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.
Optionalopts: ApiCallOptionsSpecify 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 » .
Optionalopts: ApiCallOptionsUpdate the accent color and background custom emoji » of the current account.
Optionalopts: ApiCallOptionsConnect a business bot » to the current account, or to change the current connection settings.
Optionalopts: ApiCallOptionsWhen client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications .
Optionalopts: ApiCallOptionsSet an emoji status
Optionalopts: ApiCallOptionsEdits notification settings from a given user/group, from all users/all groups.
Optionalopts: ApiCallOptionsSet a new 2FA password
Optionalopts: ApiCallOptionsAssociate (or remove) a personal channel » , that will be listed on our personal profile page » . Changing it will emit an updateUser update.
Optionalopts: ApiCallOptionsUpdates user profile.
Optionalopts: ApiCallOptionsUpdates online user status.
Optionalopts: ApiCallOptionsUpdate theme
Optionalopts: ApiCallOptionsChanges username for the current user.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsUpload notification sound, use account.saveRingtone to convert it and add it to the list of saved notification sounds.
Optionalopts: ApiCallOptionsUpload theme
Optionalopts: ApiCallOptionsCreate and upload a new wallpaper
Optionalopts: ApiCallOptionsVerify an email address.
Optionalopts: ApiCallOptionsVerify a phone number for telegram passport .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsAccept QR code login token, logging in the app that generated it. Returns info about the new session. For more info, see login via QR code .
Optionalopts: ApiCallOptionsBinds 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 .
Optionalopts: ApiCallOptionsCancel the login verification code
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsTry logging to an account protected by a 2FA password .
Optionalopts: ApiCallOptionsCheck if the 2FA recovery code sent using auth.requestPasswordRecovery is valid, before passing it to auth.recoverPassword .
Optionalopts: ApiCallOptionsDelete all temporary authorization keys except for the ones specified
Optionalopts: ApiCallOptionsReturns data for copying authorization to another data-center.
Optionalopts: ApiCallOptionsGenerate a login token, for login via QR code . The generated login token should be encoded using base64url, then shown as a tg://login?token=base64encodedtoken deep link » in the QR code. For more info, see login via QR code .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsLogs in a user using a key transmitted from his native data-center.
Optionalopts: ApiCallOptionsLogin as a bot
Optionalopts: ApiCallOptionsLogin using a redirected login token, generated in case of DC mismatch during QR code login . For more info, see login via QR code .
Optionalopts: ApiCallOptionsLogin by importing an authorization token
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsReset the 2FA password using the recovery code sent using auth.requestPasswordRecovery .
Optionalopts: ApiCallOptionsOfficial apps only, reports that the SMS authentication code wasn't delivered.
Optionalopts: ApiCallOptionsRequest an SMS code via Firebase.
Optionalopts: ApiCallOptionsRequest recovery code of a 2FA password , only for accounts with a recovery email configured .
Optionalopts: ApiCallOptionsResend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see login for more info.
Optionalopts: ApiCallOptionsTerminates 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
Optionalopts: ApiCallOptionsReset the login email » .
Optionalopts: ApiCallOptionsSend the verification code for login
Optionalopts: ApiCallOptionsSigns in a user with a validated phone number.
Optionalopts: ApiCallOptionsRegisters a validated phone number in the system.
Optionalopts: ApiCallOptionsAdd 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.
Optionalopts: ApiCallOptionsAllow the specified bot to send us messages
Optionalopts: ApiCallOptionsAnswers a custom query; for bots only
Optionalopts: ApiCallOptionsCheck whether the specified bot can send us messages
Optionalopts: ApiCallOptionsCheck if a mini app can request the download of a specific file: called when handling web_app_request_file_download events »
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsDelete 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.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsEdit 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.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsGet a list of bots owned by the current user
Optionalopts: ApiCallOptionsObtain a list of bot commands for the specified bot scope and language code
Optionalopts: ApiCallOptionsGet localized name, about text and description of a bot (or of the current account, if called by a bot).
Optionalopts: ApiCallOptionsGets the menu button action for a given user or for all users, previously set using bots.setBotMenuButton ; users can see this information in the botInfo constructor.
Optionalopts: ApiCallOptionsObtain a list of similarly themed bots, selected based on similarities in their subscriber bases, see here » for more info.
Optionalopts: ApiCallOptionsFetch popular Main Mini Apps , to be used in the apps tab of global search » .
Optionalopts: ApiCallOptionsBot owners only, fetch main mini app preview information, see here » for more info. Note: technically non-owners may also invoke this method, but it will always behave exactly as bots.getPreviewMedias , returning only previews for the current language and an empty lang_codes array, regardless of the passed lang_code , so please only use bots.getPreviewMedias if you're not the owner of the bot .
Optionalopts: ApiCallOptionsFetch main mini app previews, see here » for more info.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsSend a custom request from a mini bot app , triggered by a web_app_invoke_custom_method event » . The response should be sent using a custom_method_invoked event, see here » for more info on the flow.
Optionalopts: ApiCallOptionsReorder 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.
Optionalopts: ApiCallOptionsReorder usernames associated to a bot we own.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsClear bot commands for the specified bot scope and language code
Optionalopts: ApiCallOptionsSends a custom request; for bots only
Optionalopts: ApiCallOptionsSet the default suggested admin rights for bots being added as admins to channels, see here for more info on how to handle them » .
Optionalopts: ApiCallOptionsSet bot command list
Optionalopts: ApiCallOptionsSet the default suggested admin rights for bots being added as admins to groups, see here for more info on how to handle them » .
Optionalopts: ApiCallOptionsSet localized name, about text and description of a bot (or of the current account, if called by a bot).
Optionalopts: ApiCallOptionsSets the menu button action » for a given user or for all users
Optionalopts: ApiCallOptionsVerify a user or chat on behalf of an organization » .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsAllow or prevent a bot from changing our emoji status »
Optionalopts: ApiCallOptionsActivate or deactivate a purchased fragment.com username associated to a bot we own.
Optionalopts: ApiCallOptionsCreate, edit or delete the affiliate program of a bot we own
Optionalopts: ApiCallOptionsChange the emoji status of a user (invoked by bots, see here » for more info on the full flow)
Optionalopts: ApiCallOptionsCheck if the specified global post search » requires payment.
Optionalopts: ApiCallOptionsCheck if a username is free and can be assigned to a channel/supergroup
Optionalopts: ApiCallOptionsConvert a supergroup to a gigagroup , when requested by channel suggestions .
Optionalopts: ApiCallOptionsCreate a supergroup/channel .
Optionalopts: ApiCallOptionsDisable all purchased usernames of a supergroup or channel
Optionalopts: ApiCallOptionsDelete a channel/supergroup
Optionalopts: ApiCallOptionsDelete the history of a supergroup
Optionalopts: ApiCallOptionsDelete messages in a channel/supergroup
Optionalopts: ApiCallOptionsDelete all messages sent by a specific participant of a given supergroup
Optionalopts: ApiCallOptionsModify the admin rights of a user in a supergroup/channel .
Optionalopts: ApiCallOptionsBan/unban/kick a user in a supergroup/channel .
Optionalopts: ApiCallOptionsEdit location of geogroup, see here » for more info on geogroups.
Optionalopts: ApiCallOptionsChange the photo of a channel/supergroup
Optionalopts: ApiCallOptionsEdit the name of a channel/supergroup
Optionalopts: ApiCallOptionsGet link and embed info of a message in a channel/supergroup
Optionalopts: ApiCallOptionsGet channels/supergroups/geogroups we're admin in. Usually called when the user exceeds the limit for owned public channels/supergroups/geogroups , and the user is given the choice to remove one of his channels/supergroups/geogroups.
Optionalopts: ApiCallOptionsGet the admin log of a channel/supergroup
Optionalopts: ApiCallOptionsObtain a list of similarly themed public channels, selected based on similarities in their subscriber bases .
Optionalopts: ApiCallOptionsGet info about channels/supergroups
Optionalopts: ApiCallOptionsGet full info about a supergroup , gigagroup or channel
Optionalopts: ApiCallOptionsGet all groups that can be used as discussion groups . Returned basic group chats must be first upgraded to supergroups before they can be set as a discussion group. To set a returned supergroup as a discussion group, access to its old messages must be enabled using channels.togglePreHistoryHidden , first.
Optionalopts: ApiCallOptionsGet inactive channels and supergroups
Optionalopts: ApiCallOptionsGet a list of channels/supergroups we left, requires a takeout session, see here » for more info .
Optionalopts: ApiCallOptionsCan only be invoked by non-bot admins of a monoforum » , obtains the original sender of a message sent by other monoforum admins to the monoforum, on behalf of the channel associated to the monoforum.
Optionalopts: ApiCallOptionsGet channel/supergroup messages
Optionalopts: ApiCallOptionsGet info about a channel/supergroup participant
Optionalopts: ApiCallOptionsGet the participants of a supergroup/channel
Optionalopts: ApiCallOptionsObtains a list of peers that can be used to send messages in a specific group
Optionalopts: ApiCallOptionsInvite users to a channel/supergroup
Optionalopts: ApiCallOptionsJoin a channel/supergroup
Optionalopts: ApiCallOptionsLeave a channel/supergroup
Optionalopts: ApiCallOptionsMark channel/supergroup history as read
Optionalopts: ApiCallOptionsMark channel/supergroup message contents as read, emitting an updateChannelReadMessagesContents .
Optionalopts: ApiCallOptionsReorder active usernames
Optionalopts: ApiCallOptionsReport a native antispam false positive
Optionalopts: ApiCallOptionsReports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup
Optionalopts: ApiCallOptionsDisable ads on the specified channel, for all users. Available only after reaching at least the boost level » specified in the channel_restrict_sponsored_level_min » config parameter.
Optionalopts: ApiCallOptionsGlobally search for posts from public channels » ( including those we aren't a member of) containing either a specific hashtag, or a full text query. Exactly one of query and hashtag must be set.
Optionalopts: ApiCallOptionsAdmins with ban_users admin rights » may allow users that apply a certain number of booosts » to the group to bypass slow mode » and other » supergroup restrictions, see here » for more info.
Optionalopts: ApiCallOptionsAssociate a group to a channel as discussion group for that channel
Optionalopts: ApiCallOptionsSet 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.
Optionalopts: ApiCallOptionsChanges the main profile tab of a channel, see here » for more info.
Optionalopts: ApiCallOptionsAssociate a stickerset to the supergroup
Optionalopts: ApiCallOptionsEnable or disable the native antispam system .
Optionalopts: ApiCallOptionsToggle autotranslation in a channel, for all users: see here » for more info.
Optionalopts: ApiCallOptionsEnable or disable forum functionality in a supergroup.
Optionalopts: ApiCallOptionsSet whether all users should request admin approval to join the group » .
Optionalopts: ApiCallOptionsSet whether all users should join a discussion group in order to comment on a post »
Optionalopts: ApiCallOptionsHide or display the participants list in a supergroup . The supergroup must have at least hidden_members_group_size_min participants in order to use this method, as specified by the client configuration parameters » .
Optionalopts: ApiCallOptionsHide/unhide message history for new channel/supergroup users
Optionalopts: ApiCallOptionsEnable/disable message signatures in channels
Optionalopts: ApiCallOptionsToggle supergroup slow mode: if enabled, users will only be able to send one message every seconds seconds
Optionalopts: ApiCallOptionsActivate or deactivate a purchased fragment.com username associated to a supergroup or channel we own.
Optionalopts: ApiCallOptionsUsers may also choose to display messages from all topics of a forum as if they were sent to a normal group, using a "View as messages" setting in the local client: this setting only affects the current account, and is synced to other logged in sessions using this method. Invoking this method will update the value of the view_forum_as_messages flag of channelFull or dialog and emit an updateChannelViewForumAsMessages .
Optionalopts: ApiCallOptionsUpdate the accent color and background custom emoji » of a channel.
Optionalopts: ApiCallOptionsSet an emoji status for a channel or supergroup.
Optionalopts: ApiCallOptionsEnable or disable paid messages » in this supergroup or monoforum . Also used to enable or disable monoforums aka direct messages in a channel . Note that passing the ID of the monoforum itself to channel will return a CHANNEL_MONOFORUM_UNSUPPORTED error: pass the ID of the associated channel to edit the settings of the associated monoforum, instead.
Optionalopts: ApiCallOptionsChange or remove the username of a supergroup/channel
Optionalopts: ApiCallOptionsObtain information about a chat folder deep link » .
Optionalopts: ApiCallOptionsDelete a previously created chat folder deep link » .
Optionalopts: ApiCallOptionsEdit a chat folder deep link » .
Optionalopts: ApiCallOptionsExport a folder » , creating a chat folder deep link » .
Optionalopts: ApiCallOptionsFetch new chats associated with an imported chat folder deep link » . Must be invoked at most every chatlist_update_period seconds (as per the related client configuration parameter » ).
Optionalopts: ApiCallOptionsList all chat folder deep links » associated to a folder
Optionalopts: ApiCallOptionsReturns identifiers of pinned or always included chats from a chat folder imported using a chat folder deep link » , which are suggested to be left when the chat folder is deleted.
Optionalopts: ApiCallOptionsDismiss new pending peers recently added to a chat folder deep link » .
Optionalopts: ApiCallOptionsImport a chat folder deep link » , joining some or all the chats in the folder.
Optionalopts: ApiCallOptionsJoin channels and supergroups recently added to a chat folder deep link » .
Optionalopts: ApiCallOptionsDelete a folder imported using a chat folder deep link »
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsIf the add contact action bar is active , add that user as contact
Optionalopts: ApiCallOptionsAdd an existing telegram user as contact. Use contacts.importContacts to add contacts by phone number, without knowing their Telegram ID.
Optionalopts: ApiCallOptionsAdds a peer to a blocklist, see here » for more info.
Optionalopts: ApiCallOptionsStop getting notifications about discussion replies of a certain user in
Optionalopts: ApiCallOptionsDelete contacts by phone number
Optionalopts: ApiCallOptionsDeletes several contacts from the list.
Optionalopts: ApiCallOptionsEdit the close friends list, see here » for more info.
Optionalopts: ApiCallOptionsGenerates a temporary profile link for the currently logged-in user.
Optionalopts: ApiCallOptionsFetch all users with birthdays that fall within +1/-1 days, relative to the current day: this method should be invoked by clients every 6-8 hours, and if the result is non-empty, it should be used to appropriately update locally cached birthday information in user . birthday . See here » for more info.
Optionalopts: ApiCallOptionsReturns the list of blocked users.
Optionalopts: ApiCallOptionsGet the telegram IDs of all contacts. Returns an array of Telegram user IDs for all contacts (0 if a contact does not have an associated Telegram account or have hidden their account using privacy settings).
Optionalopts: ApiCallOptionsReturns the current user's contact list.
Optionalopts: ApiCallOptionsGet users and geochats near you, see here » for more info.
Optionalopts: ApiCallOptionsGet all contacts, requires a takeout session, see here » for more info .
Optionalopts: ApiCallOptionsObtain a list of sponsored peer search results for a given query
Optionalopts: ApiCallOptionsUse this method to obtain the online statuses of all contacts with an accessible Telegram account.
Optionalopts: ApiCallOptionsGet most used peers
Optionalopts: ApiCallOptionsImports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info. Use contacts.addContact to add Telegram contacts without actually using their phone number.
Optionalopts: ApiCallOptionsObtain user info from a temporary profile link .
Optionalopts: ApiCallOptionsRemoves all contacts without an associated Telegram account.
Optionalopts: ApiCallOptionsReset rating of top peer
Optionalopts: ApiCallOptionsResolve a phone number to get user info, if their privacy settings allow it.
Optionalopts: ApiCallOptionsResolve a
Optionalopts: ApiCallOptionsReturns users found by username substring.
Optionalopts: ApiCallOptionsReplace the contents of an entire blocklist, see here for more info » .
Optionalopts: ApiCallOptionsEnable/disable top peers
Optionalopts: ApiCallOptionsDeletes a peer from a blocklist, see here » for more info.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsEdit peers in peer folder
Optionalopts: ApiCallOptionsFetch information about a fragment collectible, see here » for more info on the full flow.
Optionalopts: ApiCallOptionsAccept the new terms of service
Optionalopts: ApiCallOptionsDismiss a suggestion, see here for more info » .
Optionalopts: ApiCallOptionsInternal use
Optionalopts: ApiCallOptionsGet app-specific configuration, see client configuration for more info on the result.
Optionalopts: ApiCallOptionsReturns information on update availability for the current application.
Optionalopts: ApiCallOptionsGet configuration for CDN file downloads.
Optionalopts: ApiCallOptionsReturns current configuration, including data center configuration.
Optionalopts: ApiCallOptionsGet name, ISO code, localized name and phone codes/patterns of all available countries
Optionalopts: ApiCallOptionsGet info about an unsupported deep link, see here for more info » .
Optionalopts: ApiCallOptionsReturns localized text of a text message with an invitation.
Optionalopts: ApiCallOptionsReturns info on data center nearest to the user.
Optionalopts: ApiCallOptionsGet passport configuration
Optionalopts: ApiCallOptionsGet the set of accent color palettes » that can be used for message accents.
Optionalopts: ApiCallOptionsGet the set of accent color palettes » that can be used in profile page backgrounds.
Optionalopts: ApiCallOptionsGet Telegram Premium promotion information
Optionalopts: ApiCallOptionsReturns a set of useful suggestions and PSA/MTProxy sponsored peers, see here » for more info.
Optionalopts: ApiCallOptionsGet recently used t.me links. When installing official applications from "Download Telegram" buttons present in t.me pages, a referral parameter is passed to applications after installation. If, after downloading the application, the user creates a new account (instead of logging into an existing one), the referral parameter should be imported using this method, which returns the t.me pages the user recently opened, before installing Telegram.
Optionalopts: ApiCallOptionsReturns the support user for the "ask a question" feature.
Optionalopts: ApiCallOptionsGet localized name of the telegram support user
Optionalopts: ApiCallOptionsLook for updates of telegram's terms of service
Optionalopts: ApiCallOptionsReturns timezone information that may be used elsewhere in the API, such as to set Telegram Business opening hours » .
Optionalopts: ApiCallOptionsCan only be used by TSF members to obtain internal information.
Optionalopts: ApiCallOptionsHide MTProxy/Public Service Announcement information
Optionalopts: ApiCallOptionsSaves logs of application on the server.
Optionalopts: ApiCallOptionsInforms the server about the number of pending bot updates if they haven't been processed for a long time; for bots only
Optionalopts: ApiCallOptionsGet new strings in language pack
Optionalopts: ApiCallOptionsGet localization pack strings
Optionalopts: ApiCallOptionsGet information about a language in a localization pack
Optionalopts: ApiCallOptionsGet information about all languages in a localization pack
Optionalopts: ApiCallOptionsGet strings from a language pack
Optionalopts: ApiCallOptionsConfirms creation of a secret chat
Optionalopts: ApiCallOptionsUse this to accept a Seamless Telegram Login authorization request, for more info click here »
Optionalopts: ApiCallOptionsAdds a user to a chat and sends a service message on it.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsAppends one or more items to a todo list » .
Optionalopts: ApiCallOptionsCheck the validity of a chat invite link and get basic info about it
Optionalopts: ApiCallOptionsObtains information about a chat export file, generated by a foreign chat app, click here for more info about imported chats » .
Optionalopts: ApiCallOptionsCheck whether chat history exported from another chat app can be imported into a specific Telegram chat, click here for more info » . If the check succeeds, and no RPC errors are returned, a messages.CheckedHistoryImportPeer constructor will be returned, with a confirmation text to be shown to the user, before actually initializing the import.
Optionalopts: ApiCallOptionsBefore 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.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsClear recently used message reactions
Optionalopts: ApiCallOptionsClear recent stickers
Optionalopts: ApiCallOptionsInforms the server that the user has interacted with a sponsored message in one of the ways listed here » .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsCreates a new chat.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsDelete a chat
Optionalopts: ApiCallOptionsDeletes a user from a chat and sends a service message on it.
Optionalopts: ApiCallOptionsDelete a chat invite
Optionalopts: ApiCallOptionsDelete a fact-check from a message. Can only be used by independent fact-checkers as specified by the appConfig.can_edit_factcheck configuration flag.
Optionalopts: ApiCallOptionsDeletes communication history.
Optionalopts: ApiCallOptionsDeletes messages by their identifiers.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsDelete the entire phone call history.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsDelete one or more messages from a quick reply shortcut . This will also emit an updateDeleteQuickReplyMessages update.
Optionalopts: ApiCallOptionsCompletely 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).
Optionalopts: ApiCallOptionsDelete all revoked chat invites
Optionalopts: ApiCallOptionsDeletes messages from a monoforum topic » , or deletes messages forwarded from a specific peer to saved messages » .
Optionalopts: ApiCallOptionsDelete scheduled messages
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsCancels a request for creation and/or delete info on secret chat.
Optionalopts: ApiCallOptionsEdit the description of a group/supergroup/channel .
Optionalopts: ApiCallOptionsMake a user admin in a basic group .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsEdit the default banned rights of a channel/supergroup/group .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsChanges chat photo and sends a service message on it
Optionalopts: ApiCallOptionsChanges chat name and sends a service message on it.
Optionalopts: ApiCallOptionsEdit an exported chat invite
Optionalopts: ApiCallOptionsEdit/create a fact-check on a message. Can only be used by independent fact-checkers as specified by the appConfig.can_edit_factcheck configuration flag.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsEdit an inline bot message
Optionalopts: ApiCallOptionsEdit message
Optionalopts: ApiCallOptionsRename a quick reply shortcut . This will emit an updateQuickReplies update to other logged-in sessions.
Optionalopts: ApiCallOptionsExport an invite link for a chat
Optionalopts: ApiCallOptionsMark or unmark a sticker as favorite
Optionalopts: ApiCallOptionsForwards messages by their IDs.
Optionalopts: ApiCallOptionsGet info about chat invites generated by admins.
Optionalopts: ApiCallOptionsReturn all message drafts . Returns all the latest updateDraftMessage updates related to all chats with drafts.
Optionalopts: ApiCallOptionsGet all installed stickers
Optionalopts: ApiCallOptionsGet all archived stickers
Optionalopts: ApiCallOptionsGet stickers attached to a photo or video
Optionalopts: ApiCallOptionsReturns attachment menu entry for a bot mini app that can be launched from the attachment menu »
Optionalopts: ApiCallOptionsReturns installed attachment menu bot mini apps »
Optionalopts: ApiCallOptionsFetch the full list of usable animated message effects » .
Optionalopts: ApiCallOptionsObtain available message reactions »
Optionalopts: ApiCallOptionsObtain information about a direct link Mini App
Optionalopts: ApiCallOptionsPress an inline callback button and get a callback answer from the bot
Optionalopts: ApiCallOptionsGet info about the users that joined the chat using a specific chat invite
Optionalopts: ApiCallOptionsReturns chat basic info on their IDs.
Optionalopts: ApiCallOptionsGet chats in common with a user
Optionalopts: ApiCallOptionsFetch custom emoji stickers » . Returns a list of documents with the animated custom emoji in TGS format, and a documentAttributeCustomEmoji attribute with the original emoji and info about the emoji stickerset this custom emoji belongs to.
Optionalopts: ApiCallOptionsGets the default value of the Time-To-Live setting, applied to all new chats.
Optionalopts: ApiCallOptionsFetch a default recommended list of saved message tag reactions .
Optionalopts: ApiCallOptionsReturns configuration parameters for Diffie-Hellman key generation. Can also return a random sequence of bytes of required length.
Optionalopts: ApiCallOptionsReturns the current user dialog list.
Optionalopts: ApiCallOptionsGet dialogs manually marked as unread
Optionalopts: ApiCallOptionsGet discussion message from the associated discussion group of a channel to show it on top of the comment section, without actually joining the group
Optionalopts: ApiCallOptionsGet a document by its SHA256 hash, mainly used for gifs
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsRepresents a list of emoji categories .
Optionalopts: ApiCallOptionsGet localized emoji keywords » .
Optionalopts: ApiCallOptionsGet changed emoji keywords » .
Optionalopts: ApiCallOptionsObtain a list of related languages that must be used when fetching emoji keyword lists » . Usually the method will return the passed language codes (if localized) + en + some language codes for similar languages (if applicable).
Optionalopts: ApiCallOptionsRepresents a list of emoji categories , to be used when selecting custom emojis to set as profile picture .
Optionalopts: ApiCallOptionsRepresents a list of emoji categories , to be used when selecting custom emojis to set as custom emoji status .
Optionalopts: ApiCallOptionsRepresents a list of emoji categories , to be used when choosing a sticker.
Optionalopts: ApiCallOptionsGets the list of currently installed custom emoji stickersets .
Optionalopts: ApiCallOptionsReturns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji keywords » . The URL will be valid for 30 seconds after generation.
Optionalopts: ApiCallOptionsGet info about a chat invite
Optionalopts: ApiCallOptionsGet info about the chat invites of a specific chat
Optionalopts: ApiCallOptionsFetch updated information about paid media, see here » for the full flow. This method will return an array of updateMessageExtendedMedia updates, only for messages containing already bought paid media. No information will be returned for messages containing not yet bought paid media.
Optionalopts: ApiCallOptionsFetch one or more factchecks, see here » for the full flow.
Optionalopts: ApiCallOptionsGet faved stickers
Optionalopts: ApiCallOptionsGets featured custom emoji stickersets.
Optionalopts: ApiCallOptionsGet featured stickers
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsGet full info about a basic group .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsGet highscores of a game
Optionalopts: ApiCallOptionsReturns the conversation history with one interlocutor / within a chat
Optionalopts: ApiCallOptionsQuery an inline bot
Optionalopts: ApiCallOptionsGet highscores of a game sent using an inline bot
Optionalopts: ApiCallOptionsGet installed mask stickers
Optionalopts: ApiCallOptionsFind out if a media message's caption can be edited
Optionalopts: ApiCallOptionsGet message reaction list, along with the sender of each reaction.
Optionalopts: ApiCallOptionsGet which users read a specific message: only available for groups and supergroups with less than chat_read_mark_size_threshold members , read receipts will be stored for chat_read_mark_expire_period seconds after the message was sent , see client configuration for more info » .
Optionalopts: ApiCallOptionsReturns the list of messages by their IDs.
Optionalopts: ApiCallOptionsGet message reactions »
Optionalopts: ApiCallOptionsGet and increase the view counter of a message sent or forwarded from a channel
Optionalopts: ApiCallOptionsFetch all stickersets » owned by the current user.
Optionalopts: ApiCallOptionsMethod for fetching previously featured stickers
Optionalopts: ApiCallOptionsGet count of online users in a chat
Optionalopts: ApiCallOptionsGet the exact read date of one of our messages, sent to a private chat with another user. Can be only done for private outgoing messages not older than appConfig.pm_read_date_expire_period » . If the peer 's userFull . read_dates_private flag is set, we will not be able to fetch the exact read date of messages we send to them, and a USER_PRIVACY_RESTRICTED RPC error will be emitted. The exact read date of messages might still be unavailable for other reasons, see here » for more info. To set userFull . read_dates_private for ourselves invoke account.setGlobalPrivacySettings , setting the settings.hide_read_marks flag.
Optionalopts: ApiCallOptionsFetches an updatePaidReactionPrivacy update with the current default paid reaction privacy, see here » for more info.
Optionalopts: ApiCallOptionsGet dialog info of specified peers
Optionalopts: ApiCallOptionsGet peer settings
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsGet pinned dialogs
Optionalopts: ApiCallOptionsGet pinned saved dialogs, see here » for more info.
Optionalopts: ApiCallOptionsGet poll results
Optionalopts: ApiCallOptionsGet poll results for non-anonymous polls
Optionalopts: ApiCallOptionsObtain a prepared inline message generated by a mini app : invoked when handling web_app_send_prepared_message events
Optionalopts: ApiCallOptionsFetch basic info about all existing quick reply shortcuts .
Optionalopts: ApiCallOptionsFetch (a subset or all) messages in a quick reply shortcut » .
Optionalopts: ApiCallOptionsGet live location history of a certain user
Optionalopts: ApiCallOptionsGet recently used message reactions
Optionalopts: ApiCallOptionsGet recent stickers
Optionalopts: ApiCallOptionsGet messages in a reply thread
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsReturns the current saved dialog list » or monoforum topic list » .
Optionalopts: ApiCallOptionsObtain information about specific saved message dialogs » or monoforum topics » .
Optionalopts: ApiCallOptionsGet saved GIFs.
Optionalopts: ApiCallOptionsFetch saved messages » forwarded from a specific peer, or fetch messages from a monoforum topic » .
Optionalopts: ApiCallOptionsFetch the full list of saved message tags created by the user.
Optionalopts: ApiCallOptionsGet scheduled messages
Optionalopts: ApiCallOptionsGet scheduled messages
Optionalopts: ApiCallOptionsGet the number of results that would be found by a messages.search call with the same parameters
Optionalopts: ApiCallOptionsReturns information about the next messages of the specified type in the chat split by days. Returns the results in reverse chronological order. Can return partial results for the last returned day.
Optionalopts: ApiCallOptionsReturns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. Returns the results in reverse chronological order (i.e., in order of decreasing message_id).
Optionalopts: ApiCallOptionsGet message ranges for saving the user's chat history
Optionalopts: ApiCallOptionsGet a list of sponsored messages for a peer, see here » for more info.
Optionalopts: ApiCallOptionsGet stickers by emoji
Optionalopts: ApiCallOptionsGet info about a stickerset
Optionalopts: ApiCallOptionsGet suggested folders
Optionalopts: ApiCallOptionsGot popular message reactions
Optionalopts: ApiCallOptionsGet unread messages where we were mentioned
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsGet unread reactions to messages you sent
Optionalopts: ApiCallOptionsGet instant view page
Optionalopts: ApiCallOptionsGet preview of webpage
Optionalopts: ApiCallOptionsDismiss or approve all join requests related to a specific chat or channel.
Optionalopts: ApiCallOptionsDismiss or approve a chat join request related to a specific chat or channel.
Optionalopts: ApiCallOptionsShould 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 » .
Optionalopts: ApiCallOptionsImport a chat invite and join a private chat/supergroup/channel
Optionalopts: ApiCallOptionsImport chat history from a foreign chat app into a specific Telegram chat, click here for more info about imported chats » .
Optionalopts: ApiCallOptionsInstall a stickerset
Optionalopts: ApiCallOptionsManually mark dialog as unread
Optionalopts: ApiCallOptionsTurn a basic group into a supergroup
Optionalopts: ApiCallOptionsIndicate 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.
Optionalopts: ApiCallOptionsRate transcribed voice message
Optionalopts: ApiCallOptionsMark a thread as read
Optionalopts: ApiCallOptionsMarks message history within a secret chat as read.
Optionalopts: ApiCallOptionsMark new featured stickers as read
Optionalopts: ApiCallOptionsMarks message history as read.
Optionalopts: ApiCallOptionsMark mentions as read
Optionalopts: ApiCallOptionsNotifies the sender about the recipient having listened a voice message or watched a video, emitting an updateReadMessagesContents .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsMark message reactions » as read
Optionalopts: ApiCallOptionsMark messages as read in a monoforum topic » .
Optionalopts: ApiCallOptionsConfirms receipt of messages by a client, cancels PUSH-notification sending.
Optionalopts: ApiCallOptionsConfirms receipt of messages in a secret chat by client, cancels push notifications. The method returns a list of random_id s of messages for which push notifications were cancelled.
Optionalopts: ApiCallOptionsReorder pinned dialogs
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsReorder pinned saved message dialogs » .
Optionalopts: ApiCallOptionsReorder quick reply shortcuts . This will emit an updateQuickReplies update to other logged-in sessions.
Optionalopts: ApiCallOptionsReorder installed stickersets
Optionalopts: ApiCallOptionsReport a message in a chat for violation of telegram's Terms of Service
Optionalopts: ApiCallOptionsReport a secret chat for spam
Optionalopts: ApiCallOptionsUsed for Telegram Gateway verification messages » : indicate to the server that one or more message s were received by the client, if requested by the message . report_delivery_until_date flag or the equivalent flag in push notifications .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsReport a message reaction
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsReport a new incoming chat for spam, if the peer settings of the chat allow us to do that
Optionalopts: ApiCallOptionsReport a sponsored message » , see here » for more info on the full flow.
Optionalopts: ApiCallOptionsOpen a bot mini app from a direct Mini App deep link , sending over user information after user confirmation. After calling this method, until the user closes the webview, messages.prolongWebView must be called every 60 seconds.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsSends a request to start a secret chat to the user.
Optionalopts: ApiCallOptionsOpen a Main Mini App .
Optionalopts: ApiCallOptionsOpen a bot mini app .
Optionalopts: ApiCallOptionsGet more info about a Seamless Telegram Login authorization request, for more info click here »
Optionalopts: ApiCallOptionsOpen a bot mini app , sending over user information after user confirmation. After calling this method, until the user closes the webview, messages.prolongWebView must be called every 60 seconds.
Optionalopts: ApiCallOptionsChange the default peer that should be used when sending messages, reactions, poll votes to a specific group
Optionalopts: ApiCallOptionsSave a message draft associated to a chat.
Optionalopts: ApiCallOptionsAdd GIF to saved gifs list
Optionalopts: ApiCallOptionsSave a prepared inline message , to be shared by the user of the mini app using a web_app_send_prepared_message event
Optionalopts: ApiCallOptionsAdd/remove sticker from recent stickers list
Optionalopts: ApiCallOptionsSearch for messages.
Optionalopts: ApiCallOptionsLook for custom emojis associated to a UTF8 emoji
Optionalopts: ApiCallOptionsSearch for custom emoji stickersets »
Optionalopts: ApiCallOptionsSearch for messages and peers globally
Optionalopts: ApiCallOptionsView and search recently sent media. This method does not support pagination.
Optionalopts: ApiCallOptionsSearch for stickers using AI-powered keyword search
Optionalopts: ApiCallOptionsSearch for stickersets
Optionalopts: ApiCallOptionsSend one or more chosen peers, as requested by a keyboardButtonRequestPeer button.
Optionalopts: ApiCallOptionsSends a text message to a secret chat.
Optionalopts: ApiCallOptionsSends a message with a file attachment to a secret chat
Optionalopts: ApiCallOptionsSends a service message to a secret chat.
Optionalopts: ApiCallOptionsSend a result obtained using messages.getInlineBotResults .
Optionalopts: ApiCallOptionsSend a media
Optionalopts: ApiCallOptionsSends a message to a chat
Optionalopts: ApiCallOptionsSend an album or grouped media
Optionalopts: ApiCallOptionsSends one or more paid Telegram Star reactions » , transferring Telegram Stars » to a channel's balance.
Optionalopts: ApiCallOptionsSend a quick reply shortcut » .
Optionalopts: ApiCallOptionsReact to message. Starting from layer 159, the reaction will be sent from the peer specified using messages.saveDefaultSendAs .
Optionalopts: ApiCallOptionsSend scheduled messages right away
Optionalopts: ApiCallOptionsNotify the other user in a private chat that a screenshot of the chat was taken
Optionalopts: ApiCallOptionsVote in a poll Starting from layer 159, the vote will be sent from the peer specified using messages.saveDefaultSendAs .
Optionalopts: ApiCallOptionsUsed by the user to relay data from an opened reply keyboard bot mini app to the bot that owns it.
Optionalopts: ApiCallOptionsTerminate webview interaction started with messages.requestWebView , sending the specified message to the chat on behalf of the user.
Optionalopts: ApiCallOptionsSet the callback answer to a user button press (bots only)
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOnce 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.
Optionalopts: ApiCallOptionsIf 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.
Optionalopts: ApiCallOptionsChange the set of message reactions » that can be used in a certain group, supergroup or channel
Optionalopts: ApiCallOptionsChange the chat theme of a certain chat, see here » for more info.
Optionalopts: ApiCallOptionsSet a custom wallpaper » in a specific private chat with another user.
Optionalopts: ApiCallOptionsChanges the default value of the Time-To-Live setting, applied to all new chats.
Optionalopts: ApiCallOptionsChange 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 .
Optionalopts: ApiCallOptionsSend typing event by the current user to a secret chat.
Optionalopts: ApiCallOptionsUse this method to set the score of the specified user in a game sent as a normal message (bots only).
Optionalopts: ApiCallOptionsSet maximum Time-To-Live of all messages in the specified chat
Optionalopts: ApiCallOptionsAnswer an inline query, for bots only
Optionalopts: ApiCallOptionsUse this method to set the score of the specified user in a game sent as an inline message (bots only).
Optionalopts: ApiCallOptionsSends a current user typing event (see SendMessageAction for all event types) to a conversation partner or group.
Optionalopts: ApiCallOptionsStart a conversation with a bot using a deep linking parameter
Optionalopts: ApiCallOptionsComplete 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 .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsEnable or disable web bot attachment menu »
Optionalopts: ApiCallOptionsEnable or disable folder tags » .
Optionalopts: ApiCallOptionsPin/unpin a dialog
Optionalopts: ApiCallOptionsEnable or disable content protection on a channel or chat
Optionalopts: ApiCallOptionsChanges the privacy of already sent paid reactions on a specific message.
Optionalopts: ApiCallOptionsShow or hide the real-time chat translation popup for a certain chat
Optionalopts: ApiCallOptionsPin or unpin a saved message dialog » .
Optionalopts: ApiCallOptionsApply changes to multiple stickersets
Optionalopts: ApiCallOptionsApprove or reject a suggested post » .
Optionalopts: ApiCallOptionsMark one or more items of a todo list » as completed or not completed.
Optionalopts: ApiCallOptionsTranscribe voice message
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsTranslate a given text. Styled text entities will only be preserved for Telegram Premium users.
Optionalopts: ApiCallOptionsUninstall a stickerset
Optionalopts: ApiCallOptionsUnpin all pinned messages
Optionalopts: ApiCallOptionsUpdate folder
Optionalopts: ApiCallOptionsReorder folders
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsPin a message
Optionalopts: ApiCallOptionsUpdate the description of a saved message tag » .
Optionalopts: ApiCallOptionsUpload encrypted file and associate it to a secret chat (without actually sending it to the chat).
Optionalopts: ApiCallOptionsUpload a media file associated with an imported chat, click here for more info » .
Optionalopts: ApiCallOptionsUpload a file and associate it to a chat (without actually sending it to the chat) May also be used in a business connection , not by wrapping the query in invokeWithBusinessConnection » , but rather by specifying the business connection ID in the business_connection_id parameter.
Optionalopts: ApiCallOptionsMark a specific sponsored message » as read
Optionalopts: ApiCallOptionsApply a Telegram Premium giftcode »
Optionalopts: ApiCallOptionsInforms server about a purchase made through the App Store: for official applications only.
Optionalopts: ApiCallOptionsInforms server about a purchase made through the Play Store: for official applications only.
Optionalopts: ApiCallOptionsCancel a bot subscription
Optionalopts: ApiCallOptionsChecks whether a purchase is possible. Must be called before in-store purchase, official apps only.
Optionalopts: ApiCallOptionsActivate or deactivate a Telegram Star subscription » .
Optionalopts: ApiCallOptionsCheck if the specified gift » can be sent.
Optionalopts: ApiCallOptionsObtain information about a Telegram Premium giftcode »
Optionalopts: ApiCallOptionsClear saved payment information
Optionalopts: ApiCallOptionsJoin a bot's affiliate program, becoming an affiliate »
Optionalopts: ApiCallOptionsConvert a received gift » into Telegram Stars: this will permanently destroy the gift, converting it into starGift . convert_stars Telegram Stars , added to the user's balance. Note that starGift . convert_stars will be less than the buying price ( starGift . stars ) of the gift if it was originally bought using Telegram Stars bought a long time ago.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsCreate a star gift collection » .
Optionalopts: ApiCallOptionsDelete a star gift collection » .
Optionalopts: ApiCallOptionsLeave a bot's affiliate program »
Optionalopts: ApiCallOptionsGenerate an invoice deep link
Optionalopts: ApiCallOptionsRe-join a private channel associated to an active Telegram Star subscription » .
Optionalopts: ApiCallOptionsGet info about a credit card
Optionalopts: ApiCallOptionsFetch info about a specific bot affiliation »
Optionalopts: ApiCallOptionsFetch all affiliations we have created for a certain peer
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsObtain information about a Telegram Premium giveaway » .
Optionalopts: ApiCallOptionsGet a payment form
Optionalopts: ApiCallOptionsGet payment receipt
Optionalopts: ApiCallOptionsObtain a list of Telegram Premium giveaway/gift code » options.
Optionalopts: ApiCallOptionsGet collectible gifts of a specific type currently on resale, see here » for more info. sort_by_price and sort_by_num are mutually exclusive, if neither are set results are sorted by the unixtime (descending) when their resell price was last changed. See here » for detailed documentation on this method.
Optionalopts: ApiCallOptionsFetch info about specific gifts owned by a peer we control. Note that unlike what the name suggests, the method can be used to fetch both "saved" and "unsaved" gifts (aka gifts both pinned and not pinned to the profile).
Optionalopts: ApiCallOptionsFetch the full list of gifts owned by a peer. Note that unlike what the name suggests, the method can be used to fetch both "saved" and "unsaved" gifts (aka gifts both pinned and not pinned) to the profile, depending on the passed flags.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsFetches all star gift collections » of a peer.
Optionalopts: ApiCallOptionsGet a list of available gifts, see here » for more info.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsObtain a preview of the possible attributes (chosen randomly) a gift » can receive after upgrading it to a collectible gift » , see here » for more info.
Optionalopts: ApiCallOptionsConvert a collectible gift » to an NFT on the TON blockchain.
Optionalopts: ApiCallOptionsObtain a list of Telegram Stars gift options » as starsGiftOption constructors.
Optionalopts: ApiCallOptionsFetch a list of star giveaway options » .
Optionalopts: ApiCallOptionsReturns a URL for a Telegram Ad platform account that can be used to set up advertisements for channel/bot in peer , paid using the Telegram Stars owned by the specified peer , see here » for more info.
Optionalopts: ApiCallOptionsGet Telegram Star revenue statistics » .
Optionalopts: ApiCallOptionsWithdraw funds from a channel or bot's star balance » .
Optionalopts: ApiCallOptionsGet the current Telegram Stars balance of the current account (with peer= inputPeerSelf ), or the stars balance of the bot specified in peer .
Optionalopts: ApiCallOptionsObtain a list of active, expired or cancelled Telegram Star subscriptions » .
Optionalopts: ApiCallOptionsObtain a list of Telegram Stars topup options » as starsTopupOption constructors.
Optionalopts: ApiCallOptionsFetch Telegram Stars transactions . The inbound and outbound flags are mutually exclusive: if none of the two are set, both incoming and outgoing transactions are fetched.
Optionalopts: ApiCallOptionsObtain info about Telegram Star transactions » using specific transaction IDs.
Optionalopts: ApiCallOptionsObtain a list of suggested mini apps with available affiliate programs order_by_revenue and order_by_date are mutually exclusive: if neither is set, results are sorted by profitability.
Optionalopts: ApiCallOptionsObtain info about a collectible gift » using a slug obtained from a collectible gift link » .
Optionalopts: ApiCallOptionsGet information about the value of a collectible gift » .
Optionalopts: ApiCallOptionsLaunch a prepaid giveaway » .
Optionalopts: ApiCallOptionsRefund a Telegram Stars transaction, see here » for more info.
Optionalopts: ApiCallOptionsReorder the star gift collections » on an owned peer's profile.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsDisplay or remove a received gift » from our profile.
Optionalopts: ApiCallOptionsSend compiled payment form
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsMake a payment using Telegram Stars, see here » for more info.
Optionalopts: ApiCallOptionsEnables or disables the reception of notifications every time a gift » is received by the specified channel, can only be invoked by admins with post_messages admin rights .
Optionalopts: ApiCallOptionsPins a received gift on top of the profile of the user or owned channels by using payments.toggleStarGiftsPinnedToTop .
Optionalopts: ApiCallOptionsTransfer a collectible gift to another user or channel: can only be used if transfer is free (i.e. messageActionStarGiftUnique . transfer_stars is not set); see here » for more info on the full flow (including the different flow to use in case the transfer isn't free).
Optionalopts: ApiCallOptionsAdd or remove gifts from a star gift collection » , or rename the collection.
Optionalopts: ApiCallOptionsA collectible gift we own » can be put up for sale on the gift marketplace » with this method, see here » for more info.
Optionalopts: ApiCallOptionsUpgrade a gift to a collectible gift : can only be used if the upgrade was already paid by the gift sender; see here » for more info on the full flow (including the different flow to use in case the upgrade was not paid by the gift sender).
Optionalopts: ApiCallOptionsSubmit requested order information for validation
Optionalopts: ApiCallOptionsAccept incoming call
Optionalopts: ApiCallOptionsCheck whether the group call Server Forwarding Unit is currently receiving the streams with the specified WebRTC source IDs. Returns an intersection of the source IDs specified in sources , and the source IDs currently being forwarded by the SFU.
Optionalopts: ApiCallOptionsComplete phone call E2E encryption key exchange »
Optionalopts: ApiCallOptionsCreate and optionally join a new conference call.
Optionalopts: ApiCallOptionsCreate a group call or livestream
Optionalopts: ApiCallOptionsDeclines a conference call invite.
Optionalopts: ApiCallOptionsRemove participants from a conference call. Exactly one of the only_left and kick flags must be set.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsRefuse or end running call
Optionalopts: ApiCallOptionsTerminate a group call
Optionalopts: ApiCallOptionsEdit information about a given group call participant Note: flags .N? Bool parameters can have three possible values:
Optionalopts: ApiCallOptionsEdit the title of a group call or livestream
Optionalopts: ApiCallOptionsGet an invite link for a group call or livestream
Optionalopts: ApiCallOptionsGet phone call configuration to be passed to libtgvoip's shared config
Optionalopts: ApiCallOptionsGet info about a group call
Optionalopts: ApiCallOptionsFetch the blocks of a conference blockchain » .
Optionalopts: ApiCallOptionsGet a list of peers that can be used to join a group call, presenting yourself as a specific user/channel.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsGet info about RTMP streams in a group call or livestream. This method should be invoked to the same group/channel-related DC used for downloading livestream chunks . As usual, the media DC is preferred, if available.
Optionalopts: ApiCallOptionsGet RTMP URL and stream key for RTMP livestreams. Can be used even before creating the actual RTMP livestream with phone.createGroupCall (the rtmp_stream flag must be set).
Optionalopts: ApiCallOptionsGet group call participants
Optionalopts: ApiCallOptionsInvite a user to a conference call.
Optionalopts: ApiCallOptionsInvite a set of users to a group call.
Optionalopts: ApiCallOptionsJoin a group call
Optionalopts: ApiCallOptionsStart screen sharing in a call
Optionalopts: ApiCallOptionsLeave a group call
Optionalopts: ApiCallOptionsStop screen sharing in a group call
Optionalopts: ApiCallOptionsOptional: 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.
Optionalopts: ApiCallOptionsStart a telegram phone call
Optionalopts: ApiCallOptionsSend phone call debug data to server
Optionalopts: ApiCallOptionsSave phone call debug information
Optionalopts: ApiCallOptionsSet the default peer that will be used to join a group call in a specific dialog.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsBroadcast a blockchain block to all members of a conference call, see here » for more info.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsSend VoIP signaling data
Optionalopts: ApiCallOptionsRate a call, returns info about the rating message sent to the official VoIP bot.
Optionalopts: ApiCallOptionsStart a scheduled group call.
Optionalopts: ApiCallOptionsStart or stop recording a group call: the recorded audio and video streams will be automatically sent to Saved messages (the chat with ourselves).
Optionalopts: ApiCallOptionsChange group call settings
Optionalopts: ApiCallOptionsSubscribe or unsubscribe to a scheduled group call
Optionalopts: ApiCallOptionsDeletes profile photos. The method returns a list of successfully deleted photo IDs.
Optionalopts: ApiCallOptionsReturns the list of user photos.
Optionalopts: ApiCallOptionsInstalls a previously uploaded photo as a profile photo.
Optionalopts: ApiCallOptionsUpload a custom profile picture for a contact, or suggest a new profile picture to a contact. The file , video and video_emoji_markup flags are mutually exclusive.
Optionalopts: ApiCallOptionsUpdates current user profile photo. The file , video and video_emoji_markup flags are mutually exclusive.
Optionalopts: ApiCallOptionsApply one or more boosts » to a peer.
Optionalopts: ApiCallOptionsObtains info about the boosts that were applied to a certain channel or supergroup (admins only)
Optionalopts: ApiCallOptionsGets the current number of boosts of a channel/supergroup.
Optionalopts: ApiCallOptionsObtain which peers are we currently boosting , and how many boost slots we have left.
Optionalopts: ApiCallOptionsReturns the lists of boost that were applied to a channel/supergroup by a specific user (admins only)
Optionalopts: ApiCallOptionsFinish an SMS job (official clients only).
Optionalopts: ApiCallOptionsGet info about an SMS job (official clients only).
Optionalopts: ApiCallOptionsGet SMS jobs status (official clients only).
Optionalopts: ApiCallOptionsCheck if we can process SMS jobs (official clients only).
Optionalopts: ApiCallOptionsEnable SMS jobs (official clients only).
Optionalopts: ApiCallOptionsDisable SMS jobs (official clients only).
Optionalopts: ApiCallOptionsUpdate SMS job settings (official clients only).
Optionalopts: ApiCallOptionsGet channel statistics
Optionalopts: ApiCallOptionsGet supergroup statistics
Optionalopts: ApiCallOptionsObtains a list of messages, indicating to which other public channels was a channel message forwarded. Will return a list of messages with peer_id equal to the public channel to which this message was forwarded.
Optionalopts: ApiCallOptionsGet message statistics
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsObtain forwards of a story as a message to public chats and reposts by public channels.
Optionalopts: ApiCallOptionsGet statistics for a certain story .
Optionalopts: ApiCallOptionsLoad channel statistics graph asynchronously
Optionalopts: ApiCallOptionsAdd a sticker to a stickerset. The sticker set must have been created by the current user/bot.
Optionalopts: ApiCallOptionsUpdate the keywords, emojis or mask coordinates of a sticker.
Optionalopts: ApiCallOptionsChanges the absolute position of a sticker in the set to which it belongs. The sticker set must have been created by the current user/bot.
Optionalopts: ApiCallOptionsCheck whether the given short name is available
Optionalopts: ApiCallOptionsCreate a stickerset.
Optionalopts: ApiCallOptionsDeletes a stickerset we created.
Optionalopts: ApiCallOptionsRemove a sticker from the set where it belongs. The sticker set must have been created by the current user/bot.
Optionalopts: ApiCallOptionsRenames a stickerset.
Optionalopts: ApiCallOptionsReplace a sticker in a stickerset » .
Optionalopts: ApiCallOptionsSet stickerset thumbnail
Optionalopts: ApiCallOptionsSuggests a short name for a given stickerpack name
Optionalopts: ApiCallOptionsActivates stories stealth mode , see here » for more info. Will return an updateStoriesStealthMode .
Optionalopts: ApiCallOptionsCheck whether we can post stories as the specified peer.
Optionalopts: ApiCallOptionsCreates a story album .
Optionalopts: ApiCallOptionsDelete a story album .
Optionalopts: ApiCallOptionsDeletes some posted stories .
Optionalopts: ApiCallOptionsEdit an uploaded story May also be used in a business connection , not by wrapping the query in invokeWithBusinessConnection » , but rather by specifying the ID of a controlled business user in peer : in this context, the method can only be used to edit stories posted by the same business bot on behalf of the user with stories.sendStory .
Optionalopts: ApiCallOptionsGenerate a story deep link for a specific story
Optionalopts: ApiCallOptionsGet story albums created by a peer.
Optionalopts: ApiCallOptionsGet stories in a story album » .
Optionalopts: ApiCallOptionsObtain the latest read story ID for all peers when first logging in, returned as a list of updateReadStories updates, see here » for more info.
Optionalopts: ApiCallOptionsFetch the List of active (or active and hidden) stories, see here » for more info on watching stories.
Optionalopts: ApiCallOptionsObtain a list of channels where the user can post stories
Optionalopts: ApiCallOptionsGet the IDs of the maximum read stories for a set of peers.
Optionalopts: ApiCallOptionsFetch the full active story list of a specific peer.
Optionalopts: ApiCallOptionsFetch the stories pinned on a peer's profile.
Optionalopts: ApiCallOptionsFetch the story archive » of a peer we control.
Optionalopts: ApiCallOptionsObtain full info about a set of stories by their IDs.
Optionalopts: ApiCallOptionsObtain info about the view count, forward count, reactions and recent viewers of one or more stories .
Optionalopts: ApiCallOptionsGet the reaction and interaction list of a story posted to a channel, along with the sender of each reaction. Can only be used by channel admins.
Optionalopts: ApiCallOptionsObtain the list of users that have viewed a specific story we posted
Optionalopts: ApiCallOptionsIncrement the view counter of one or more stories.
Optionalopts: ApiCallOptionsMark all stories up to a certain ID as read, for a given peer; will emit an updateReadStories update to all logged-in sessions.
Optionalopts: ApiCallOptionsReorder story albums on a profile » .
Optionalopts: ApiCallOptionsReport a story.
Optionalopts: ApiCallOptionsGlobally search for stories using a hashtag or a location media area , see here » for more info on the full flow. Either hashtag or area must be set when invoking the method.
Optionalopts: ApiCallOptionsReact to a story.
Optionalopts: ApiCallOptionsUploads a Telegram Story . May also be used in a business connection , not by wrapping the query in invokeWithBusinessConnection » , but rather by specifying the ID of a controlled business user in peer .
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptionsHide the active stories of a specific peer, preventing them from being displayed on the action bar on the homescreen.
Optionalopts: ApiCallOptionsHide the active stories of a user, preventing them from being displayed on the action bar on the homescreen, see here » for more info.
Optionalopts: ApiCallOptionsPin or unpin one or more stories
Optionalopts: ApiCallOptionsPin some stories to the top of the profile, see here » for more info.
Optionalopts: ApiCallOptionsRename a story albums » , or add, delete or reorder stories in it.
Optionalopts: ApiCallOptionsReturns the difference between the current state of updates of a certain channel and transmitted.
Optionalopts: ApiCallOptionsGet new updates .
Optionalopts: ApiCallOptionsDownload a CDN file.
Optionalopts: ApiCallOptionsGet SHA256 hashes for verifying downloaded CDN files
Optionalopts: ApiCallOptionsReturns content of a whole file or its part.
Optionalopts: ApiCallOptionsGet SHA256 hashes for verifying downloaded files
Optionalopts: ApiCallOptionsReturns content of a web file, by proxying the request through telegram, see the webfile docs for more info . Note : the query must be sent to the DC specified in the webfile_dc_id MTProto configuration field .
Optionalopts: ApiCallOptionsRequest a reupload of a certain file to a CDN DC .
Optionalopts: ApiCallOptionsSaves a part of a large file (over 10 MB in size) to be later passed to one of the methods.
Optionalopts: ApiCallOptionsSaves a part of file for further sending to one of the methods.
Optionalopts: ApiCallOptionsReturns extended user info by ID.
Optionalopts: ApiCallOptionsCheck whether we can write to the specified users, used to implement bulk checks for Premium-only messages » and paid messages » . For each input user, returns a RequirementToContact constructor (at the same offset in the vector) containing requirements to contact them.
Optionalopts: ApiCallOptionsGet songs pinned to the user's profile, see here » for more info.
Optionalopts: ApiCallOptionsCheck if the passed songs are still pinned to the user's profile, or refresh the file references of songs pinned on a user's profile see here » for more info.
Optionalopts: ApiCallOptionsReturns basic user info according to their identifiers.
Optionalopts: ApiCallOptionsNotify 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.
Optionalopts: ApiCallOptionsOptionalopts: ApiCallOptions
Typed 1:1 facade over the raw MTProto methods.
client.api.<namespace>.<method>(params, opts?)— nonew, no manualinvoke, full autocomplete and strict typing straight from the schema. Per-method params live in<Method>Params; throwable errors in<Method>Errors.