Receive incoming updates using long polling. Returns an Array of Update objects.

Specify a URL to receive incoming updates via webhook. Use deleteWebhook to remove.

Remove webhook integration. Use getUpdates to receive updates after this.

Get current webhook status. Returns a WebhookInfo object with URL, pending updates count, and errors.

Get basic information about the bot. Returns a User object with id, is_bot, first_name, username, etc.

Log out from the cloud Bot API server. After logging out, you must wait 10 minutes before logging in again.

Close the bot instance. Use before moving the bot to a local server. Must be called before running locally.

Get custom emoji stickers that can be used as forum topic icons by any user. Returns an Array of Sticker objects.

Create a topic in a forum supergroup chat. The bot must be an administrator with can_manage_topics rights. Returns ForumTopic object.

Edit name and icon of a forum topic. The bot must be an administrator with can_manage_topics rights. Returns True on success.

Close an open topic in a forum supergroup chat. The bot must be an administrator with can_manage_topics rights. Returns True on success.

Reopen a closed topic in a forum supergroup chat. The bot must be an administrator with can_manage_topics rights. Returns True on success.

Delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator with can_delete_messages rights. Returns True on success.

Clear the list of pinned messages in a forum topic. The bot must be an administrator with can_pin_messages rights. Returns True on success.

Edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator with can_manage_topics rights. Returns True on success.

Close the 'General' topic in a forum supergroup chat. The bot must be an administrator with can_manage_topics rights. Returns True on success.

Reopen the closed 'General' topic in a forum supergroup chat. The bot must be an administrator with can_manage_topics rights. Returns True on success.

Hide the 'General' topic in a forum supergroup chat. The bot must be an administrator with can_manage_topics rights. The topic will be automatically closed if it was open. Returns True on success.

Unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator with can_manage_topics rights. Returns True on success.

Clear the list of pinned messages in a General forum topic. The bot must be an administrator with can_pin_messages rights. Returns True on success.

Send answers to an inline query. Results are displayed in the user's chat. Maximum 50 results per query. Returns True on success.

Send answers to callback queries sent from inline keyboards. The answer is displayed as a notification at the top of the chat screen or as an alert. Returns True on success.

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. Returns a SentWebAppMessage object on success.

Store a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object with a unique identifier and expiration date.

Change the chosen reactions on a message. Service messages cannot be reacted to. Bots cannot use paid reactions. Returns True on success.

Get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object on success.

Get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Edit text and game messages. Returns the edited Message on success, or True if the message is an inline message.

Edit captions of messages. Returns the edited Message on success, or True if the message is an inline message.

Edit animation, audio, document, photo, or video messages, or add media to text messages. If a message is part of a message album, then it can only be edited to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. Returns the edited Message on success, or True if the message is an inline message.

Edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. Returns the edited Message on success, or True if the message is an inline message.

Stop updating a live location message before live_period expires. Returns the edited Message on success, or True if the message is an inline message.

Edit only the reply markup of messages. Returns the edited Message on success, or True if the message is an inline message.

Stop a poll which was sent by the bot. Returns the stopped Poll on success.

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. Service messages about a supergroup, channel, or forum topic creation can't be deleted. A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. Bots can delete outgoing messages in private chats, groups, and supergroups. Bots can delete incoming messages in private chats. Bots granted can_post_messages permissions can delete outgoing messages in channels. If the bot is an administrator of a group, it can delete any message there. If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. Returns True on success.

Delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.

Returns the list of gifts that can be sent by the bot to users and channel chats. Returns a Gifts object.

Sends a gift to the given user or channel chat. The gift cannot be converted to Telegram Stars by the receiver. Returns True on success.

Gifts a Telegram Premium subscription to the given user. Returns True on success.

Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns an OwnedGifts object on success.

Returns the gifts received and owned by a given user. Returns an OwnedGifts object on success.

Returns the gifts received and owned by a chat. Returns an OwnedGifts object on success.

Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.

Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Returns True on success.

Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Returns True on success.

Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.

Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.

Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.

Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.

Informs a user that some of the Telegram Passport elements they provided contain errors. The user will not be able to re-submit their Passport to you until the errors are fixed. Returns True on success.

Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.

Deletes messages on behalf of a business account. Requires can_delete_sent_messages for bot's own messages or can_delete_all_messages for any message. Returns True on success.

Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.

Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.

Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.

Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.

Changes the privacy settings for gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.

Returns the current Telegram Star balance of a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns a StarAmount object on success.

Transfers Telegram Stars from a managed business account to the bot's balance. The Stars can then be withdrawn by the bot. Requires the can_transfer_stars business bot right. Returns True on success.

Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns a Story object on success.

Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns a Story object on success.

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.

Reposts a story from one managed business account to another. Both accounts must be managed by the same bot. Requires the can_manage_stories business bot right for both accounts. Returns a Story object on success.

Approves 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.

Declines a suggested post in a direct messages chat. Requires the can_manage_direct_messages administrator right in the corresponding channel. Returns True on success.

Send an invoice to a user. On success, the sent Message is returned.

Create a link for an invoice. Returns the created invoice link as String on success.

Reply to shipping queries. 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.

Respond to pre-checkout queries. 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.

Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

Refunds a successful payment in Telegram Stars. Returns True on success.

Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.

Returns the bot's current balance in Telegram Stars. On success, returns a StarAmount object.

Send a game. On success, the sent Message is returned.

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.

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.

Change the list of bot commands. Returns True on success. At most 100 commands can be specified.

Delete the list of bot commands for the given scope and language. Returns True on success.

Get the current list of bot commands for the given scope and language. Returns an Array of BotCommand objects.

Change the bot's name. Returns True on success.

Get the current bot name for the given user language. Returns a BotName object.

Change the bot's description, shown in empty chats and shared via bot links. Returns True on success.

Get the current bot description for the given user language. Returns a BotDescription object.

Change the bot's short description, shown on the bot's profile page and shared alongside bot links. Returns True on success.

Get the current bot short description for the given user language. Returns a BotShortDescription object.

Change the bot's menu button in a private chat, or the default menu button. Returns True on success.

Get the current value of the bot's menu button in a private chat, or the default menu button. Returns a MenuButton object.

Change the default administrator rights requested when adding the bot as administrator to groups or channels. Returns True on success.

Get the current default administrator rights of the bot. Returns a ChatAdministratorRights object.

Get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Change the emoji status for a user who authorized the bot via Mini App method requestEmojiStatusAccess. Returns True on success.

Get basic info about a file and prepare it for downloading. Returns a File object with file_path for download. Files up to 20MB can be downloaded.

Ban a user in a group, supergroup or channel. The bot must be an administrator with the appropriate rights. Returns True on success.

Unban a previously banned user in a supergroup or channel. The user will NOT return to the group automatically but will be able to join via link, etc. The bot must be an administrator. Returns True on success.

Ban a channel chat in a supergroup or 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 and must have the appropriate administrator rights. Returns True on success.

Unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator and must have the appropriate administrator rights. Returns True on success.

Restrict a user in a supergroup. The bot must be an administrator with can_restrict_members rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Promote or demote a user in a supergroup or channel. The bot must be an administrator with the appropriate rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Set default chat permissions for all members. The bot must be an administrator and must have the can_restrict_members administrator rights. Returns True on success.

Generate a new primary invite link for a chat. Any previously generated primary link is revoked. The bot must be an administrator with can_invite_users rights. Returns the new invite link as String on success.

Create an additional invite link for a chat. The bot must be an administrator with can_invite_users rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Edit a non-primary invite link created by the bot. The bot must be an administrator with can_invite_users rights. Returns the edited invite link as ChatInviteLink object.

Create a subscription invite link for a channel chat. The bot must have can_invite_users administrator rights. The link can be edited using editChatSubscriptionInviteLink or revoked using revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Edit a subscription invite link created by the bot. The bot must have can_invite_users administrator rights. Returns the edited invite link as ChatInviteLink object.

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 with can_invite_users rights. Returns the revoked invite link as ChatInviteLink object.

Approve a chat join request. The bot must be an administrator with can_invite_users rights. Returns True on success.

Decline a chat join request. The bot must be an administrator with can_invite_users rights. Returns True on success.

Set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator with can_change_info rights. Returns True on success.

Delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator with can_change_info rights. Returns True on success.

Change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator with can_change_info rights. Returns True on success.

Change the description of a group, a supergroup or a channel. The bot must be an administrator with can_change_info rights. Returns True on success.

Add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator with can_pin_messages rights in a supergroup or can_edit_messages rights in a channel. Returns True on success.

Remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator with can_pin_messages rights in a supergroup or can_edit_messages rights in a channel. Returns True on success.

Clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator with can_pin_messages rights in a supergroup or can_edit_messages rights in a channel. Returns True on success.

Leave a group, supergroup or channel. Returns True on success.

Get up to date information about the chat. Returns ChatFullInfo object on success.

Get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.

Get the number of members in a chat. Returns Int on success.

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.

Set a new group sticker set for a supergroup. The bot must be an administrator with can_change_info 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.

Delete a group sticker set from a supergroup. The bot must be an administrator with can_change_info 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.

Send text messages to a chat. Supports formatting, reply markup, and various message options. Returns the sent Message on success.

Forward messages of any kind. Service messages and messages with protected content can't be forwarded. Returns the sent Message on success.

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. Returns an array of MessageId of the sent messages on success.

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.

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. Returns an array of MessageId of the sent messages on success.

Send photos. On success, the sent Message is returned. Photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20.

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. For sending voice messages, use the sendVoice method instead.

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.

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.

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.

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. On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size.

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Send video messages. On success, the sent Message is returned.

Send paid media. On success, the sent Message is returned. Maximum price is 25000 Telegram Stars.

Send a group of 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 Messages that were sent is returned.

Send point on the map. On success, the sent Message is returned. Supports live locations that can be edited.

Send information about a venue. On success, the sent Message is returned.

Send phone contacts. On success, the sent Message is returned.

Send a native poll. On success, the sent Message is returned. Supports regular polls and quizzes.

Send a checklist on behalf of a business account. On success, the sent Message is returned. Available for business accounts only.

Send an animated emoji that will display a random value. On success, the sent Message is returned. Supported emoji: dice, darts, basketball, football, bowling, slot machine.

Stream partial messages to a user while being generated. This is useful for AI-powered bots that want to show responses as they're being created. Allows progressive message delivery during content generation.

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.

Send static .WEBP, animated .TGS, or video .WEBM stickers. Returns the sent Message on success.

Get a sticker set by name. Returns a StickerSet object on success.

Get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods. Returns the uploaded File on success.

Create a new sticker set owned by a user. The bot will be able to edit the sticker set. Returns True on success.

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.

Move a sticker in a set created by the bot to a specific position. Returns True on success.

Delete a sticker from a set created by the bot. Returns True on success.

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.

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.

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.

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.

Set the title of a created sticker set. Returns True on success.

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.

Set the thumbnail of a custom emoji sticker set. Returns True on success.

Delete a sticker set that was created by the bot. Returns True on success.