浏览文档目录

API

机器人信息

查询与更新机器人自身资料、命令菜单。

鉴权: Authorization: Bearer sbot_…

GET/api/v1/bots/me
Bot Token

me获取当前机器人信息

基于 Bot Token 解析并返回机器人基础信息。

  • 返回:id、name、username、review_status、status、scopes、system_user_id、group_privacy(群隐私模式,默认 true)
POST/api/v1/bots/setMyShortDescription
Bot Token

setMyShortDescription设置短描述

设置机器人在主页 / 私聊「ⓘ」面板顶部展示的一句话短描述(≤120)。

  • 可选:short_description(≤120,留空清空)
  • 返回:bot_id / short_description
GET/api/v1/bots/getMyShortDescription
Bot Token

getMyShortDescription读取短描述

与 `setMyShortDescription` 配对,便于客户端回填。

  • 返回:{ short_description }
POST/api/v1/bots/setMyDescription
Bot Token

setMyDescription设置长描述

设置机器人在「关于」面板的多行说明。

  • 可选:description(≤512,留空清空)
  • 返回:bot_id / about
GET/api/v1/bots/getMyDescription
Bot Token

getMyDescription读取长描述

与 `setMyDescription` 配对。

  • 返回:{ description }(即 Bot.about)
POST/api/v1/bots/setMyCommands
Bot Token

setMyCommands设置命令菜单

配置 `/start`、`/help` 等命令;App 内输入 `/` 会拉出下拉提示。可按 `scope` / `language_code` 分组。

  • 必填:commands ({ command, description }[],1..100 项;command 仅 a-z0-9_,1..32 字符)
  • 可选:scope(default / all_private_chats / all_group_chats / all_chat_administrators 等,或 { type, chat_id?, user_id? })
  • 可选:language_code (BCP-47)
  • 返回:{ ok: true }
GET/api/v1/bots/getMyCommands
Bot Token

getMyCommands读取命令菜单

与 `setMyCommands` 配对,可按 `scope` / `language_code` 过滤。

  • 可选 query:scope、language_code
  • 返回:{ commands }
POST/api/v1/bots/deleteMyCommands
Bot Token

deleteMyCommands删除命令菜单

删除某个 `scope` + `language_code` 组合下的命令清单。

  • 可选:scope、language_code
  • 返回:{ ok: true }
POST/api/v1/bots/setMyFriendRequestMode
Bot Token

setMyFriendRequestMode设置好友申请策略

配置 `auto_accept` / `auto_reject` / `manual`;`manual` 时由机器人通过 `answerFriendRequest` 决定。

  • 必填:friend_request_mode
  • 返回:{ friend_request_mode }
GET/api/v1/bots/getMyFriendRequestMode
Bot Token

getMyFriendRequestMode读取好友申请策略

与 `setMyFriendRequestMode` 配对。

  • 返回:{ friend_request_mode }
POST/api/v1/bots/setMyGroupPrivacy
Bot Token

setMyGroupPrivacy设置群隐私模式

对标 TG BotFather `/setprivacy`:`enabled=false` 时机器人在群里收到全部普通消息;私聊不受影响。

  • 必填:enabled (Boolean,true=开启隐私 / false=收全部群消息)
  • 也可传 group_privacy(与 enabled 同义)
  • 返回:{ group_privacy }
GET/api/v1/bots/getMyGroupPrivacy
Bot Token

getMyGroupPrivacy读取群隐私模式

与 `setMyGroupPrivacy` 配对;开发者控制台也可通过 `PATCH /bots/my/:id` 修改 `group_privacy`。

  • 返回:{ group_privacy }
GET/api/v1/bots/getFriendRequests
Bot Token

getFriendRequests查看好友申请列表

列出当前机器人收到的 pending 申请;需要先把策略改为 `manual`。

  • 返回:items[](含 id、fromUserId、fromUsername、requestMessage、source、status)
POST/api/v1/bots/answerFriendRequest
Bot Token

answerFriendRequest处理好友申请

在 `manual` 模式下机器人主动接受 / 拒绝某个好友申请;接受后双方关系自动生效。

  • 必填:friendship_id、action (accept / reject)
  • 返回:处理结果
POST/api/v1/bots/verify-token
无(请求体带 token)

verify-token校验 Bot Token

调试用:使用请求体中的 `token` 参数校验有效性(公开端点)。

  • 必填:token
  • 返回:bot 对象或错误