浏览文档目录

API

调度成员

虚拟成员调度相关接口。

鉴权: Authorization: Bearer sbot_…

GET/api/v1/bots/listChatVirtualMembers
Bot Token

listChatVirtualMemberslistChatVirtualMembers(增值能力)

列出群内可被调度的成员。需机器人在群内为活跃成员;该能力默认未对外开放,请通过开放平台支持申请开通后使用。

  • 必填 query:chat_id(群会话 ID)
  • 可选 query:limit (1-200,默认 50)、offset (0-1000,默认 0)、cursor;深页使用 cursor,不能同时传非零 offset
  • 返回:{ items: [{ virtual_user_id, name, username, avatar, joined_at }], pagination: { total, limit, offset, has_more, next_cursor, roster_epoch, roster_version } }
  • total 为展示人数,非当前可发送人数;按 has_more / next_cursor 翻页,items 为空仍可能有下一页
  • 403:当前授权、机器人或群资格失效;409:名册尚未切换或游标版本过期,需重新从首页枚举
POST/api/v1/bots/simulateSendMessage
Bot Token

simulateSendMessagesimulateSendMessage(增值能力)

以指定调度成员身份在群里发送文本、图片、文件、音频、视频或位置消息。准入要求与 `listChatVirtualMembers` 一致,消息提交前再次检查当前资格。

  • 公共必填:chat_id、virtual_user_id(来自 listChatVirtualMembers)
  • 消息类型:type 可选,缺省为 text;支持 text、photo / image、document / file、audio、video、location
  • 文本:text 必填,1-1000 字
  • 媒体:file_id 必填;caption 可选且 ≤1000 字;可按类型填写 duration、width、height、performer、title、thumbnail_url
  • 位置:latitude (-90..90)、longitude (-180..180) 必填;name (≤200)、address (≤500) 可选
  • 公共可选:reply_to_message_id (≤128);媒体 file_id 需先通过上传凭证与 complete 接口取得
  • 返回:与对应发送接口等价的消息对象
  • 400:参数不合法;403:授权被撤销、Bot 或目标身份不在群内、停用或禁言;409:名册尚未切换。枚举结果不能作为发送许可,成功响应在消息提交后返回