Métodos da Telegram Bot API: referência completa
Todos os métodos da Telegram Bot API 10.3 em uma única página, agrupados por categoria. A página de cada método lista os parâmetros com os tipos oficiais, o valor de retorno e exemplos prontos para rodar em curl, Python e JavaScript — e abre no tester online com um clique.
Info do bot 24
getMeRetorna informações sobre o bot.getMyCommandsRetorna a lista atual de comandos do bot.setMyCommandsDefine a lista de comandos do bot.deleteMyCommandsApaga os comandos do bot.getMyNameRetorna o nome do bot.setMyNameDefine o nome do bot.getMyDescriptionRetorna a descrição do bot.setMyDescriptionDefine a descrição do bot.getMyShortDescriptionRetorna a descrição curta do bot.setMyShortDescriptionDefine a descrição curta do bot.setMyProfilePhotoDefine a foto de perfil do bot.removeMyProfilePhotoRemove a foto de perfil do bot.getUserProfilePhotosRetorna as fotos de perfil de um usuário.getUserProfileAudiosRetorna os áudios de perfil de um usuário (Bot API 9.4).getChatMenuButtonRetorna o botão de menu do bot.setChatMenuButtonDefine o botão de menu do bot.getManagedBotAccessSettingsObtém as configurações de acesso de um bot gerenciado (Bot API 10.0).setManagedBotAccessSettingsDefine as configurações de acesso de um bot gerenciado (Bot API 10.0).getManagedBotTokenObtém o token de um bot gerenciado (Bot API 9.6).replaceManagedBotTokenSubstitui o token de um bot gerenciado (Bot API 9.6).logOutFaz logout do servidor Bot API em nuvem.closeEncerra o bot antes de movê-lo para outro servidor.getMyDefaultAdministratorRightsRetorna os direitos de administrador padrão.setMyDefaultAdministratorRightsDefine os direitos de administrador padrão.
Atualizações 4
getWebhookInfoRetorna informações sobre o webhook.setWebhookDefine um webhook.deleteWebhookApaga o webhook.getUpdatesObtém atualizações. Use o botão 'Iniciar' para long polling.
Mensagens 16
sendMessageEnvia uma mensagem de texto.forwardMessageEncaminha uma mensagem.forwardMessagesEncaminha várias mensagens.copyMessageCopia uma mensagem sem o link de encaminhamento.copyMessagesCopia várias mensagens.deleteMessageApaga uma mensagem.deleteMessagesApaga várias mensagens.sendChatActionEnvia uma ação no chat (typing etc.).sendMessageDraftEnvia um rascunho de mensagem - prévia temporária (Bot API 9.5+).sendContactEnvia um contato.sendLocationEnvia uma localização.sendVenueEnvia um local.setMessageReactionDefine uma reação em uma mensagem.sendChecklistEnvia uma checklist em nome de uma conta comercial.approveSuggestedPostAprova uma publicação sugerida nas mensagens diretas.declineSuggestedPostRecusa uma publicação sugerida nas mensagens diretas.
Mensagens ricas 2
sendRichMessageEnvia uma mensagem rica com formatação estruturada (Bot API 10.1).sendRichMessageDraftTransmite uma mensagem rica parcial — prévia de 30 segundos (Bot API 10.1).
Efêmeras 5
editEphemeralMessageTextEdita o texto de uma mensagem efêmera (Bot API 10.2).editEphemeralMessageMediaEdita a mídia de uma mensagem efêmera (Bot API 10.2).editEphemeralMessageCaptionEdita a legenda de uma mensagem efêmera (Bot API 10.2).editEphemeralMessageReplyMarkupEdita o reply markup de uma mensagem efêmera (Bot API 10.2).deleteEphemeralMessageApaga uma mensagem efêmera (Bot API 10.2).
Edição 7
editMessageTextEdita o texto de uma mensagem.editMessageCaptionEdita a legenda de uma mídia.editMessageMediaEdita a mídia de uma mensagem.editMessageReplyMarkupEdita o reply markup de uma mensagem.editMessageLiveLocationEdita uma localização em tempo real.stopMessageLiveLocationInterrompe uma localização em tempo real.editMessageChecklistEdita uma checklist.
Mídia 12
sendPhotoEnvia uma foto.sendVideoEnvia um vídeo.sendDocumentEnvia um documento.sendAudioEnvia um áudio.sendAnimationEnvia uma animação (GIF).sendStickerEnvia um sticker.sendVoiceEnvia uma mensagem de voz.sendVideoNoteEnvia uma mensagem de vídeo (vídeo circular).sendMediaGroupEnvia um grupo de mídias (álbum).sendPaidMediaEnvia mídia paga (Bot API 8.0+).sendDiceEnvia um dado.sendLivePhotoEnvia uma live photo (foto + vídeo, Bot API 10.0).
Pagamentos 16
sendInvoiceEnvia uma fatura para pagamento.createInvoiceLinkCria um link de pagamento.refundStarPaymentReembolsa um pagamento em Telegram Stars.sendGiftEnvia um presente a um usuário ou chat.getMyStarBalanceRetorna o saldo de Telegram Stars do bot.getStarTransactionsRetorna as transações de Telegram Stars do bot.editUserStarSubscriptionCancela ou renova uma assinatura em Telegram Stars.giftPremiumSubscriptionDá de presente uma assinatura do Telegram Premium.answerShippingQueryResponde a uma consulta de entrega.answerPreCheckoutQueryResponde a uma consulta de pré-checkout.getAvailableGiftsRetorna os presentes que o bot pode enviar.getUserGiftsRetorna os presentes de um usuário.getChatGiftsRetorna os presentes de um chat.convertGiftToStarsConverte um presente comum em Telegram Stars.upgradeGiftFaz o upgrade de um presente comum para um presente único.transferGiftTransfere um presente único para outro usuário.
Callbacks 6
answerCallbackQueryResponde a uma consulta de callback.answerInlineQueryResponde a uma consulta inline.answerGuestQueryResponde a uma consulta de convidado - modo convidado (Bot API 10.0).answerWebAppQueryEnvia o resultado de uma interação com o Web App.answerChatJoinRequestQueryResponde a uma consulta de solicitação de entrada no chat (Bot API 10.1).sendChatJoinRequestWebAppMostra um Mini App para uma consulta de solicitação de entrada no chat (Bot API 10.1).
Chat 23
getChatObtém informações sobre o chat.getChatMemberObtém informações sobre um membro do chat.getChatMemberCountRetorna o número de membros do chat.getChatAdministratorsRetorna a lista de administradores do chat.setChatTitleDefine o título do chat.setChatDescriptionDefine a descrição do chat.setChatPhotoDefine a foto do chat.deleteChatPhotoApaga a foto do chat.setChatPermissionsDefine as permissões do chat.leaveChatSai de um chat.exportChatInviteLinkExporta o link de convite principal do chat.createChatInviteLinkCria um link de convite.editChatInviteLinkEdita um link de convite.revokeChatInviteLinkRevoga um link de convite.approveChatJoinRequestAprova uma solicitação de entrada.declineChatJoinRequestRecusa uma solicitação de entrada.deleteMessageReactionApaga uma reação de uma mensagem (Bot API 10.0).deleteAllMessageReactionsApaga até 10000 reações em um grupo/supergrupo (Bot API 10.0).getUserPersonalChatMessagesObtém as mensagens mais recentes do chat pessoal de um usuário (Bot API 10.0).setChatStickerSetDefine um pacote de stickers para um supergrupo.deleteChatStickerSetRemove o pacote de stickers de um supergrupo.createChatSubscriptionInviteLinkCria um link de convite por assinatura.editChatSubscriptionInviteLinkEdita um link de convite por assinatura.
Admin 11
banChatMemberBane um membro do chat.unbanChatMemberDesbane um membro do chat.restrictChatMemberRestringe um membro do chat.promoteChatMemberPromove um membro do chat a administrador.setChatAdministratorCustomTitleDefine um título personalizado para um administrador.banChatSenderChatBane um canal em um grupo/supergrupo.unbanChatSenderChatDesbane um canal em um grupo/supergrupo.pinChatMessageFixa uma mensagem no chat.unpinChatMessageDesafixa uma mensagem no chat.unpinAllChatMessagesDesafixa todas as mensagens do chat.setChatMemberTagDefine a tag de um membro do chat (Bot API 9.5).
Enquetes 2
Fórum 13
createForumTopicCria um tópico do fórum.editForumTopicEdita um tópico do fórum.closeForumTopicFecha um tópico do fórum.reopenForumTopicReabre um tópico do fórum.deleteForumTopicApaga um tópico do fórum.editGeneralForumTopicEdita o tópico Geral do fórum.closeGeneralForumTopicFecha o tópico Geral do fórum.reopenGeneralForumTopicReabre o tópico Geral do fórum.hideGeneralForumTopicOculta o tópico Geral do fórum.unhideGeneralForumTopicVolta a exibir o tópico Geral do fórum.getForumTopicIconStickersRetorna os stickers disponíveis como ícones de tópicos do fórum.unpinAllForumTopicMessagesDesafixa todas as mensagens de um tópico do fórum.unpinAllGeneralForumTopicMessagesDesafixa todas as mensagens do tópico Geral.
Arquivos 1
getFileObtém informações de um arquivo para download.
Stickers 14
getStickerSetRetorna um pacote de stickers.uploadStickerFileFaz upload de um arquivo de sticker.createNewStickerSetCria um novo pacote de stickers.addStickerToSetAdiciona um sticker a um pacote.replaceStickerInSetSubstitui um sticker em um pacote.setStickerPositionInSetMove um sticker dentro de um pacote.deleteStickerFromSetApaga um sticker de um pacote.setStickerSetTitleDefine o título de um pacote de stickers.setStickerSetThumbnailDefine a miniatura de um pacote de stickers.setCustomEmojiStickerSetThumbnailDefine a miniatura de um pacote de stickers de emoji personalizado.deleteStickerSetApaga um pacote de stickers.setStickerEmojiListAltera a lista de emojis de um sticker.setStickerKeywordsAltera as palavras-chave de um sticker.setStickerMaskPositionAltera a posição da máscara de um sticker.
Jogos 3
sendGameEnvia um jogo.setGameScoreDefine a pontuação de um usuário no jogo.getGameHighScoresRetorna as melhores pontuações do jogo.
Stories 4
postStoryPublica um story em nome de uma conta comercial.editStoryEdita um story em nome de uma conta comercial.deleteStoryApaga um story em nome de uma conta comercial.repostStoryReposta um story entre contas comerciais (Bot API 9.3).
Business 11
getBusinessAccountStarBalanceRetorna o saldo de Stars da conta comercial.getBusinessAccountGiftsRetorna os presentes da conta comercial.transferBusinessAccountStarsTransfere Stars da conta comercial para o saldo do bot.readBusinessMessageMarca uma mensagem recebida como lida em nome de uma conta comercial.deleteBusinessMessagesApaga mensagens em nome de uma conta comercial.setBusinessAccountNameDefine o nome da conta comercial.setBusinessAccountUsernameDefine o nome de usuário da conta comercial.setBusinessAccountBioDefine a bio da conta comercial.setBusinessAccountProfilePhotoDefine a foto de perfil da conta comercial.removeBusinessAccountProfilePhotoRemove a foto de perfil da conta comercial.setBusinessAccountGiftSettingsConfigura as opções de presentes da conta comercial.
Outros 11
getCustomEmojiStickersRetorna informações sobre stickers de emoji personalizado.getUserChatBoostsRetorna os boosts de um usuário no chat.getBusinessConnectionObtém informações sobre a conexão comercial.savePreparedInlineMessageSalva uma mensagem inline preparada.verifyUserVerifica um usuário em nome de uma organização.verifyChatVerifica um chat em nome de uma organização.removeUserVerificationRemove a verificação de um usuário.removeChatVerificationRemove a verificação de um chat.setUserEmojiStatusDefine o status de emoji de um usuário.savePreparedKeyboardButtonSalva um botão de teclado para Mini Apps.setPassportDataErrorsInforma o usuário sobre erros do Telegram Passport.