v10.3 185 متد
خانه مستندات تستر Mini App بازخورد
FA

مستندات Telegram Bot API با Swagger و OpenAPI 3.1

این صفحه مستندات Telegram Bot API را به‌صورت تعاملی در Swagger UI نمایش می‌دهد: یک مشخصات OpenAPI 3.1 مستقل برای همه 185 متد Bot API 10.3 که در 19 تگ دسته‌بندی شده‌اند. اگر دنبال مستندات API تلگرام هستید که بتوانید همان‌جا امتحانش کنید، برای هر متد پارامترها با نوع داده و وضعیت الزامی، لینک مستندات رسمی و امکان اجرای زنده با توکن ربات در دسترس است.

روش استفاده از مستندات Telegram Bot API در Swagger

  1. توکن ربات را از @BotFather بگیرید؛ مراحل در راهنمای دریافت توکن ربات تلگرام آمده است.
  2. روی Authorize کلیک کنید و توکن را وارد کنید. درخواست‌ها به https://api.telegram.org/bot<token>/METHOD_NAME ارسال می‌شوند؛ پس اگر در بخش server متغیر token را می‌بینید، آن را هم پر کنید.
  3. یک تگ مثل پیام‌ها (Messages)، آپدیت‌ها (Updates) یا پیام‌های موقت (Ephemeral) را باز کنید یا با کادر فیلتر فهرست را محدود کنید.
  4. متد را باز کنید، روی Try it out بزنید، بدنه JSON را ویرایش کنید (برای sendMessage یعنی chat_id و text) و سپس روی Execute کلیک کنید.
  5. کد وضعیت، بدنه پاسخ، مدت زمان درخواست و دستور curl تولیدشده را بررسی کنید.

چه زمانی مستندات Swagger به کار می‌آید

توجه کنید که Try it out درخواست واقعی می‌فرستد: sendMessage واقعاً پیام ارسال می‌کند و deleteWebhook واقعاً وب‌هوک شما را حذف می‌کند. برای آزمایش از یک ربات تستی استفاده کنید.

حریم خصوصی

Swagger کاملاً در مرورگر شما اجرا می‌شود. درخواست‌ها مستقیماً از همین صفحه به api.telegram.org می‌روند و توکن و ترافیک API شما هرگز از سرورهای ما عبور نمی‌کند. اگر با این حال توکن لو رفت، آن را با /revoke در @BotFather باطل کنید.

برای فرم‌های تایپ‌شده، Long Polling و تاریخچه آپدیت‌ها از Bot API Tester استفاده کنید. صفحه جداگانه هر متد با مثال‌های curl، Python و JavaScript در مرجع متدها قرار دارد. اگر Mini App می‌سازید، API مربوط به Telegram.WebApp را در Mini App Tester تست کنید.

پرسش‌های متداول

آیا Telegram Bot API مشخصات OpenAPI دارد؟

تلگرام Bot API را در core.telegram.org مستند کرده است. این صفحه یک توصیف OpenAPI 3.1 مستقل از همه 185 متد Bot API 10.3 همراه با Swagger UI ارائه می‌دهد و محصول رسمی تلگرام نیست.

چطور در Swagger مربوط به Telegram Bot API احراز هویت کنم؟

روی Authorize کلیک کنید و توکنی را که از @BotFather گرفته‌اید وارد کنید؛ اگر در بخش server متغیر token نمایش داده می‌شود، آن را هم پر کنید. پس از آن درخواست‌ها مستقیماً از مرورگر شما به https://api.telegram.org/bot<token>/METHOD_NAME ارسال می‌شوند.

آیا Try it out درخواست واقعی ارسال می‌کند؟

بله. دکمه Execute با توکن شما Bot API واقعی را فراخوانی می‌کند، پس متدهایی مثل sendMessage، deleteMessage، setWebhook یا logOut اثر واقعی دارند. برای آزمایش از یک ربات تستی استفاده کنید.

این مستندات کدام نسخه Bot API را پوشش می‌دهد؟

Bot API 10.3 (منتشرشده در 24 اوت 2026): همه 185 متد در 19 تگ، از جمله پیام‌های غنی و پیام‌های موقت، و برای هر متد لینک مستندات رسمی.

از Swagger استفاده کنم یا Bot API Tester؟

Swagger برای مرور مرجع، مقایسه ساختار درخواست‌ها و کپی دستورهای curl مناسب است. Bot API Tester برای فرم‌های تایپ‌شده، Long Polling با تاریخچه آپدیت‌ها و بررسی سریع توکن راحت‌تر است.

آیا مستندات Telegram Bot API به فارسی هم وجود دارد؟

بله، مرجع متدهای این سایت هر 185 متد را با توضیح کوتاه فارسی، جدول پارامترها و مثال‌های curl، Python و JavaScript ارائه می‌دهد. مستندات رسمی و کامل تلگرام در core.telegram.org به زبان انگلیسی است.