v10.3 185 métodos
Início Documentação Tester Mini App Feedback
PT

Documentação da API de bots do Telegram: Swagger e OpenAPI

Esta é uma documentação interativa da API de bots do Telegram: uma descrição OpenAPI 3.1 dos 185 métodos da Bot API 10.3, agrupados em 19 tags e exibidos no Swagger UI. Cada método lista os parâmetros com tipos e indicação de obrigatórios, traz o link para a documentação oficial e pode ser executado ao vivo com o token do seu bot.

Como usar a documentação Swagger da Telegram Bot API

  1. Pegue o token do bot no @BotFather; veja como obter o token de um bot do Telegram.
  2. Clique em Authorize e cole o token. As requisições vão para https://api.telegram.org/bot<token>/METHOD_NAME; se o bloco de servidores mostrar a variável token, preencha-a também.
  3. Abra uma das 19 tags (mensagens, atualizações, pagamentos…) ou filtre a lista pelo campo de busca.
  4. Abra um método, clique em Try it out, edite o corpo JSON (no sendMessage, isso significa chat_id e text) e clique em Execute.
  5. Confira o código de status, o corpo da resposta, a duração da requisição e o comando curl gerado.

Telegram Bot API em português

A documentação oficial em core.telegram.org existe só em inglês. Os nomes de métodos, parâmetros e tipos (sendMessage, chat_id, Update) fazem parte da própria API e são iguais em qualquer idioma, mas as explicações não precisam ficar em inglês: a referência de métodos em português resume o que cada método faz, com parâmetros, tipos e exemplos em curl, Python e JavaScript.

Quando o Swagger é a ferramenta certa

Lembre-se de que o "Try it out" envia requisições reais: sendMessage manda uma mensagem de verdade e deleteWebhook remove mesmo o seu webhook. Faça os testes com um bot separado.

Privacidade

O Swagger roda inteiramente no seu navegador. As requisições vão direto da página para api.telegram.org, então nem o token nem o tráfego da API passam pelos nossos servidores. Se o token vazar mesmo assim, revogue-o com /revoke no @BotFather.

Para formulários tipados, long polling e histórico de atualizações, use o Bot API Tester. Precisa do ID de um chat para testar envios? Veja como descobrir o chat ID. Está criando um Mini App? Teste a API Telegram.WebApp no Mini App Tester.

Perguntas frequentes

Existe especificação OpenAPI para a Telegram Bot API?

O Telegram documenta a Bot API em core.telegram.org. Esta página oferece uma descrição OpenAPI 3.1 independente dos 185 métodos da Bot API 10.3, com o Swagger UI por cima; não é um produto oficial do Telegram.

Como autorizar no Swagger da Telegram Bot API?

Clique em Authorize e cole o token que você recebeu do @BotFather; se o bloco de servidores mostrar a variável token, preencha-a também. As requisições vão para https://api.telegram.org/bot<token>/METHOD_NAME direto do seu navegador.

O Try it out envia requisições reais?

Sim. O Execute chama a Bot API de verdade com o seu token, então métodos como sendMessage, deleteMessage, setWebhook ou logOut têm efeito real. Use um bot de teste nos experimentos.

Existe documentação da Telegram Bot API em português?

A documentação oficial em core.telegram.org é só em inglês. Neste site, a referência dos 185 métodos e os guias estão em português, com os nomes de métodos e parâmetros em inglês, como na própria API.

Qual versão da Bot API esta documentação cobre?

A Bot API 10.3 (24 de agosto de 2026): todos os 185 métodos em 19 tags, incluindo mensagens ricas e mensagens efêmeras, cada um com link para a documentação oficial.

Swagger ou Bot API Tester: qual usar?

Use o Swagger para navegar pela referência, comparar os schemas das requisições e copiar comandos curl. Use o Bot API Tester para formulários tipados, long polling com histórico de atualizações e verificações rápidas de token.