متدهای 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وضعیت فعالیت در چت (typing و غیره) را ارسال می‌کند.sendMessageDraftپیش‌نویس پیام را ارسال می‌کند - پیش‌نمایش موقت (Bot API 9.5+).sendContactمخاطب ارسال می‌کند.sendLocationموقعیت مکانی ارسال می‌کند.sendVenueمکان ارسال می‌کند.setMessageReactionروی پیام واکنش می‌گذارد.sendChecklistاز طرف حساب تجاری چک‌لیست ارسال می‌کند.approveSuggestedPostپست پیشنهادی را در پیام‌های مستقیم تأیید می‌کند.declineSuggestedPostپست پیشنهادی را در پیام‌های مستقیم رد می‌کند.
پیام‌های غنی 2
sendRichMessageپیام غنی با قالب‌بندی ساختاریافته ارسال می‌کند (Bot API 10.1).sendRichMessageDraftبخشی از پیام غنی را استریم می‌کند — پیش‌نمایش 30 ثانیه‌ای (Bot API 10.1).
پیام‌های موقت 5
editEphemeralMessageTextمتن پیام موقت را ویرایش می‌کند (Bot API 10.2).editEphemeralMessageMediaرسانه پیام موقت را ویرایش می‌کند (Bot API 10.2).editEphemeralMessageCaptionکپشن پیام موقت را ویرایش می‌کند (Bot API 10.2).editEphemeralMessageReplyMarkupreply markup پیام موقت را ویرایش می‌کند (Bot API 10.2).deleteEphemeralMessageپیام موقت را حذف می‌کند (Bot API 10.2).
ویرایش 7
editMessageTextمتن پیام را ویرایش می‌کند.editMessageCaptionکپشن رسانه را ویرایش می‌کند.editMessageMediaرسانه پیام را ویرایش می‌کند.editMessageReplyMarkupreply markup پیام را ویرایش می‌کند.editMessageLiveLocationموقعیت زنده را ویرایش می‌کند.stopMessageLiveLocationموقعیت زنده را متوقف می‌کند.editMessageChecklistچک‌لیست را ویرایش می‌کند.
رسانه 12
sendPhotoعکس ارسال می‌کند.sendVideoویدیو ارسال می‌کند.sendDocumentفایل ارسال می‌کند.sendAudioفایل صوتی ارسال می‌کند.sendAnimationانیمیشن (GIF) ارسال می‌کند.sendStickerاستیکر ارسال می‌کند.sendVoiceپیام صوتی ارسال می‌کند.sendVideoNoteپیام ویدیویی (ویدیوی دایره‌ای) ارسال می‌کند.sendMediaGroupگروهی از رسانه‌ها (آلبوم) ارسال می‌کند.sendPaidMediaرسانه پولی ارسال می‌کند (Bot API 8.0+).sendDiceتاس ارسال می‌کند.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به کوئری ارسال پاسخ می‌دهد.answerPreCheckoutQueryبه کوئری pre-checkout پاسخ می‌دهد.getAvailableGiftsهدیه‌هایی را که ربات می‌تواند ارسال کند برمی‌گرداند.getUserGiftsهدیه‌های کاربر را برمی‌گرداند.getChatGiftsهدیه‌های چت را برمی‌گرداند.convertGiftToStarsهدیه معمولی را به Telegram Stars تبدیل می‌کند.upgradeGiftهدیه معمولی را به هدیه منحصربه‌فرد ارتقا می‌دهد.transferGiftهدیه منحصربه‌فرد را به کاربر دیگری منتقل می‌کند.
کال‌بک‌ها 6
answerCallbackQueryبه کوئری callback پاسخ می‌دهد.answerInlineQueryبه کوئری اینلاین پاسخ می‌دهد.answerGuestQueryبه کوئری مهمان پاسخ می‌دهد - حالت مهمان (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تاپیک General انجمن را ویرایش می‌کند.closeGeneralForumTopicتاپیک General انجمن را می‌بندد.reopenGeneralForumTopicتاپیک General انجمن را دوباره باز می‌کند.hideGeneralForumTopicتاپیک General انجمن را پنهان می‌کند.unhideGeneralForumTopicتاپیک General انجمن را از حالت پنهان خارج می‌کند.getForumTopicIconStickersاستیکرهای آیکون تاپیک انجمن را برمی‌گرداند.unpinAllForumTopicMessagesهمه پیام‌های سنجاق‌شده تاپیک انجمن را برمی‌دارد.unpinAllGeneralForumTopicMessagesهمه پیام‌های سنجاق‌شده تاپیک General را برمی‌دارد.
فایل‌ها 1
getFileاطلاعات فایل را برای دانلود دریافت می‌کند.
استیکرها 14
getStickerSetمجموعه استیکر را برمی‌گرداند.uploadStickerFileفایل استیکر را آپلود می‌کند.createNewStickerSetمجموعه استیکر جدید ایجاد می‌کند.addStickerToSetاستیکر را به مجموعه اضافه می‌کند.replaceStickerInSetاستیکری را در مجموعه جایگزین می‌کند.setStickerPositionInSetجای استیکر را در مجموعه تغییر می‌دهد.deleteStickerFromSetاستیکر را از مجموعه حذف می‌کند.setStickerSetTitleعنوان مجموعه استیکر را تنظیم می‌کند.setStickerSetThumbnailتصویر بندانگشتی مجموعه استیکر را تنظیم می‌کند.setCustomEmojiStickerSetThumbnailتصویر بندانگشتی مجموعه استیکر ایموجی سفارشی را تنظیم می‌کند.deleteStickerSetمجموعه استیکر را حذف می‌کند.setStickerEmojiListفهرست ایموجی‌های استیکر را تغییر می‌دهد.setStickerKeywordsکلیدواژه‌های استیکر را تغییر می‌دهد.setStickerMaskPositionموقعیت ماسک استیکر را تغییر می‌دهد.
بازی‌ها 3
sendGameبازی ارسال می‌کند.setGameScoreامتیاز بازی کاربر را تنظیم می‌کند.getGameHighScoresبالاترین امتیازهای بازی را برمی‌گرداند.
استوری‌ها 4
postStoryاز طرف حساب تجاری استوری منتشر می‌کند.editStoryاستوری را از طرف حساب تجاری ویرایش می‌کند.deleteStoryاستوری را از طرف حساب تجاری حذف می‌کند.repostStoryاستوری را بین حساب‌های تجاری بازنشر می‌کند (Bot API 9.3).
بیزینس 11
getBusinessAccountStarBalanceموجودی Stars حساب تجاری را برمی‌گرداند.getBusinessAccountGiftsهدیه‌های حساب تجاری را برمی‌گرداند.transferBusinessAccountStarsStars را از حساب تجاری به موجودی ربات منتقل می‌کند.readBusinessMessageپیام دریافتی را از طرف حساب تجاری خوانده‌شده علامت می‌زند.deleteBusinessMessagesپیام‌ها را از طرف حساب تجاری حذف می‌کند.setBusinessAccountNameنام حساب تجاری را تنظیم می‌کند.setBusinessAccountUsernameنام کاربری حساب تجاری را تنظیم می‌کند.setBusinessAccountBioبیوی حساب تجاری را تنظیم می‌کند.setBusinessAccountProfilePhotoعکس پروفایل حساب تجاری را تنظیم می‌کند.removeBusinessAccountProfilePhotoعکس پروفایل حساب تجاری را حذف می‌کند.setBusinessAccountGiftSettingsتنظیمات هدیه حساب تجاری را پیکربندی می‌کند.
سایر 11
getCustomEmojiStickersاطلاعات استیکرهای ایموجی سفارشی را برمی‌گرداند.getUserChatBoostsبوست‌های کاربر در چت را برمی‌گرداند.getBusinessConnectionاطلاعات اتصال تجاری را دریافت می‌کند.savePreparedInlineMessageپیام اینلاین آماده را ذخیره می‌کند.verifyUserکاربر را از طرف یک سازمان تأیید می‌کند.verifyChatچت را از طرف یک سازمان تأیید می‌کند.removeUserVerificationتأیید کاربر را حذف می‌کند.removeChatVerificationتأیید چت را حذف می‌کند.setUserEmojiStatusوضعیت ایموجی کاربر را تنظیم می‌کند.savePreparedKeyboardButtonدکمه کیبورد را برای Mini App ذخیره می‌کند.setPassportDataErrorsکاربر را از خطاهای Telegram Passport مطلع می‌کند.