SoChatSoChat

API

Profile

Read and update the bot profile and command menu.

Back to index

Auth: Authorization: Bearer sbot_…

GET/api/v1/bots/me
Bot Token

me获取当前机器人信息

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

  • Returns：id、name、username、review_status、status、scopes、system_user_id、group_privacy（群隐私模式，默认 true）
POST/api/v1/bots/setMyShortDescription
Bot Token

setMyShortDescriptionSet Short Description

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

  • Optional：short_description（≤120，留空清空）
  • Returns：bot_id / short_description
GET/api/v1/bots/getMyShortDescription
Bot Token

getMyShortDescriptionGet Short Description

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

  • Returns：{ short_description }
POST/api/v1/bots/setMyDescription
Bot Token

setMyDescriptionSet Description

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

  • Optional：description（≤512，留空清空）
  • Returns：bot_id / about
GET/api/v1/bots/getMyDescription
Bot Token

getMyDescriptionGet Description

与 `setMyDescription` 配对。

  • Returns：{ description }（即 Bot.about）
POST/api/v1/bots/setMyCommands
Bot Token

setMyCommandsSet Commands

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

  • Required: commands ({ command, description }[], 1..100 items; command can only contain a-z0-9_, 1..32 characters)
  • Optional: scope (default / all_private_chats / all_group_chats / all_chat_administrators, etc., or { type, chat_id?, user_id? })
  • Optional：language_code (BCP-47)
  • Returns：{ ok: true }
GET/api/v1/bots/getMyCommands
Bot Token

getMyCommandsGet Commands

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

  • Optional query：scope、language_code
  • Returns：{ commands }
POST/api/v1/bots/deleteMyCommands
Bot Token

deleteMyCommandsDelete Commands

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

  • Optional：scope、language_code
  • Returns：{ ok: true }
POST/api/v1/bots/setMyFriendRequestMode
Bot Token

setMyFriendRequestModeSet Friend Request Mode

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

  • Required：friend_request_mode
  • Returns：{ friend_request_mode }
GET/api/v1/bots/getMyFriendRequestMode
Bot Token

getMyFriendRequestModeGet Friend Request Mode

与 `setMyFriendRequestMode` 配对。

  • Returns：{ friend_request_mode }
POST/api/v1/bots/setMyGroupPrivacy
Bot Token

setMyGroupPrivacySet Group Privacy Mode

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

  • Required：enabled (Boolean，true=开启隐私 / false=收全部群消息)
  • 也可传 group_privacy（与 enabled 同义）
  • Returns：{ group_privacy }
GET/api/v1/bots/getMyGroupPrivacy
Bot Token

getMyGroupPrivacyGet Group Privacy Mode

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

  • Returns：{ group_privacy }
GET/api/v1/bots/getFriendRequests
Bot Token

getFriendRequestsList Friend Requests

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

  • Returns：items[]（含 id、fromUserId、fromUsername、requestMessage、source、status）
POST/api/v1/bots/answerFriendRequest
Bot Token

answerFriendRequestAnswer Friend Request

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

  • Required：friendship_id、action (accept / reject)
  • Returns：处理结果
POST/api/v1/bots/verify-token
无（请求体带 token）

verify-tokenVerify Bot Token

For debugging: use `token` in request body to verify validity (public endpoint).

  • Required：token
  • Returns：bot 对象或错误