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返回 Webhook 信息。setWebhook设置 Webhook。deleteWebhook删除 Webhook。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)。editEphemeralMessageReplyMarkup编辑临时消息的回复标记 (Bot API 10.2)。deleteEphemeralMessage删除临时消息 (Bot API 10.2)。
编辑 7
editMessageText编辑消息文本。editMessageCaption编辑媒体说明文字。editMessageMedia编辑消息中的媒体。editMessageReplyMarkup编辑消息的回复标记。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响应预结账查询。getAvailableGifts返回机器人可发送的礼物。getUserGifts返回用户的礼物。getChatGifts返回聊天的礼物。convertGiftToStars将普通礼物兑换为 Telegram Stars。upgradeGift将普通礼物升级为唯一礼物。transferGift将唯一礼物转让给其他用户。
回调 6
answerCallbackQuery响应回调查询。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设置自定义 emoji 贴纸集缩略图。deleteStickerSet删除贴纸集。setStickerEmojiList修改贴纸的 emoji 列表。setStickerKeywords修改贴纸关键词。setStickerMaskPosition修改贴纸的遮罩位置。
游戏 3
sendGame发送游戏。setGameScore设置用户的游戏分数。getGameHighScores返回游戏高分榜。
动态 4
postStory代表商业账户发布动态。editStory代表商业账户编辑动态。deleteStory代表商业账户删除动态。repostStory在商业账户之间转发动态 (Bot API 9.3)。
商业 11
getBusinessAccountStarBalance返回商业账户的 Stars 余额。getBusinessAccountGifts返回商业账户的礼物。transferBusinessAccountStars将 Stars 从商业账户转移到机器人余额。readBusinessMessage代表商业账户将收到的消息标记为已读。deleteBusinessMessages代表商业账户删除消息。setBusinessAccountName设置商业账户名称。setBusinessAccountUsername设置商业账户用户名。setBusinessAccountBio设置商业账户个人简介。setBusinessAccountProfilePhoto设置商业账户头像。removeBusinessAccountProfilePhoto移除商业账户头像。setBusinessAccountGiftSettings配置商业账户的礼物设置。
其他 11
getCustomEmojiStickers返回自定义 emoji 贴纸信息。getUserChatBoosts返回用户在聊天中的助力。getBusinessConnection获取商业连接信息。savePreparedInlineMessage保存预先准备的内联消息。verifyUser代表组织认证用户。verifyChat代表组织认证聊天。removeUserVerification移除用户认证。removeChatVerification移除聊天认证。setUserEmojiStatus设置用户的 emoji 状态。savePreparedKeyboardButton为 Mini App 保存键盘按钮。setPassportDataErrors告知用户 Telegram Passport 错误。