Telegram Bot API methods: complete reference
Every method of the Telegram Bot API 10.3 on one page, grouped by category. Each method page lists its parameters with official types, the return value and ready-to-run curl, Python and JavaScript examples — and opens in the online tester with one click.
Bot Info 24
getMeReturns bot information.getMyCommandsReturns the current list of bot commands.setMyCommandsSets the list of bot commands.deleteMyCommandsDeletes bot commands.getMyNameReturns the bot's name.setMyNameSets the bot's name.getMyDescriptionReturns the bot's description.setMyDescriptionSets the bot's description.getMyShortDescriptionReturns the bot's short description.setMyShortDescriptionSets the bot's short description.setMyProfilePhotoSets the bot's profile photo.removeMyProfilePhotoRemoves the bot's profile photo.getUserProfilePhotosReturns user profile photos.getUserProfileAudiosReturns user profile audios (Bot API 9.4).getChatMenuButtonReturns the bot's menu button.setChatMenuButtonSets the bot's menu button.getManagedBotAccessSettingsGets managed bot access settings (Bot API 10.0).setManagedBotAccessSettingsSets managed bot access settings (Bot API 10.0).getManagedBotTokenGets managed bot token (Bot API 9.6).replaceManagedBotTokenReplaces managed bot token (Bot API 9.6).logOutLogs out from the cloud Bot API server.closeCloses the bot before moving to another server.getMyDefaultAdministratorRightsReturns default administrator rights.setMyDefaultAdministratorRightsSets default administrator rights.
Updates 4
getWebhookInfoReturns webhook info.setWebhookSets a webhook.deleteWebhookDeletes a webhook.getUpdatesGets updates. Use the 'Start' button for long polling.
Messages 16
sendMessageSends a text message.forwardMessageForwards a message.forwardMessagesForwards multiple messages.copyMessageCopies a message without forward link.copyMessagesCopies multiple messages.deleteMessageDeletes a message.deleteMessagesDeletes multiple messages.sendChatActionSends a chat action (typing, etc.).sendMessageDraftSends a message draft - temporary preview (Bot API 9.5+).sendContactSends a contact.sendLocationSends a location.sendVenueSends a venue.setMessageReactionSets a reaction on a message.sendChecklistSends a checklist on behalf of a business account.approveSuggestedPostApproves a suggested post in direct messages.declineSuggestedPostDeclines a suggested post in direct messages.
Rich Messages 2
sendRichMessageSends a rich message with structured formatting (Bot API 10.1).sendRichMessageDraftStreams a partial rich message — a 30-second preview (Bot API 10.1).
Ephemeral 5
editEphemeralMessageTextEdits the text of an ephemeral message (Bot API 10.2).editEphemeralMessageMediaEdits the media of an ephemeral message (Bot API 10.2).editEphemeralMessageCaptionEdits the caption of an ephemeral message (Bot API 10.2).editEphemeralMessageReplyMarkupEdits the reply markup of an ephemeral message (Bot API 10.2).deleteEphemeralMessageDeletes an ephemeral message (Bot API 10.2).
Edit 7
editMessageTextEdits message text.editMessageCaptionEdits media caption.editMessageMediaEdits media in a message.editMessageReplyMarkupEdits message reply markup.editMessageLiveLocationEdits a live location.stopMessageLiveLocationStops a live location.editMessageChecklistEdits a checklist.
Media 12
sendPhotoSends a photo.sendVideoSends a video.sendDocumentSends a document.sendAudioSends an audio.sendAnimationSends an animation (GIF).sendStickerSends a sticker.sendVoiceSends a voice message.sendVideoNoteSends a video note (round video).sendMediaGroupSends a group of media (album).sendPaidMediaSends paid media (Bot API 8.0+).sendDiceSends a dice.sendLivePhotoSends a live photo (photo + video, Bot API 10.0).
Payments 16
sendInvoiceSends an invoice for payment.createInvoiceLinkCreates a payment link.refundStarPaymentRefunds a Telegram Stars payment.sendGiftSends a gift to a user or chat.getMyStarBalanceReturns the bot's Telegram Stars balance.getStarTransactionsReturns bot's Telegram Stars transactions.editUserStarSubscriptionCancels or renews a Telegram Stars subscription.giftPremiumSubscriptionGifts a Telegram Premium subscription.answerShippingQueryAnswers a shipping query.answerPreCheckoutQueryAnswers a pre-checkout query.getAvailableGiftsReturns available gifts the bot can send.getUserGiftsReturns user's gifts.getChatGiftsReturns chat's gifts.convertGiftToStarsConverts a regular gift to Telegram Stars.upgradeGiftUpgrades a regular gift to a unique one.transferGiftTransfers a unique gift to another user.
Callbacks 6
answerCallbackQueryAnswers a callback query.answerInlineQueryAnswers an inline query.answerGuestQueryAnswers a guest query - guest mode (Bot API 10.0).answerWebAppQuerySends a Web App interaction result.answerChatJoinRequestQueryAnswers a chat join request query (Bot API 10.1).sendChatJoinRequestWebAppShows a Mini App for a chat join request query (Bot API 10.1).
Chat 23
getChatGets chat information.getChatMemberGets chat member information.getChatMemberCountReturns the number of chat members.getChatAdministratorsReturns a list of chat administrators.setChatTitleSets chat title.setChatDescriptionSets chat description.setChatPhotoSets chat photo.deleteChatPhotoDeletes chat photo.setChatPermissionsSets chat permissions.leaveChatLeaves a chat.exportChatInviteLinkExports the main chat invite link.createChatInviteLinkCreates an invite link.editChatInviteLinkEdits an invite link.revokeChatInviteLinkRevokes an invite link.approveChatJoinRequestApproves a join request.declineChatJoinRequestDeclines a join request.deleteMessageReactionDeletes a reaction from a message (Bot API 10.0).deleteAllMessageReactionsDeletes up to 10000 reactions in a group/supergroup (Bot API 10.0).getUserPersonalChatMessagesGets latest messages from a user personal chat (Bot API 10.0).setChatStickerSetSets a sticker set for a supergroup.deleteChatStickerSetDeletes a sticker set from a supergroup.createChatSubscriptionInviteLinkCreates a subscription invite link.editChatSubscriptionInviteLinkEdits a subscription invite link.
Admin 11
banChatMemberBans a chat member.unbanChatMemberUnbans a chat member.restrictChatMemberRestricts a chat member.promoteChatMemberPromotes a chat member to administrator.setChatAdministratorCustomTitleSets a custom title for an administrator.banChatSenderChatBans a channel in a group/supergroup.unbanChatSenderChatUnbans a channel in a group/supergroup.pinChatMessagePins a message in a chat.unpinChatMessageUnpins a message in a chat.unpinAllChatMessagesUnpins all messages in a chat.setChatMemberTagSets a chat member tag (Bot API 9.5).
Polls 2
Forum 13
createForumTopicCreates a forum topic.editForumTopicEdits a forum topic.closeForumTopicCloses a forum topic.reopenForumTopicReopens a forum topic.deleteForumTopicDeletes a forum topic.editGeneralForumTopicEdits the General forum topic.closeGeneralForumTopicCloses the General forum topic.reopenGeneralForumTopicReopens the General forum topic.hideGeneralForumTopicHides the General forum topic.unhideGeneralForumTopicUnhides the General forum topic.getForumTopicIconStickersReturns forum topic icon stickers.unpinAllForumTopicMessagesUnpins all messages in a forum topic.unpinAllGeneralForumTopicMessagesUnpins all messages in the General topic.
Files 1
getFileGets file info for downloading.
Stickers 14
getStickerSetReturns a sticker set.uploadStickerFileUploads a sticker file.createNewStickerSetCreates a new sticker set.addStickerToSetAdds a sticker to a set.replaceStickerInSetReplaces a sticker in a set.setStickerPositionInSetMoves a sticker in a set.deleteStickerFromSetDeletes a sticker from a set.setStickerSetTitleSets sticker set title.setStickerSetThumbnailSets sticker set thumbnail.setCustomEmojiStickerSetThumbnailSets custom emoji sticker set thumbnail.deleteStickerSetDeletes a sticker set.setStickerEmojiListChanges sticker emoji list.setStickerKeywordsChanges sticker keywords.setStickerMaskPositionChanges sticker mask position.
Games 3
sendGameSends a game.setGameScoreSets a user's game score.getGameHighScoresReturns game high scores.
Stories 4
postStoryPosts a story on behalf of a business account.editStoryEdits a story on behalf of a business account.deleteStoryDeletes a story on behalf of a business account.repostStoryReposts a story between business accounts (Bot API 9.3).
Business 11
getBusinessAccountStarBalanceReturns business account Stars balance.getBusinessAccountGiftsReturns business account gifts.transferBusinessAccountStarsTransfers Stars from business account to bot balance.readBusinessMessageMarks an incoming message as read on behalf of a business account.deleteBusinessMessagesDeletes messages on behalf of a business account.setBusinessAccountNameSets business account name.setBusinessAccountUsernameSets business account username.setBusinessAccountBioSets business account bio.setBusinessAccountProfilePhotoSets business account profile photo.removeBusinessAccountProfilePhotoRemoves business account profile photo.setBusinessAccountGiftSettingsConfigures business account gift settings.
Other 11
getCustomEmojiStickersReturns custom emoji stickers info.getUserChatBoostsReturns user's chat boosts.getBusinessConnectionGets business connection info.savePreparedInlineMessageSaves a prepared inline message.verifyUserVerifies a user on behalf of an organization.verifyChatVerifies a chat on behalf of an organization.removeUserVerificationRemoves user verification.removeChatVerificationRemoves chat verification.setUserEmojiStatusSets a user's emoji status.savePreparedKeyboardButtonSaves a keyboard button for Mini Apps.setPassportDataErrorsInforms the user about Telegram Passport errors.