v10.3 185 个方法
首页 文档 测试工具 Mini App 反馈
ZH

Telegram Bot API Swagger 中文文档:OpenAPI 3.1 在线调试

Telegram Bot API Swagger 把 Bot API 10.3 的全部 185 个方法整理成 OpenAPI 3.1 规范,按 19 个标签分组,用 Swagger UI 呈现为可交互的在线文档。每个方法都列出参数、类型和是否必填,并附有官方文档链接;授权 Bot Token 后,还能直接在页面上发送真实请求。配合中文的 方法参考,它就是一套随查随试的 Telegram Bot API 中文文档。

如何使用 Telegram Bot API Swagger 文档

  1. 从 @BotFather 获取 Bot Token,参见 Telegram Bot Token 获取教程。
  2. 点击 Authorize 并粘贴 Token。请求地址是 https://api.telegram.org/bot<token>/METHOD_NAME,所以如果服务器区域显示 token 变量,也要填上。
  3. 展开某个标签(例如消息、更新、临时消息),或用筛选框按方法名缩小范围。
  4. 打开一个方法,点击 Try it out,编辑 JSON 请求体(例如 sendMessage 需要填写 chat_id 和 text),再点击 Execute。
  5. 查看状态码、响应体、请求耗时以及自动生成的 curl 命令。

什么时候适合用 Swagger 文档

注意,“Try it out”发送的是真实请求:sendMessage 会真的发出消息,deleteWebhook 会真的删除你的 Webhook。做实验时请使用测试机器人。

Telegram Bot API 中文文档:Swagger 与方法参考

Telegram 官方的 Bot API 文档只有英文版。本站把中文资料分成两部分:Swagger 适合按 OpenAPI 结构浏览接口、在线调试;方法参考 则为每个方法单独提供一页中文说明,列出参数、类型、返回值以及 curl、Python、JavaScript 示例,适合边看边写代码。两者都基于 Bot API 10.3;参数说明是简要概括,完整定义以 core.telegram.org 为准。

想先快速验证 Token 和接口?在 Bot API Tester 中运行 getMe,一次调用就能确认 Token 是否有效。

隐私

Swagger 完全在浏览器中运行。请求从页面直接发送到 api.telegram.org,你的 Token 和 API 流量不会经过我们的服务器。万一 Token 泄露,请在 @BotFather 中用 /revoke 撤销。

需要类型化参数表单、Long Polling 和更新历史时,请使用 Bot API Tester;正在开发 Mini App,可以在 Mini App Tester 中测试 Telegram.WebApp API。刚开始接触 Bot API?先阅读 创建 Telegram 机器人教程。

常见问题

有没有 Telegram Bot API 中文文档?

Telegram 官方的 Bot API 文档只有英文版。本站提供中文的方法参考,185 个方法逐一列出参数、类型、返回值和 curl、Python、JavaScript 示例;配合本页的 Swagger,可以边查边在线调试。

Telegram Bot API 有 OpenAPI 规范吗?

Telegram 在 core.telegram.org 上发布 Bot API 文档。本页提供一份独立整理的 OpenAPI 3.1 描述,覆盖 Bot API 10.3 的全部 185 个方法,并用 Swagger UI 展示;它不是 Telegram 官方产品。

在 Telegram Bot API Swagger 中如何授权?

点击 Authorize,粘贴从 @BotFather 获得的 Token;如果服务器区域显示 token 变量,也要一并填写。之后请求会从浏览器直接发送到 https://api.telegram.org/bot<token>/METHOD_NAME。

Try it out 发送的是真实请求吗?

是的。Execute 会用你的 Token 调用真实的 Bot API,sendMessage、deleteMessage、setWebhook、logOut 等方法都会产生实际效果,建议使用专门的测试机器人。

这份文档对应哪个 Bot API 版本?

Bot API 10.3(2026 年 8 月 24 日):19 个标签共 185 个方法,包括富文本消息和临时消息,每个方法都附有官方文档链接。

该用 Swagger 还是 Bot API Tester?

想浏览参考、对比请求结构、复制 curl 命令时用 Swagger;需要类型化参数表单、带更新历史的 Long Polling 或快速检测 Token 时用 Bot API Tester。