Документация Telegram Bot API на русском
Все методы Telegram Bot API 10.3 на русском языке, сгруппированные по категориям. На странице каждого метода — параметры с официальными типами, возвращаемое значение и готовые примеры на curl, Python и JavaScript, а также запуск в онлайн-тестере в один клик.
Информация 24
getMeВозвращает информацию о боте.getMyCommandsВозвращает текущий список команд бота.setMyCommandsУстанавливает список команд бота.deleteMyCommandsУдаляет команды бота.getMyNameВозвращает имя бота.setMyNameУстанавливает имя бота.getMyDescriptionВозвращает описание бота.setMyDescriptionУстанавливает описание бота.getMyShortDescriptionВозвращает краткое описание бота.setMyShortDescriptionУстанавливает краткое описание бота.setMyProfilePhotoУстанавливает фото профиля бота.removeMyProfilePhotoУдаляет фото профиля бота.getUserProfilePhotosВозвращает фотографии профиля пользователя.getUserProfileAudiosВозвращает аудио профиля пользователя (Bot API 9.4).getChatMenuButtonВозвращает кнопку меню бота.setChatMenuButtonУстанавливает кнопку меню бота.getManagedBotAccessSettingsПолучает настройки доступа управляемого бота (Bot API 10.0).setManagedBotAccessSettingsУстанавливает настройки доступа управляемого бота (Bot API 10.0).getManagedBotTokenПолучает токен управляемого бота (Bot API 9.6).replaceManagedBotTokenЗаменяет токен управляемого бота (Bot API 9.6).logOutВыходит из облачного Bot API сервера.closeЗакрывает бот перед перемещением на другой сервер.getMyDefaultAdministratorRightsВозвращает текущие права администратора по умолчанию.setMyDefaultAdministratorRightsУстанавливает права администратора по умолчанию.
Обновления 4
getWebhookInfoВозвращает информацию о вебхуке.setWebhookУстанавливает вебхук.deleteWebhookУдаляет вебхук.getUpdatesПолучает обновления. Для long polling используйте кнопку «Старт».
Сообщения 16
sendMessageОтправляет текстовое сообщение.forwardMessageПересылает сообщение.forwardMessagesПересылает несколько сообщений.copyMessageКопирует сообщение без ссылки на оригинал.copyMessagesКопирует несколько сообщений.deleteMessageУдаляет сообщение.deleteMessagesУдаляет несколько сообщений.sendChatActionОтправляет действие «печатает...» и т.д.sendMessageDraftОтправляет черновик сообщения — временный предпросмотр (Bot API 9.5+).sendContactОтправляет контакт.sendLocationОтправляет геопозицию.sendVenueОтправляет место (venue).setMessageReactionУстанавливает реакцию на сообщение.sendChecklistОтправляет чек-лист от имени бизнес-аккаунта.approveSuggestedPostОдобряет предложенный пост в прямых сообщениях.declineSuggestedPostОтклоняет предложенный пост в прямых сообщениях.
Rich-сообщения 2
sendRichMessageОтправляет rich-сообщение со структурированным форматированием (Bot API 10.1).sendRichMessageDraftСтримит частичное rich-сообщение — предпросмотр на 30 секунд (Bot API 10.1).
Эфемерные 5
editEphemeralMessageTextРедактирует текст эфемерного сообщения (Bot API 10.2).editEphemeralMessageMediaРедактирует медиа эфемерного сообщения (Bot API 10.2).editEphemeralMessageCaptionРедактирует подпись эфемерного сообщения (Bot API 10.2).editEphemeralMessageReplyMarkupРедактирует кнопки эфемерного сообщения (Bot API 10.2).deleteEphemeralMessageУдаляет эфемерное сообщение (Bot API 10.2).
Редактирование 7
editMessageTextРедактирует текст сообщения.editMessageCaptionРедактирует подпись к медиа.editMessageMediaРедактирует медиа в сообщении.editMessageReplyMarkupРедактирует reply markup сообщения.editMessageLiveLocationРедактирует живую локацию.stopMessageLiveLocationОстанавливает живую локацию.editMessageChecklistРедактирует чек-лист.
Медиа 12
sendPhotoОтправляет фото.sendVideoОтправляет видео.sendDocumentОтправляет документ.sendAudioОтправляет аудио.sendAnimationОтправляет анимацию (GIF).sendStickerОтправляет стикер.sendVoiceОтправляет голосовое сообщение.sendVideoNoteОтправляет видеозаметку (кружочек).sendMediaGroupОтправляет группу медиа (альбом).sendPaidMediaОтправляет платное медиа (Bot API 8.0+).sendDiceОтправляет кубик (🎲). Поддерживаемые emoji: 🎲 🎯 🏀 ⚽ 🎰 🎳sendLivePhotoОтправляет живое фото (фото + видео, Bot API 10.0).
Оплата 16
sendInvoiceОтправляет счёт для оплаты.createInvoiceLinkСоздаёт ссылку для оплаты.refundStarPaymentВозвращает платеж в Telegram Stars.sendGiftОтправляет подарок пользователю или чату.getMyStarBalanceВозвращает баланс Telegram Stars бота.getStarTransactionsВозвращает транзакции Telegram Stars бота.editUserStarSubscriptionОтменяет или возобновляет подписку в Telegram Stars.giftPremiumSubscriptionДарит подписку Telegram Premium.answerShippingQueryОтвечает на shipping query.answerPreCheckoutQueryОтвечает на pre-checkout query.getAvailableGiftsВозвращает список подарков, которые бот может отправить.getUserGiftsВозвращает подарки пользователя.getChatGiftsВозвращает подарки чата.convertGiftToStarsКонвертирует обычный подарок в Telegram Stars.upgradeGiftУлучшает обычный подарок до уникального.transferGiftПередаёт уникальный подарок другому пользователю.
Обратные вызовы 6
answerCallbackQueryОтвечает на callback query.answerInlineQueryОтвечает на inline query.answerGuestQueryОтвечает на guest query — режим гостя (Bot API 10.0).answerWebAppQueryОтправляет результат взаимодействия с Web App.answerChatJoinRequestQueryОтвечает на запрос на вступление в чат (Bot API 10.1).sendChatJoinRequestWebAppПоказывает Mini App при запросе на вступление в чат (Bot API 10.1).
Чат 23
getChatПолучает информацию о чате.getChatMemberПолучает информацию об участнике чата.getChatMemberCountВозвращает количество участников в чате.getChatAdministratorsВозвращает список администраторов чата.setChatTitleУстанавливает название чата.setChatDescriptionУстанавливает описание чата.setChatPhotoУстанавливает фото чата.deleteChatPhotoУдаляет фото чата.setChatPermissionsУстанавливает права участников чата.leaveChatПокидает чат.exportChatInviteLinkЭкспортирует основную ссылку-приглашение.createChatInviteLinkСоздаёт ссылку-приглашение.editChatInviteLinkРедактирует ссылку-приглашение.revokeChatInviteLinkОтзывает ссылку-приглашение.approveChatJoinRequestОдобряет заявку на вступление.declineChatJoinRequestОтклоняет заявку на вступление.deleteMessageReactionУдаляет реакцию с сообщения (Bot API 10.0).deleteAllMessageReactionsУдаляет до 10000 реакций в группе/супергруппе (Bot API 10.0).getUserPersonalChatMessagesПолучает последние сообщения из личного чата пользователя (Bot API 10.0).setChatStickerSetУстанавливает набор стикеров для супергруппы.deleteChatStickerSetУдаляет набор стикеров из супергруппы.createChatSubscriptionInviteLinkСоздаёт ссылку-приглашение на подписку.editChatSubscriptionInviteLinkРедактирует ссылку-приглашение на подписку.
Администрирование 11
banChatMemberБанит участника в чате.unbanChatMemberРазбанивает участника в чате.restrictChatMemberОграничивает участника в чате.promoteChatMemberПовышает участника до администратора.setChatAdministratorCustomTitleУстанавливает кастомный титул администратора.banChatSenderChatБанит канал в группе/супергруппе.unbanChatSenderChatРазбанивает канал в группе/супергруппе.pinChatMessageЗакрепляет сообщение в чате.unpinChatMessageОткрепляет сообщение в чате.unpinAllChatMessagesОткрепляет все сообщения в чате.setChatMemberTagУстанавливает тег участника чата (Bot API 9.5).
Опросы 2
Форум 13
createForumTopicСоздаёт тему в форуме.editForumTopicРедактирует тему в форуме.closeForumTopicЗакрывает тему в форуме.reopenForumTopicПереоткрывает тему в форуме.deleteForumTopicУдаляет тему в форуме.editGeneralForumTopicРедактирует тему «Общее» в форуме.closeGeneralForumTopicЗакрывает тему «Общее» в форуме.reopenGeneralForumTopicПереоткрывает тему «Общее» в форуме.hideGeneralForumTopicСкрывает тему «Общее» в форуме.unhideGeneralForumTopicПоказывает скрытую тему «Общее» в форуме.getForumTopicIconStickersВозвращает стикеры для иконок тем форума.unpinAllForumTopicMessagesОткрепляет все сообщения в теме форума.unpinAllGeneralForumTopicMessagesОткрепляет все сообщения в теме «Общее».
Файлы 1
getFileПолучает информацию о файле для скачивания.
Стикеры 14
getStickerSetВозвращает набор стикеров.uploadStickerFileЗагружает файл стикера.createNewStickerSetСоздаёт новый набор стикеров.addStickerToSetДобавляет стикер в набор.replaceStickerInSetЗаменяет стикер в наборе.setStickerPositionInSetПеремещает стикер в наборе.deleteStickerFromSetУдаляет стикер из набора.setStickerSetTitleУстанавливает название набора стикеров.setStickerSetThumbnailУстанавливает миниатюру набора стикеров.setCustomEmojiStickerSetThumbnailУстанавливает миниатюру набора кастомных emoji.deleteStickerSetУдаляет набор стикеров.setStickerEmojiListИзменяет список emoji стикера.setStickerKeywordsИзменяет ключевые слова стикера.setStickerMaskPositionИзменяет позицию маски стикера.
Игры 3
sendGameОтправляет игру.setGameScoreУстанавливает счёт пользователя в игре.getGameHighScoresВозвращает таблицу рекордов игры.
Истории 4
postStoryПубликует историю от имени бизнес-аккаунта.editStoryРедактирует историю от имени бизнес-аккаунта.deleteStoryУдаляет историю от имени бизнес-аккаунта.repostStoryРепостит историю между бизнес-аккаунтами (Bot API 9.3).
Бизнес 11
getBusinessAccountStarBalanceВозвращает баланс Stars бизнес-аккаунта.getBusinessAccountGiftsВозвращает подарки бизнес-аккаунта.transferBusinessAccountStarsПереводит Stars с бизнес-аккаунта на баланс бота.readBusinessMessageОтмечает входящее сообщение как прочитанное от имени бизнес-аккаунта.deleteBusinessMessagesУдаляет сообщения от имени бизнес-аккаунта.setBusinessAccountNameУстанавливает имя бизнес-аккаунта.setBusinessAccountUsernameУстанавливает username бизнес-аккаунта.setBusinessAccountBioУстанавливает описание бизнес-аккаунта.setBusinessAccountProfilePhotoУстанавливает фото бизнес-аккаунта.removeBusinessAccountProfilePhotoУдаляет фото бизнес-аккаунта.setBusinessAccountGiftSettingsНастраивает подарки бизнес-аккаунта.
Другое 11
getCustomEmojiStickersВозвращает информацию о кастомных emoji.getUserChatBoostsВозвращает бусты пользователя в чате.getBusinessConnectionПолучает информацию о бизнес-подключении.savePreparedInlineMessageСохраняет подготовленное inline-сообщение.verifyUserПодтверждает пользователя от имени организации.verifyChatПодтверждает чат от имени организации.removeUserVerificationСнимает подтверждение с пользователя.removeChatVerificationСнимает подтверждение с чата.setUserEmojiStatusУстанавливает emoji-статус пользователя.savePreparedKeyboardButtonСохраняет кнопку клавиатуры для Mini Apps.setPassportDataErrorsИнформирует пользователя об ошибках в Telegram Passport.