# Telegram Bot API > The Bot API is an HTTP-based interface for developing Telegram bots. Source: https://core.telegram.org/bots/api Snapshot of the supplied Markdown, not a live reference. Read the relevant section and follow its local links. ## Full reference - [Complete documentation](llms-full.txt): All sections in one file. ## Recent changes - [Recent changes](sections/recent-changes.md): Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk - [November 9, 2026](sections/november-9-2026.md): Bot API 10.4 - [August 24, 2026](sections/august-24-2026.md): Bot API 10.3 - [July 14, 2026](sections/july-14-2026.md): Bot API 10.2 ## Authorizing your bot - [Authorizing your bot](sections/authorizing-your-bot.md): Each bot is given a unique authentication token when it is created. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, but we'll use simply in this d ## Making requests - [Making requests](sections/making-requests.md): All queries to the Telegram Bot API must be served over HTTPS and need to be presented in this form: https://api.telegram.org/bot/METHODNAME. Like this for example: - [Making requests when getting updates](sections/making-requests-when-getting-updates.md): If you're using webhooks, you can perform a request to the Bot API while sending an answer to the webhook. Use either application/json or application/x-www-form-urlencoded or multi ## Using a Local Bot API Server - [Using a Local Bot API Server](sections/using-a-local-bot-api-server.md): The Bot API server source code is available at telegram-bot-api. You can run it locally and send the requests to your own server instead of https://api.telegram.org. If you switch - [Do I need a Local Bot API Server](sections/do-i-need-a-local-bot-api-server.md): The majority of bots will be OK with the default configuration, running on our servers. But if you feel that you need one of these features, you're welcome to switch to your own at ## Getting updates - [Getting updates](sections/getting-updates.md): There are two mutually exclusive ways of receiving updates for your bot - the getUpdates method on one hand and webhooks on the other. Incoming updates are stored on the server unt - [Update](sections/update.md): This object represents an incoming update. - [getUpdates](sections/getupdates.md): Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects. - [setWebhook](sections/setwebhook.md): 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 - [deleteWebhook](sections/deletewebhook.md): Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. - [getWebhookInfo](sections/getwebhookinfo.md): 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 - [WebhookInfo](sections/webhookinfo.md): Describes the current status of a webhook. ## Available types - [Available types](sections/available-types.md): All types used in the Bot API responses are represented as JSON-objects. - [User](sections/user.md): This object represents a Telegram user or bot. - [Chat](sections/chat.md): This object represents a chat. - [ChatFullInfo](sections/chatfullinfo.md): This object contains full information about a chat. - [Message](sections/message.md): This object represents a message. - [MessageId](sections/messageid.md): This object represents a unique message identifier. - [InaccessibleMessage](sections/inaccessiblemessage.md): This object describes a message that was deleted or is otherwise inaccessible to the bot. - [MaybeInaccessibleMessage](sections/maybeinaccessiblemessage.md): This object describes a message that can be inaccessible to the bot. It can be one of - [MessageEntity](sections/messageentity.md): This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. - [TextQuote](sections/textquote.md): This object contains information about the quoted part of a message that is replied to by the given message. - [ExternalReplyInfo](sections/externalreplyinfo.md): This object contains information about a message that is being replied to, which may come from another chat or forum topic. - [ReplyParameters](sections/replyparameters.md): Describes reply parameters for the message that is being sent. - [EphemeralMessageParameters](sections/ephemeralmessageparameters.md) - [MessageOrigin](sections/messageorigin.md): This object describes the origin of a message. It can be one of - [MessageOriginUser](sections/messageoriginuser.md): The message was originally sent by a known user. - [MessageOriginHiddenUser](sections/messageoriginhiddenuser.md): The message was originally sent by an unknown user. - [MessageOriginChat](sections/messageoriginchat.md): The message was originally sent on behalf of a chat to a group chat. - [MessageOriginChannel](sections/messageoriginchannel.md): The message was originally sent to a channel chat. - [PhotoSize](sections/photosize.md): This object represents one size of a photo or a file / sticker thumbnail. - [Animation](sections/animation.md): This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). - [Audio](sections/audio.md): This object represents an audio file to be treated as music by the Telegram clients. - [Document](sections/document.md): This object represents a general file (as opposed to photos, voice messages and audio files). - [LivePhoto](sections/livephoto.md): This object represents a live photo. - [Story](sections/story.md): This object represents a story. - [VideoQuality](sections/videoquality.md): This object represents a video file of a specific quality. - [Video](sections/video.md): This object represents a video file. - [VideoNote](sections/videonote.md): This object represents a video message. - [Voice](sections/voice.md): This object represents a voice note. - [Widget](sections/widget.md): This object describes an HTML widget. - [PaidMediaInfo](sections/paidmediainfo.md): Describes the paid media added to a message. - [PaidMedia](sections/paidmedia.md): This object describes paid media. Currently, it can be one of - [PaidMediaLivePhoto](sections/paidmedialivephoto.md): The paid media is a live photo. - [PaidMediaPhoto](sections/paidmediaphoto.md): The paid media is a photo. - [PaidMediaPreview](sections/paidmediapreview.md): The paid media isn't available before the payment. - [PaidMediaVideo](sections/paidmediavideo.md): The paid media is a video. - [Contact](sections/contact.md): This object represents a phone contact. - [Dice](sections/dice.md): This object represents an animated emoji that displays a random value. - [Link](sections/link.md): Represents an HTTP link. - [PollMedia](sections/pollmedia.md): At most one of the optional fields can be present in any given object. - [InputPollMedia](sections/inputpollmedia.md): This object represents the content of a poll description or a quiz explanation to be sent. It should be one of - [InputPollOptionMedia](sections/inputpolloptionmedia.md): This object represents the content of a poll option to be sent. It should be one of - [PollOption](sections/polloption.md): This object contains information about one answer option in a poll. - [InputPollOption](sections/inputpolloption.md): This object contains information about one answer option in a poll to be sent. - [PollAnswer](sections/pollanswer.md): This object represents an answer of a user in a non-anonymous poll. - [Poll](sections/poll.md): This object contains information about a poll. - [ChecklistTask](sections/checklisttask.md): Describes a task in a checklist. - [Checklist](sections/checklist.md): Describes a checklist. - [InputChecklistTask](sections/inputchecklisttask.md): Describes a task to add to a checklist. - [InputChecklist](sections/inputchecklist.md): Describes a checklist to create. - [Location](sections/location.md): This object represents a point on the map. - [Venue](sections/venue.md): This object represents a venue. - [WebAppData](sections/webappdata.md): Describes data sent from a Web App to the bot. - [ProximityAlertTriggered](sections/proximityalerttriggered.md): This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user. - [MessageAutoDeleteTimerChanged](sections/messageautodeletetimerchanged.md): This object represents a service message about a change in auto-delete timer settings. - [ManagedBotCreated](sections/managedbotcreated.md): This object contains information about the bot that was created to be managed by the current bot. - [ManagedBotUpdated](sections/managedbotupdated.md): This object contains information about the creation, token update, or owner update of a bot that is managed by the current bot. - [BotSubscriptionUpdated](sections/botsubscriptionupdated.md): This object contains information about changes to a user payment subscription toward the current bot. - [MessageGenerationStopped](sections/messagegenerationstopped.md): This object describes an update about a user stopping message generation. - [PollOptionAdded](sections/polloptionadded.md): Describes a service message about an option added to a poll. - [PollOptionDeleted](sections/polloptiondeleted.md): Describes a service message about an option deleted from a poll. - [ChatBoostAdded](sections/chatboostadded.md): This object represents a service message about a user boosting a chat. - [BackgroundFill](sections/backgroundfill.md): This object describes the way a background is filled based on the selected colors. Currently, it can be one of - [BackgroundFillSolid](sections/backgroundfillsolid.md): The background is filled using the selected color. - [BackgroundFillGradient](sections/backgroundfillgradient.md): The background is a gradient fill. - [BackgroundFillFreeformGradient](sections/backgroundfillfreeformgradient.md): The background is a freeform gradient that rotates after every message in the chat. - [BackgroundType](sections/backgroundtype.md): This object describes the type of a background. Currently, it can be one of - [BackgroundTypeFill](sections/backgroundtypefill.md): The background is automatically filled based on the selected colors. - [BackgroundTypeWallpaper](sections/backgroundtypewallpaper.md): The background is a wallpaper in the JPEG format. - [BackgroundTypePattern](sections/backgroundtypepattern.md): The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user. - [BackgroundTypeChatTheme](sections/backgroundtypechattheme.md): The background is taken directly from a built-in chat theme. - [ChatBackground](sections/chatbackground.md): This object represents a chat background. - [ChecklistTasksDone](sections/checklisttasksdone.md): Describes a service message about checklist tasks marked as done or not done. - [ChecklistTasksAdded](sections/checklisttasksadded.md): Describes a service message about tasks added to a checklist. - [CommunityChatAdded](sections/communitychatadded.md): Describes a service message about a chat or a bot being added to a community. - [CommunityChatJoined](sections/communitychatjoined.md): Describes a service message about a chat being joined by a user from a community. - [CommunityChatRemoved](sections/communitychatremoved.md): Describes a service message about a chat or a bot being removed from a community. Currently holds no information. - [ForumTopicCreated](sections/forumtopiccreated.md): This object represents a service message about a new forum topic created in the chat. - [ForumTopicClosed](sections/forumtopicclosed.md): This object represents a service message about a forum topic closed in the chat. Currently holds no information. - [ForumTopicEdited](sections/forumtopicedited.md): This object represents a service message about an edited forum topic. - [ForumTopicReopened](sections/forumtopicreopened.md): This object represents a service message about a forum topic reopened in the chat. Currently holds no information. - [GeneralForumTopicHidden](sections/generalforumtopichidden.md): This object represents a service message about General forum topic hidden in the chat. Currently holds no information. - [GeneralForumTopicUnhidden](sections/generalforumtopicunhidden.md): This object represents a service message about General forum topic unhidden in the chat. Currently holds no information. - [SharedUser](sections/shareduser.md): This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button. - [UsersShared](sections/usersshared.md): This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button. - [ChatShared](sections/chatshared.md): This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button. - [WriteAccessAllowed](sections/writeaccessallowed.md): This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an expl - [VideoChatScheduled](sections/videochatscheduled.md): This object represents a service message about a video chat scheduled in the chat. - [VideoChatStarted](sections/videochatstarted.md): This object represents a service message about a video chat started in the chat. Currently holds no information. - [VideoChatEnded](sections/videochatended.md): This object represents a service message about a video chat ended in the chat. - [VideoChatParticipantsInvited](sections/videochatparticipantsinvited.md): This object represents a service message about new members invited to a video chat. - [PaidMessagePriceChanged](sections/paidmessagepricechanged.md): Describes a service message about a change in the price of paid messages within a chat. - [DirectMessagePriceChanged](sections/directmessagepricechanged.md): Describes a service message about a change in the price of direct messages sent to a channel chat. - [SuggestedPostApproved](sections/suggestedpostapproved.md): Describes a service message about the approval of a suggested post. - [SuggestedPostApprovalFailed](sections/suggestedpostapprovalfailed.md): Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval. - [SuggestedPostDeclined](sections/suggestedpostdeclined.md): Describes a service message about the rejection of a suggested post. - [SuggestedPostPaid](sections/suggestedpostpaid.md): Describes a service message about a successful payment for a suggested post. - [SuggestedPostRefunded](sections/suggestedpostrefunded.md): Describes a service message about a payment refund for a suggested post. - [PaidMessagesWaived](sections/paidmessageswaived.md): Describes a service message about the sender of the message using a link of the other user, which allows sending messages to the user without paying Telegram Stars. Currently holds - [TonWalletTransfer](sections/tonwallettransfer.md): Describes a service message about a transfer with a TON wallet. - [GiveawayCreated](sections/giveawaycreated.md): This object represents a service message about the creation of a scheduled giveaway. - [Giveaway](sections/giveaway.md): This object represents a message about a scheduled giveaway. - [GiveawayWinners](sections/giveawaywinners.md): This object represents a message about the completion of a giveaway with public winners. - [GiveawayCompleted](sections/giveawaycompleted.md): This object represents a service message about the completion of a giveaway without public winners. - [LinkPreviewOptions](sections/linkpreviewoptions.md): Describes the options used for link preview generation. - [SuggestedPostPrice](sections/suggestedpostprice.md): Describes the price of a suggested post. - [SuggestedPostInfo](sections/suggestedpostinfo.md): Contains information about a suggested post. - [SuggestedPostParameters](sections/suggestedpostparameters.md): Contains parameters of a post that is being suggested by the bot. - [DirectMessagesTopic](sections/directmessagestopic.md): Describes a topic of a direct messages chat. - [UserProfilePhotos](sections/userprofilephotos.md): This object represent a user's profile pictures. - [UserProfileAudios](sections/userprofileaudios.md): This object represents the audios displayed on a user's profile. - [File](sections/file.md): This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot/. It is guaranteed that the link wi - [WebAppInfo](sections/webappinfo.md): Describes a Web App. - [ReplyKeyboardMarkup](sections/replykeyboardmarkup.md): This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a busi - [KeyboardButton](sections/keyboardbutton.md): This object represents one button of the reply keyboard. At most one of the fields other than text, icon\custom\emoji\id, and style must be used to specify the type of the button. - [KeyboardButtonRequestUsers](sections/keyboardbuttonrequestusers.md): This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More abo - [KeyboardButtonRequestChat](sections/keyboardbuttonrequestchat.md): This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot - [KeyboardButtonRequestManagedBot](sections/keyboardbuttonrequestmanagedbot.md): This object defines the parameters for the creation of a managed bot. Information about the created bot will be shared with the bot using the update managed\bot and a Message with - [KeyboardButtonPollType](sections/keyboardbuttonpolltype.md): This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. - [ReplyKeyboardRemove](sections/replykeyboardremove.md): Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displa - [InlineKeyboardMarkup](sections/inlinekeyboardmarkup.md): This object represents an inline keyboard that appears right next to the message it belongs to. - [InlineKeyboardButton](sections/inlinekeyboardbutton.md): This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon\custom\emoji\id, and style must be used to specify the type of the button. - [LoginUrl](sections/loginurl.md): This object represents a parameter of the inline keyboard button used to automatically authorize a user. It serves as a great replacement for the Telegram Login Widget when the use - [SwitchInlineQueryChosenChat](sections/switchinlinequerychosenchat.md): This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query. - [CopyTextButton](sections/copytextbutton.md): This object represents an inline keyboard button that copies specified text to the clipboard. - [DisabledButton](sections/disabledbutton.md): This object represents a disabled button which does nothing. Currently holds no information. - [CallbackQuery](sections/callbackquery.md): This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, t - [WidgetQueryType](sections/widgetquerytype.md): This object describes the type of a query from a widget. Currently, it can be one of - [WidgetQueryTypeData](sections/widgetquerytypedata.md): The query contains data for the bot. - [WidgetQueryTypeSignData](sections/widgetquerytypesigndata.md): The query contains data signed by a TON wallet of the user who sent the query. The data is signed for the domain bot, where is the identifier of the bot. - [WidgetQueryTypeSentTransaction](sections/widgetquerytypesenttransaction.md): The query notifies the bot about a transaction sent from a TON wallet of the user who sent the query. - [WidgetQueryWallet](sections/widgetquerywallet.md): This object describes a TON wallet of the user, which is used in a query from a widget. - [WidgetQuery](sections/widgetquery.md): This object represents an incoming query from a widget in a message sent by the bot or via the bot. Use answerWidgetQuery to answer the query. Each user can send at most 5 queries - [SharedWidgetQuery](sections/sharedwidgetquery.md): This object represents an incoming query from a forwarded message with a shared widget created by the bot. Use answerWidgetQuery to answer the query. Each user can send at most 5 q - [ForceReply](sections/forcereply.md): Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This - [Community](sections/community.md): Represents a community (a group of chats). - [ChatPhoto](sections/chatphoto.md): This object represents a chat photo. - [ChatInviteLink](sections/chatinvitelink.md): Represents an invite link for a chat. - [ChatAdministratorRights](sections/chatadministratorrights.md): Represents the rights of an administrator in a chat. - [ChatMemberUpdated](sections/chatmemberupdated.md): This object represents changes in the status of a chat member. - [ChatMember](sections/chatmember.md): This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported: - [ChatMemberOwner](sections/chatmemberowner.md): Represents a chat member that owns the chat and has all administrator privileges. - [ChatMemberAdministrator](sections/chatmemberadministrator.md): Represents a chat member that has some additional privileges. - [ChatMemberMember](sections/chatmembermember.md): Represents a chat member that has no additional privileges or restrictions. - [ChatMemberRestricted](sections/chatmemberrestricted.md): Represents a chat member that is under certain restrictions in the chat. Supergroups only. - [ChatMemberLeft](sections/chatmemberleft.md): Represents a chat member that isn't currently a member of the chat, but may join it themselves. - [ChatMemberBanned](sections/chatmemberbanned.md): Represents a chat member that was banned in the chat and can't return to the chat or view chat messages. - [ChatJoinRequest](sections/chatjoinrequest.md): Represents a join request sent to a chat. - [ChatPermissions](sections/chatpermissions.md): Describes actions that a non-administrator user is allowed to take in a chat. - [Birthdate](sections/birthdate.md): Describes the birthdate of a user. - [BusinessIntro](sections/businessintro.md): Contains information about the start page settings of a Telegram Business account. - [BusinessLocation](sections/businesslocation.md): Contains information about the location of a Telegram Business account. - [BusinessOpeningHoursInterval](sections/businessopeninghoursinterval.md): Describes an interval of time during which a business is open. - [BusinessOpeningHours](sections/businessopeninghours.md): Describes the opening hours of a business. - [UserRating](sections/userrating.md): This object describes the rating of a user based on their Telegram Star spendings. - [AreaPosition](sections/areaposition.md): Describes the position of a rectangle area on a story media or a TON wallet card. - [TonNft](sections/tonnft.md): This object represents an NFT in the TON blockchain. - [TonNftAttribute](sections/tonnftattribute.md): This object represents an attribute of an NFT in the TON blockchain. - [TonWalletCardSticker](sections/tonwalletcardsticker.md): This object describes a sticker on a TON wallet card. - [TonWalletCard](sections/tonwalletcard.md): This object describes a TON wallet card, which is shown on the profile page of a user to everyone. - [EmojiType](sections/emojitype.md): This object describes an emoji. Currently, it can be one of - [EmojiTypeEmoji](sections/emojitypeemoji.md): A regular emoji. - [EmojiTypeCustomEmoji](sections/emojitypecustomemoji.md): A custom emoji. - [ChatShareTheme](sections/chatsharetheme.md): This object describes the theme of the screen for sharing a link to a user or a chat. Currently, it can be one of - [ChatShareThemeEmoji](sections/chatsharethemeemoji.md): The theme with emoji placed on a background. - [ChatShareThemeUniqueGift](sections/chatsharethemeuniquegift.md): The theme based on a unique gift owned by the user or the chat. - [ChatShareThemeBackdrops](sections/chatsharethemebackdrops.md): This object contains a list of backdrops, which can be used as the background of a theme of the screen for sharing a link to a user or a chat. - [ChatShareThemeBackdrop](sections/chatsharethemebackdrop.md): This object describes a backdrop, which can be used as the background of a theme of the screen for sharing a link to a user or a chat. - [LocationAddress](sections/locationaddress.md): Describes the physical address of a location. - [StoryAreaType](sections/storyareatype.md): Describes the type of a clickable area on a story. Currently, it can be one of - [StoryAreaTypeLocation](sections/storyareatypelocation.md): Describes a story area pointing to a location. Currently, a story can have up to 10 location areas. - [StoryAreaTypeSuggestedReaction](sections/storyareatypesuggestedreaction.md): Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas. - [StoryAreaTypeLink](sections/storyareatypelink.md): Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas. - [StoryAreaTypeWeather](sections/storyareatypeweather.md): Describes a story area containing weather information. Currently, a story can have up to 3 weather areas. - [StoryAreaTypeUniqueGift](sections/storyareatypeuniquegift.md): Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area. - [StoryArea](sections/storyarea.md): Describes a clickable area on a story media. - [ChatLocation](sections/chatlocation.md): Represents a location to which a chat is connected. - [ReactionType](sections/reactiontype.md): This object describes the type of a reaction. Currently, it can be one of - [ReactionTypeEmoji](sections/reactiontypeemoji.md): The reaction is based on an emoji. - [ReactionTypeCustomEmoji](sections/reactiontypecustomemoji.md): The reaction is based on a custom emoji. - [ReactionTypePaid](sections/reactiontypepaid.md): The reaction is paid. - [ReactionCount](sections/reactioncount.md): Represents a reaction added to a message along with the number of times it was added. - [MessageReactionUpdated](sections/messagereactionupdated.md): This object represents a change of a reaction on a message performed by a user. - [MessageReactionCountUpdated](sections/messagereactioncountupdated.md): This object represents reaction changes on a message with anonymous reactions. - [ForumTopic](sections/forumtopic.md): This object represents a forum topic. - [GiftBackground](sections/giftbackground.md): This object describes the background of a gift. - [Gift](sections/gift.md): This object represents a gift that can be sent by the bot. - [Gifts](sections/gifts.md): This object represent a list of gifts. - [UniqueGiftModel](sections/uniquegiftmodel.md): This object describes the model of a unique gift. - [UniqueGiftSymbol](sections/uniquegiftsymbol.md): This object describes the symbol shown on the pattern of a unique gift. - [UniqueGiftBackdropColors](sections/uniquegiftbackdropcolors.md): This object describes the colors of the backdrop of a unique gift. - [UniqueGiftBackdrop](sections/uniquegiftbackdrop.md): This object describes the backdrop of a unique gift. - [UniqueGiftColors](sections/uniquegiftcolors.md): This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift. - [UniqueGift](sections/uniquegift.md): This object describes a unique gift that was upgraded from a regular gift. - [GiftInfo](sections/giftinfo.md): Describes a service message about a regular gift that was sent or received. - [UniqueGiftInfo](sections/uniquegiftinfo.md): Describes a service message about a unique gift that was sent or received. - [OwnedGift](sections/ownedgift.md): This object describes a gift received and owned by a user or a chat. Currently, it can be one of - [OwnedGiftRegular](sections/ownedgiftregular.md): Describes a regular gift owned by a user or a chat. - [OwnedGiftUnique](sections/ownedgiftunique.md): Describes a unique gift received and owned by a user or a chat. - [OwnedGifts](sections/ownedgifts.md): Contains the list of gifts received and owned by a user or a chat. - [BotAccessSettings](sections/botaccesssettings.md): This object describes the access settings of a bot. - [AcceptedGiftTypes](sections/acceptedgifttypes.md): This object describes the types of gifts that can be gifted to a user or a chat. - [StarAmount](sections/staramount.md): Describes an amount of Telegram Stars. - [BotCommand](sections/botcommand.md): This object represents a bot command. - [BotCommandScope](sections/botcommandscope.md): This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: - [Determining list of commands](sections/determining-list-of-commands.md): The following algorithm is used to determine the list of commands for a particular user viewing the bot menu. The first list of commands which is set is returned: - [BotCommandScopeDefault](sections/botcommandscopedefault.md): Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user. - [BotCommandScopeAllPrivateChats](sections/botcommandscopeallprivatechats.md): Represents the scope of bot commands, covering all private chats. - [BotCommandScopeAllGroupChats](sections/botcommandscopeallgroupchats.md): Represents the scope of bot commands, covering all group and supergroup chats. - [BotCommandScopeAllChatAdministrators](sections/botcommandscopeallchatadministrators.md): Represents the scope of bot commands, covering all group and supergroup chat administrators. - [BotCommandScopeChat](sections/botcommandscopechat.md): Represents the scope of bot commands, covering a specific chat. - [BotCommandScopeChatAdministrators](sections/botcommandscopechatadministrators.md): Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat. - [BotCommandScopeChatMember](sections/botcommandscopechatmember.md): Represents the scope of bot commands, covering a specific member of a group or supergroup chat. - [BotName](sections/botname.md): This object represents the bot's name. - [BotDescription](sections/botdescription.md): This object represents the bot's description. - [BotShortDescription](sections/botshortdescription.md): This object represents the bot's short description. - [MenuButton](sections/menubutton.md): This object describes the bot's menu button in a private chat. It should be one of - [MenuButtonCommands](sections/menubuttoncommands.md): Represents a menu button, which opens the bot's list of commands. - [MenuButtonWebApp](sections/menubuttonwebapp.md): Represents a menu button, which launches a Web App. - [MenuButtonDefault](sections/menubuttondefault.md): Describes that no specific value for the menu button was set. - [ChatBoostSource](sections/chatboostsource.md): This object describes the source of a chat boost. It can be one of - [ChatBoostSourcePremium](sections/chatboostsourcepremium.md): The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user. - [ChatBoostSourceGiftCode](sections/chatboostsourcegiftcode.md): The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium - [ChatBoostSourceGiveaway](sections/chatboostsourcegiveaway.md): The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscr - [ChatBoost](sections/chatboost.md): This object contains information about a chat boost. - [ChatBoostUpdated](sections/chatboostupdated.md): This object represents a boost added to a chat or changed. - [ChatBoostRemoved](sections/chatboostremoved.md): This object represents a boost removed from a chat. - [ChatOwnerLeft](sections/chatownerleft.md): Describes a service message about the chat owner leaving the chat. - [ChatOwnerChanged](sections/chatownerchanged.md): Describes a service message about an ownership change in the chat. - [UserChatBoosts](sections/userchatboosts.md): This object represents a list of boosts added to a chat by a user. - [BusinessBotRights](sections/businessbotrights.md): Represents the rights of a business bot. - [BusinessConnection](sections/businessconnection.md): Describes the connection of the bot with a business account. - [BusinessMessagesDeleted](sections/businessmessagesdeleted.md): This object is received when messages are deleted from a connected business account. - [SentWebAppMessage](sections/sentwebappmessage.md): Describes an inline message sent by a Web App on behalf of a user. - [SentGuestMessage](sections/sentguestmessage.md): Describes an inline message sent by a guest bot. - [PreparedInlineMessage](sections/preparedinlinemessage.md): Describes an inline message to be sent by a user of a Mini App. - [PreparedKeyboardButton](sections/preparedkeyboardbutton.md): Describes a keyboard button to be used by a user of a Mini App. - [ResponseParameters](sections/responseparameters.md): Describes why a request was unsuccessful. - [InputMedia](sections/inputmedia.md): This object represents the content of a media message to be sent. It should be one of - [InputMediaAnimation](sections/inputmediaanimation.md): Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. - [InputMediaAudio](sections/inputmediaaudio.md): Represents an audio file to be treated as music to be sent. - [InputMediaDocument](sections/inputmediadocument.md): Represents a general file to be sent. - [InputMediaLink](sections/inputmedialink.md): Represents an HTTP link to be sent. - [InputMediaLivePhoto](sections/inputmedialivephoto.md): Represents a live photo to be sent. - [InputMediaLocation](sections/inputmedialocation.md): Represents a location to be sent. - [InputMediaPhoto](sections/inputmediaphoto.md): Represents a photo to be sent. - [InputMediaSticker](sections/inputmediasticker.md): Represents a sticker file to be sent. - [InputMediaVenue](sections/inputmediavenue.md): Represents a venue to be sent. - [InputMediaVideo](sections/inputmediavideo.md): Represents a video to be sent. - [InputMediaVoiceNote](sections/inputmediavoicenote.md): Represents a voice message file to be sent. - [InputFile](sections/inputfile.md): This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser. - [InputPaidMedia](sections/inputpaidmedia.md): This object describes the paid media to be sent. Currently, it can be one of - [InputPaidMediaLivePhoto](sections/inputpaidmedialivephoto.md): The paid media to send is a live photo. - [InputPaidMediaPhoto](sections/inputpaidmediaphoto.md): The paid media to send is a photo. - [InputPaidMediaVideo](sections/inputpaidmediavideo.md): The paid media to send is a video. - [InputProfilePhoto](sections/inputprofilephoto.md): This object describes a profile photo to set. Currently, it can be one of - [InputProfilePhotoStatic](sections/inputprofilephotostatic.md): A static profile photo in the .JPG format. - [InputProfilePhotoAnimated](sections/inputprofilephotoanimated.md): An animated profile photo in the MPEG4 format. - [InputStoryContent](sections/inputstorycontent.md): This object describes the content of a story to post. Currently, it can be one of - [InputStoryContentPhoto](sections/inputstorycontentphoto.md): Describes a photo to post as a story. - [InputStoryContentVideo](sections/inputstorycontentvideo.md): Describes a video to post as a story. - [Sending files](sections/sending-files.md): There are three ways to send files (photos, stickers, audio, media, etc.): - [Accent colors](sections/accent-colors.md): Colors with identifiers 0 (red), 1 (orange), 2 (purple/violet), 3 (green), 4 (cyan), 5 (blue), 6 (pink) can be customized by app themes. Additionally, the following colors in RGB f - [Profile accent colors](sections/profile-accent-colors.md): Currently, the following colors in RGB format are in use for profile backgrounds. - [Inline mode objects](sections/inline-mode-objects.md): Objects and methods used in the inline mode are described in the Inline mode section. ## Available methods - [Available methods](sections/available-methods.md): All methods in the Bot API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multi - [getMe](sections/getme.md): 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. - [logOut](sections/logout.md): 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 - [close](sections/close.md): 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 - [sendMessage](sections/sendmessage.md): Use this method to send text messages. On success, the sent Message is returned. - [Formatting options](sections/formatting-options.md): The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, spoiler text, block quotations as well as inline links and pre-formatted co - [Ephemeral Messages and Commands](sections/ephemeral-messages-and-commands.md): Ephemeral interactions allow a bot and an individual member of a group or supergroup chat to communicate privately on the public timeline without cluttering the chat for other memb - [Paid Broadcasts](sections/paid-broadcasts.md): By default, all bots are able to broadcast up to 30 messages per second to their users. Developers can increase this limit by enabling Paid Broadcasts in @BotFather - allowing thei - [forwardMessage](sections/forwardmessage.md): 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](sections/forwardmessages.md): 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 protec - [copyMessage](sections/copymessage.md): Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, invoice messages, and widget messages can't be co - [copyMessages](sections/copymessages.md): 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 - [sendPhoto](sections/sendphoto.md): Use this method to send photos. On success, the sent Message is returned. - [sendLivePhoto](sections/sendlivephoto.md): Use this method to send live photos. On success, the sent Message is returned. - [sendAudio](sections/sendaudio.md): 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 i - [sendDocument](sections/senddocument.md): 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 - [sendVideo](sections/sendvideo.md): 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 sen - [sendAnimation](sections/sendanimation.md): 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 - [sendVoice](sections/sendvoice.md): 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 - [sendVideoNote](sections/sendvideonote.md): Use this method to send a rounded square MPEG4 video of up to 1 minute long. On success, the sent Message is returned. - [sendWidget](sections/sendwidget.md): Use this method to send a message with an HTML widget. Currently, in the production environment, widgets can be sent only to private chats, and sent widgets automatically have prot - [sendSharedWidget](sections/sendsharedwidget.md): Use this method to send again a shared widget created by the bot. Currently, in the production environment, widgets can be sent only to private chats, and sent widgets automaticall - [sendPaidMedia](sections/sendpaidmedia.md): Use this method to send paid media. On success, the sent Message is returned. - [sendMediaGroup](sections/sendmediagroup.md): 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 - [sendLocation](sections/sendlocation.md): Use this method to send point on the map. On success, the sent Message is returned. - [sendVenue](sections/sendvenue.md): Use this method to send information about a venue. On success, the sent Message is returned. - [sendContact](sections/sendcontact.md): Use this method to send phone contacts. On success, the sent Message is returned. - [sendPoll](sections/sendpoll.md): Use this method to send a native poll. On success, the sent Message is returned. - [sendChecklist](sections/sendchecklist.md): Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned. - [sendDice](sections/senddice.md): Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. - [sendMessageDraft](sections/sendmessagedraft.md): 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 - on - [sendChatAction](sections/sendchataction.md): 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, Telegra - [setMessageReaction](sections/setmessagereaction.md): 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 g - [getUserProfilePhotos](sections/getuserprofilephotos.md): Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. - [getUserProfileAudios](sections/getuserprofileaudios.md): Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object. - [setUserEmojiStatus](sections/setuseremojistatus.md): 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. - [getFile](sections/getfile.md): 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 re - [banChatMember](sections/banchatmember.md): 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 inv - [unbanChatMember](sections/unbanchatmember.md): 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 - [restrictChatMember](sections/restrictchatmember.md): 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 Tru - [promoteChatMember](sections/promotechatmember.md): 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 - [setChatAdministratorCustomTitle](sections/setchatadministratorcustomtitle.md): Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success. - [setChatMemberTag](sections/setchatmembertag.md): 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 admini - [banChatSenderChat](sections/banchatsenderchat.md): 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 thei - [unbanChatSenderChat](sections/unbanchatsenderchat.md): 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 - [setChatPermissions](sections/setchatpermissions.md): 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\membe - [exportChatInviteLink](sections/exportchatinvitelink.md): 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 an - [createChatInviteLink](sections/createchatinvitelink.md): 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. Th - [editChatInviteLink](sections/editchatinvitelink.md): 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 righ - [createChatSubscriptionInviteLink](sections/createchatsubscriptioninvitelink.md): 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 editCh - [editChatSubscriptionInviteLink](sections/editchatsubscriptioninvitelink.md): 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 ChatInviteLi - [revokeChatInviteLink](sections/revokechatinvitelink.md): 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 - [approveChatJoinRequest](sections/approvechatjoinrequest.md): 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 o - [declineChatJoinRequest](sections/declinechatjoinrequest.md): 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 o - [answerChatJoinRequestQuery](sections/answerchatjoinrequestquery.md): Use this method to process a received chat join request query. Returns True on success. - [sendChatJoinRequestWebApp](sections/sendchatjoinrequestwebapp.md): Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Call answerChatJoinRequestQuery to resolve the join req - [setChatPhoto](sections/setchatphoto.md): 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 - [deleteChatPhoto](sections/deletechatphoto.md): 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 admin - [setChatTitle](sections/setchattitle.md): 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 appropriat - [setChatDescription](sections/setchatdescription.md): 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 adminis - [pinChatMessage](sections/pinchatmessage.md): 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, t - [unpinChatMessage](sections/unpinchatmessage.md): 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 bo - [unpinAllChatMessages](sections/unpinallchatmessages.md): 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. - [leaveChat](sections/leavechat.md): Use this method for your bot to leave a group, supergroup or channel. Returns True on success. - [getChat](sections/getchat.md): Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success. - [getChatAdministrators](sections/getchatadministrators.md): Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects. - [getChatMemberCount](sections/getchatmembercount.md): Use this method to get the number of members in a chat. Returns Integer on success. - [getChatMember](sections/getchatmember.md): 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 - [getChatShareThemeBackdrops](sections/getchatsharethemebackdrops.md): Use this method to get the list of backdrops, which can be used as the background of a theme of the screen for sharing a link to a user or a chat. Requires no parameters. Returns a - [getUserPersonalChatMessages](sections/getuserpersonalchatmessages.md): 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 return - [setChatStickerSet](sections/setchatstickerset.md): 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. U - [deleteChatStickerSet](sections/deletechatstickerset.md): 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. U - [getForumTopicIconStickers](sections/getforumtopiciconstickers.md): 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. - [createForumTopic](sections/createforumtopic.md): 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 t - [editForumTopic](sections/editforumtopic.md): 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 - [closeForumTopic](sections/closeforumtopic.md): 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 r - [reopenForumTopic](sections/reopenforumtopic.md): 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 - [deleteForumTopic](sections/deleteforumtopic.md): 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 ad - [unpinAllForumTopicMessages](sections/unpinallforumtopicmessages.md): 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 - [editGeneralForumTopic](sections/editgeneralforumtopic.md): 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\topic - [closeGeneralForumTopic](sections/closegeneralforumtopic.md): 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 admin - [reopenGeneralForumTopic](sections/reopengeneralforumtopic.md): 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 adm - [hideGeneralForumTopic](sections/hidegeneralforumtopic.md): 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 administra - [unhideGeneralForumTopic](sections/unhidegeneralforumtopic.md): 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 administ - [unpinAllGeneralForumTopicMessages](sections/unpinallgeneralforumtopicmessages.md): 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 admi - [answerCallbackQuery](sections/answercallbackquery.md): 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 al - [answerWidgetQuery](sections/answerwidgetquery.md): Use this method to send an answer to a query from a widget. The query must be answered within 15 seconds. The answer is received only by the widget that sent the query and doesn't - [answerGuestQuery](sections/answerguestquery.md): Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned. - [getUserChatBoosts](sections/getuserchatboosts.md): 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. - [getBusinessConnection](sections/getbusinessconnection.md): Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success. - [getManagedBotToken](sections/getmanagedbottoken.md): Use this method to get the token of a managed bot. Returns the token as String on success. - [replaceManagedBotToken](sections/replacemanagedbottoken.md): 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. - [getManagedBotAccessSettings](sections/getmanagedbotaccesssettings.md): Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success. - [setManagedBotAccessSettings](sections/setmanagedbotaccesssettings.md): Use this method to change the access settings of a managed bot. Returns True on success. - [setMyCommands](sections/setmycommands.md): 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. - [deleteMyCommands](sections/deletemycommands.md): 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 - [getMyCommands](sections/getmycommands.md): 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 i - [setMyName](sections/setmyname.md): Use this method to change the bot's name. Returns True on success. - [getMyName](sections/getmyname.md): Use this method to get the current bot name for the given user language. Returns BotName on success. - [setMyDescription](sections/setmydescription.md): 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. - [getMyDescription](sections/getmydescription.md): Use this method to get the current bot description for the given user language. Returns BotDescription on success. - [setMyShortDescription](sections/setmyshortdescription.md): 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 - [getMyShortDescription](sections/getmyshortdescription.md): Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success. - [setMyProfilePhoto](sections/setmyprofilephoto.md): Changes the profile photo of the bot. Returns True on success. - [removeMyProfilePhoto](sections/removemyprofilephoto.md): Removes the profile photo of the bot. Requires no parameters. Returns True on success. - [setChatMenuButton](sections/setchatmenubutton.md): Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success. - [getChatMenuButton](sections/getchatmenubutton.md): 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. - [setMyDefaultAdministratorRights](sections/setmydefaultadministratorrights.md): 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, - [getMyDefaultAdministratorRights](sections/getmydefaultadministratorrights.md): Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success. - [getAvailableGifts](sections/getavailablegifts.md): Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object. - [sendGift](sections/sendgift.md): 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. - [giftPremiumSubscription](sections/giftpremiumsubscription.md): Gifts a Telegram Premium subscription to the given user. Returns True on success. - [verifyUser](sections/verifyuser.md): Verifies a user on behalf of the organization which is represented by the bot. Returns True on success. - [verifyChat](sections/verifychat.md): Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success. - [removeUserVerification](sections/removeuserverification.md): Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success. - [removeChatVerification](sections/removechatverification.md): Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success. - [readBusinessMessage](sections/readbusinessmessage.md): Marks incoming message as read on behalf of a business account. Requires the can\read\messages business bot right. Returns True on success. - [deleteBusinessMessages](sections/deletebusinessmessages.md): 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 - [setBusinessAccountName](sections/setbusinessaccountname.md): Changes the first and last name of a managed business account. Requires the can\change\name business bot right. Returns True on success. - [setBusinessAccountUsername](sections/setbusinessaccountusername.md): Changes the username of a managed business account. Requires the can\change\username business bot right. Returns True on success. - [setBusinessAccountBio](sections/setbusinessaccountbio.md): Changes the bio of a managed business account. Requires the can\change\bio business bot right. Returns True on success. - [setBusinessAccountProfilePhoto](sections/setbusinessaccountprofilephoto.md): Changes the profile photo of a managed business account. Requires the can\edit\profile\photo business bot right. Returns True on success. - [removeBusinessAccountProfilePhoto](sections/removebusinessaccountprofilephoto.md): Removes the current profile photo of a managed business account. Requires the can\edit\profile\photo business bot right. Returns True on success. - [setBusinessAccountGiftSettings](sections/setbusinessaccountgiftsettings.md): 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. - [getBusinessAccountStarBalance](sections/getbusinessaccountstarbalance.md): 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. - [transferBusinessAccountStars](sections/transferbusinessaccountstars.md): 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. - [getBusinessAccountGifts](sections/getbusinessaccountgifts.md): 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. - [getUserGifts](sections/getusergifts.md): Returns the gifts owned and hosted by a user. Returns OwnedGifts on success. - [getChatGifts](sections/getchatgifts.md): Returns the gifts owned by a chat. Returns OwnedGifts on success. - [getUniqueGift](sections/getuniquegift.md): Use this method to get information about a unique gift by its name. Returns a UniqueGift object on success. - [convertGiftToStars](sections/convertgifttostars.md): Converts a given regular gift to Telegram Stars. Requires the can\convert\gifts\to\stars business bot right. Returns True on success. - [upgradeGift](sections/upgradegift.md): 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 t - [transferGift](sections/transfergift.md): 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 pa - [deleteBusinessAccountGift](sections/deletebusinessaccountgift.md): Deletes a regular gift owned by a managed business account without receiving Telegram Stars for it. Requires the can\convert\gifts\to\stars business bot right. The gift can be dele - [postStory](sections/poststory.md): Posts a story on behalf of a managed business account. Requires the can\manage\stories business bot right. Returns Story on success. - [repostStory](sections/repoststory.md): 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 - [editStory](sections/editstory.md): 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. - [deleteStory](sections/deletestory.md): 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. - [answerWebAppQuery](sections/answerwebappquery.md): 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 - [savePreparedInlineMessage](sections/savepreparedinlinemessage.md): Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object. - [savePreparedKeyboardButton](sections/savepreparedkeyboardbutton.md): Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object. - [Inline mode methods](sections/inline-mode-methods.md): Methods and objects used in the inline mode are described in the Inline mode section. ## Updating messages - [Updating messages](sections/updating-messages.md): The following methods allow you to change an existing message in the message history instead of sending a new one with a result of an action. This is most useful for messages with - [editMessageText](sections/editmessagetext.md): 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 t - [editMessageCaption](sections/editmessagecaption.md): 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 busi - [editMessageMedia](sections/editmessagemedia.md): 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 alb - [editMessageLiveLocation](sections/editmessagelivelocation.md): 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 su - [stopMessageLiveLocation](sections/stopmessagelivelocation.md): 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 - [editMessageChecklist](sections/editmessagechecklist.md): Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned. - [editMessageWidgetData](sections/editmessagewidgetdata.md): Use this method to edit data of a widget in a message sent by the bot or via the bot (for inline bots). Public data of a shared widget can be changed at most once per second. On su - [editSharedWidgetData](sections/editsharedwidgetdata.md): Use this method to edit public data of a shared widget created by the bot. A shared widget can be edited at most once per second. On success, True is returned. - [editMessageReplyMarkup](sections/editmessagereplymarkup.md): 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. N - [stopPoll](sections/stoppoll.md): Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned. - [editEphemeralMessageText](sections/editephemeralmessagetext.md): Use this method to edit an ephemeral text or rich message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On succ - [editEphemeralMessageMedia](sections/editephemeralmessagemedia.md): Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On succ - [editEphemeralMessageCaption](sections/editephemeralmessagecaption.md): Use this method to edit the caption of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On su - [editEphemeralMessageReplyMarkup](sections/editephemeralmessagereplymarkup.md): Use this method to edit only the reply markup of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offl - [approveSuggestedPost](sections/approvesuggestedpost.md): 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 - [declineSuggestedPost](sections/declinesuggestedpost.md): 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. Ret - [deleteMessage](sections/deletemessage.md): Use this method to delete a message, including service messages, with the following limitations: - [deleteMessages](sections/deletemessages.md): 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. - [deleteEphemeralMessage](sections/deleteephemeralmessage.md): Use this method to delete an ephemeral message. Note that it is not guaranteed that the user will receive the message deletion event, especially if they are offline. Returns True o - [deleteMessageReaction](sections/deletemessagereaction.md): 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 su - [deleteAllMessageReactions](sections/deleteallmessagereactions.md): 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 righ ## Stickers - [Stickers](sections/stickers.md): The following methods and objects allow your bot to handle stickers and sticker sets. - [Sticker](sections/sticker.md): This object represents a sticker. - [StickerSet](sections/stickerset.md): This object represents a sticker set. - [MaskPosition](sections/maskposition.md): This object describes the position on faces where a mask should be placed by default. - [InputSticker](sections/inputsticker.md): This object describes a sticker to be added to a sticker set. - [sendSticker](sections/sendsticker.md): Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned. - [getStickerSet](sections/getstickerset.md): Use this method to get a sticker set. On success, a StickerSet object is returned. - [getCustomEmojiStickers](sections/getcustomemojistickers.md): Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects. - [uploadStickerFile](sections/uploadstickerfile.md): 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). Ret - [createNewStickerSet](sections/createnewstickerset.md): 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. - [addStickerToSet](sections/addstickertoset.md): 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 su - [setStickerPositionInSet](sections/setstickerpositioninset.md): Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success. - [deleteStickerFromSet](sections/deletestickerfromset.md): Use this method to delete a sticker from a set created by the bot. Returns True on success. - [replaceStickerInSet](sections/replacestickerinset.md): 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 setStickerPosit - [setStickerEmojiList](sections/setstickeremojilist.md): 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](sections/setstickerkeywords.md): 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](sections/setstickermaskposition.md): 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. - [setStickerSetTitle](sections/setstickersettitle.md): Use this method to set the title of a created sticker set. Returns True on success. - [setStickerSetThumbnail](sections/setstickersetthumbnail.md): 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. - [setCustomEmojiStickerSetThumbnail](sections/setcustomemojistickersetthumbnail.md): Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success. - [deleteStickerSet](sections/deletestickerset.md): Use this method to delete a sticker set that was created by the bot. Returns True on success. ## Rich messages - [Rich messages](sections/rich-messages.md): The following methods and objects allow your bot to handle and send rich messages. - [Rich Message Formatting Options](sections/rich-message-formatting-options.md): Rich messages support advanced structured formatting options like headings, lists, tables, media, block quotations, collapsible blocks, footnotes, and formulas. Telegram clients wi - [RichMessage](sections/richmessage.md): Rich formatted message. - [InputRichMessage](sections/inputrichmessage.md): Describes a rich message to be sent. Exactly one of the fields html, markdown, or blocks must be used. - [InputRichMessageMedia](sections/inputrichmessagemedia.md): Describes a media element embedded in an outgoing rich message. - [sendRichMessage](sections/sendrichmessage.md): 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 Me - [sendRichMessageDraft](sections/sendrichmessagedraft.md): 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 - [RichMessageButton](sections/richmessagebutton.md): This object represents a button in a RichMessage. Exactly one of the fields other than text and style must be used to specify the type of the button. - [RichText](sections/richtext.md): This object represents a rich formatted text. Currently, it can be either a String for plain text, an Array of RichText, or any of the following types: - [RichTextBold](sections/richtextbold.md): A bold text. - [RichTextItalic](sections/richtextitalic.md): An italicized text. - [RichTextUnderline](sections/richtextunderline.md): An underlined text. - [RichTextStrikethrough](sections/richtextstrikethrough.md): A strikethrough text. - [RichTextSpoiler](sections/richtextspoiler.md): A text covered by a spoiler. - [RichTextDateTime](sections/richtextdatetime.md): Formatted date and time. - [RichTextTextMention](sections/richtexttextmention.md): A mention of a Telegram user by their identifier. - [RichTextSubscript](sections/richtextsubscript.md): A subscript text. - [RichTextSuperscript](sections/richtextsuperscript.md): A superscript text. - [RichTextMarked](sections/richtextmarked.md): A marked text. - [RichTextCode](sections/richtextcode.md): A monowidth text. - [RichTextCustomEmoji](sections/richtextcustomemoji.md): A custom emoji. - [RichTextMathematicalExpression](sections/richtextmathematicalexpression.md): A mathematical expression. - [RichTextUrl](sections/richtexturl.md): A text with a link. - [RichTextEmailAddress](sections/richtextemailaddress.md): A text with an email address. - [RichTextPhoneNumber](sections/richtextphonenumber.md): A text with a phone number. - [RichTextBankCardNumber](sections/richtextbankcardnumber.md): A text with a bank card number. - [RichTextTonAddress](sections/richtexttonaddress.md): An address in the TON blockchain. - [RichTextMention](sections/richtextmention.md): A mention by a username. - [RichTextHashtag](sections/richtexthashtag.md): A hashtag. - [RichTextCashtag](sections/richtextcashtag.md): A cashtag. - [RichTextBotCommand](sections/richtextbotcommand.md): A bot command. - [RichTextButton](sections/richtextbutton.md): A button. - [RichTextAnchor](sections/richtextanchor.md): An anchor. - [RichTextAnchorLink](sections/richtextanchorlink.md): A link to an anchor. - [RichTextReference](sections/richtextreference.md): A reference. - [RichTextReferenceLink](sections/richtextreferencelink.md): A link to a reference. - [RichBlockCaption](sections/richblockcaption.md): Caption of a rich formatted block. - [RichBlockTableCell](sections/richblocktablecell.md): Cell in a table. - [RichBlockListItem](sections/richblocklistitem.md): An item of a list. - [RichBlock](sections/richblock.md): This object represents a block in a rich formatted message. Currently, it can be any of the following types: - [RichBlockParagraph](sections/richblockparagraph.md): A text paragraph, corresponding to the HTML tag

. - [RichBlockSectionHeading](sections/richblocksectionheading.md): A section heading, corresponding to the HTML tags

,

,

,

,

, or
. - [RichBlockPreformatted](sections/richblockpreformatted.md): A preformatted text block, corresponding to the nested HTML tags
 and .
- [RichBlockFooter](sections/richblockfooter.md): A footer, corresponding to the HTML tag