Methods
Table of Contents
Classes
- AddStickerToSet
- Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.
- AnswerCallbackQuery
- Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
- AnswerChatJoinRequestQuery
- Use this method to process a received chat join request query. Returns True on success.
- AnswerGuestQuery
- Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned.
- AnswerInlineQuery
- Use this method to send answers to an inline query. On success, True is returned.
- AnswerPreCheckoutQuery
- Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
- AnswerShippingQuery
- If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
- AnswerWebAppQuery
- Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
- ApproveChatJoinRequest
- Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
- ApproveSuggestedPost
- Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.
- BanChatMember
- Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
- BanChatSenderChat
- Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
- Close
- Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
- CloseForumTopic
- Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
- CloseGeneralForumTopic
- Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
- ConvertGiftToStars
- Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.
- CopyMessage
- Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
- CopyMessages
- Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
- CreateChatInviteLink
- Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
- CreateChatSubscriptionInviteLink
- Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.
- CreateForumTopic
- Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.
- CreateInvoiceLink
- Use this method to create a link for an invoice. Returns the created invoice link as String on success.
- CreateNewStickerSet
- Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.
- DeclineChatJoinRequest
- Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
- DeclineSuggestedPost
- Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.
- DeleteAllMessageReactions
- Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.
- DeleteBusinessMessages
- Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.
- DeleteChatPhoto
- Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
- DeleteChatStickerSet
- Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
- DeleteForumTopic
- Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
- DeleteMessage
- Use this method to delete a message, including service messages, with the following limitations:
- A message can only be deleted if it was sent less than 48 hours ago.
- DeleteMessageReaction
- Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns True on success.
- DeleteMessages
- Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.
- DeleteMyCommands
- Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
- DeleteStickerFromSet
- Use this method to delete a sticker from a set created by the bot. Returns True on success.
- DeleteStickerSet
- Use this method to delete a sticker set that was created by the bot. Returns True on success.
- DeleteStory
- Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.
- DeleteWebhook
- Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
- EditChatInviteLink
- Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
- EditChatSubscriptionInviteLink
- Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.
- EditForumTopic
- Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
- EditGeneralForumTopic
- Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
- EditMessageCaption
- Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
- EditMessageChecklist
- Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.
- EditMessageLiveLocation
- Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
- EditMessageMedia
- Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, a live photo, or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
- EditMessageReplyMarkup
- Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
- EditMessageText
- Use this method to edit text, rich and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
- EditStory
- Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.
- EditUserStarSubscription
- Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.
- ExportChatInviteLink
- Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
- ForwardMessage
- Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.
- ForwardMessages
- Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.
- GetAvailableGifts
- Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.
- GetBusinessAccountGifts
- Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.
- GetBusinessAccountStarBalance
- Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.
- GetBusinessConnection
- Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.
- GetChat
- Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.
- GetChatAdministrators
- Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects.
- GetChatGifts
- Returns the gifts owned by a chat. Returns OwnedGifts on success.
- GetChatMember
- Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.
- GetChatMemberCount
- Use this method to get the number of members in a chat. Returns Int on success.
- GetChatMenuButton
- Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
- GetCustomEmojiStickers
- Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
- GetFile
- Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.
- GetForumTopicIconStickers
- Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.
- GetGameHighScores
- Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.
- GetManagedBotAccessSettings
- Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success.
- GetManagedBotToken
- Use this method to get the token of a managed bot. Returns the token as String on success.
- GetMe
- A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
- GetMyCommands
- Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
- GetMyDefaultAdministratorRights
- Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
- GetMyDescription
- Use this method to get the current bot description for the given user language. Returns BotDescription on success.
- GetMyName
- Use this method to get the current bot name for the given user language. Returns BotName on success.
- GetMyShortDescription
- Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
- GetMyStarBalance
- A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.
- GetStarTransactions
- Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.
- GetStickerSet
- Use this method to get a sticker set. On success, a StickerSet object is returned.
- GetUpdates
- Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
- GetUserChatBoosts
- Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.
- GetUserGifts
- Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.
- GetUserPersonalChatMessages
- Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an array of Message objects is returned.
- GetUserProfileAudios
- Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.
- GetUserProfilePhotos
- Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
- GetWebhookInfo
- Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
- GiftPremiumSubscription
- Gifts a Telegram Premium subscription to the given user. Returns True on success.
- HideGeneralForumTopic
- Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
- LeaveChat
- Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
- LogOut
- Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
- PinChatMessage
- Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.
- PostStory
- Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.
- PromoteChatMember
- Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
- ReadBusinessMessage
- Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.
- RefundStarPayment
- Refunds a successful payment in Telegram Stars. Returns True on success.
- RemoveBusinessAccountProfilePhoto
- Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.
- RemoveChatVerification
- Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.
- RemoveMyProfilePhoto
- Removes the profile photo of the bot. Requires no parameters. Returns True on success.
- RemoveUserVerification
- Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.
- ReopenForumTopic
- Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
- ReopenGeneralForumTopic
- Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
- ReplaceManagedBotToken
- Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.
- ReplaceStickerInSet
- Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.
- RepostStory
- Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.
- Request
- Response
- RestrictChatMember
- Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
- RevokeChatInviteLink
- Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
- SavePreparedInlineMessage
- Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.
- SavePreparedKeyboardButton
- Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.
- SendAnimation
- Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
- SendAudio
- Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
- SendChatAction
- Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
- SendChatJoinRequestWebApp
- Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Returns True on success.
- SendChecklist
- Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.
- SendContact
- Use this method to send phone contacts. On success, the sent Message is returned.
- SendDice
- Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
- SendDocument
- Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
- SendGame
- Use this method to send a game. On success, the sent Message is returned.
- SendGift
- Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.
- SendInvoice
- Use this method to send invoices. On success, the sent Message is returned.
- SendLivePhoto
- Use this method to send live photos. On success, the sent Message is returned.
- SendLocation
- Use this method to send point on the map. On success, the sent Message is returned.
- SendMediaGroup
- Use this method to send a group of photos, live photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Message objects that were sent is returned.
- SendMessage
- Use this method to send text messages. On success, the sent Message is returned.
- SendMessageDraft
- Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendMessage with the complete message to persist it in the user's chat. Returns True on success.
- SendPaidMedia
- Use this method to send paid media. On success, the sent Message is returned.
- SendPhoto
- Use this method to send photos. On success, the sent Message is returned.
- SendPoll
- Use this method to send a native poll. On success, the sent Message is returned.
- SendRichMessage
- Use this method to send rich messages. If the message contains a block with a media element, then the bot must have the right to send the media to the chat. On success, the sent Message is returned.
- SendRichMessageDraft
- Use this method to stream a partial rich message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you must call sendRichMessage with the complete message to persist it in the user's chat. Returns True on success.
- SendSticker
- Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
- SendVenue
- Use this method to send information about a venue. On success, the sent Message is returned.
- SendVideo
- Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
- SendVideoNote
- As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
- SendVoice
- Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
- SetBusinessAccountBio
- Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.
- SetBusinessAccountGiftSettings
- Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.
- SetBusinessAccountName
- Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.
- SetBusinessAccountProfilePhoto
- Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.
- SetBusinessAccountUsername
- Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.
- SetChatAdministratorCustomTitle
- Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
- SetChatDescription
- Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
- SetChatMemberTag
- Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.
- SetChatMenuButton
- Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
- SetChatPermissions
- Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
- SetChatPhoto
- Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
- SetChatStickerSet
- Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
- SetChatTitle
- Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
- SetCustomEmojiStickerSetThumbnail
- Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
- SetGameScore
- Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
- SetManagedBotAccessSettings
- Use this method to change the access settings of a managed bot. Returns True on success.
- SetMessageReaction
- Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.
- SetMyCommands
- Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
- SetMyDefaultAdministratorRights
- Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.
- SetMyDescription
- Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
- SetMyName
- Use this method to change the bot's name. Returns True on success.
- SetMyProfilePhoto
- Changes the profile photo of the bot. Returns True on success.
- SetMyShortDescription
- Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.
- SetPassportDataErrors
- Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
- SetStickerEmojiList
- Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
- SetStickerKeywords
- Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
- SetStickerMaskPosition
- Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.
- SetStickerPositionInSet
- Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
- SetStickerSetThumbnail
- Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.
- SetStickerSetTitle
- Use this method to set the title of a created sticker set. Returns True on success.
- SetUserEmojiStatus
- Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.
- SetWebhook
- Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request (a request with response HTTP status code different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success.
- StopMessageLiveLocation
- Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
- StopPoll
- Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
- TelegramMethod
- TransferBusinessAccountStars
- Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.
- TransferGift
- Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.
- UnbanChatMember
- Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
- UnbanChatSenderChat
- Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
- UnhideGeneralForumTopic
- Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
- UnpinAllChatMessages
- Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.
- UnpinAllForumTopicMessages
- Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
- UnpinAllGeneralForumTopicMessages
- Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
- UnpinChatMessage
- Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.
- UpgradeGift
- Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.
- UploadStickerFile
- Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.
- VerifyChat
- Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.
- VerifyUser
- Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.