外观
API 总览
正向与反向 WebSocket SDK 提供相同的 API。除特别注明外，所有 API 都返回 Promise，成功时解析为业务数据，失败时抛出错误。
消息与媒体
| API | 说明 |
|---|---|
| 发送群聊消息 | 向指定群聊发送消息 |
| 发送好友消息 | 向指定好友发送消息 |
| 上传群聊图片 | 上传图片并生成图片消息段 |
| 上传群聊语音 | 上传 MP3 语音并生成语音消息段 |
| 上传群聊视频 | 上传 MP4 视频并生成视频消息段 |
| 获取群聊合并转发消息 | 获取合并转发的完整内容 |
| 发送群聊合并转发消息 | 创建文本合并转发消息 |
好友与空间
| API | 说明 |
|---|---|
| 获取好友列表 | 获取完整好友列表 |
| 删除好友 | 删除指定好友 |
| 获取好友动态 | 获取好友空间最新动态 |
| 点赞好友动态 | 点赞指定动态 |
| 取消好友动态点赞 | 取消指定动态的点赞 |
| 获取 QQ 名片 | 获取自己或指定用户的 QQ 名片 |
| 点赞 QQ 名片 | 点赞指定用户的 QQ 名片 |
| 获取 skey | 获取当前 Bot 的 skey |
| 获取 clientkey | 获取十六进制 clientkey |
| 获取 PsKey | 获取指定域名的 PsKey |
群聊管理
| API | 说明 |
|---|---|
| 获取群聊列表 | 获取完整群聊列表 |
| 获取群聊成员列表 | 获取指定群聊的成员 |
| 获取群聊系统通知 | 获取群聊申请与通知 |
| 同意加入群聊申请 | 同意指定申请 |
| 拒绝加入群聊申请 | 拒绝指定申请 |
| 同意群聊邀请 | 同意好友发来的群聊邀请 |
| 设置群聊管理员 | 设置或取消管理员 |
| 群聊打卡 | 在指定群聊打卡 |
| 设置群聊成员禁言 | 设置或取消成员禁言 |
| 设置群聊全员禁言 | 开启或取消全员禁言 |
| 撤回群聊消息 | 撤回指定群聊消息 |
Bot 管理
| API | 说明 |
|---|---|
| 获取 Bot 列表 | 获取当前节点的 Bot 列表 |
| 获取协议列表 | 获取可选协议 |
| 获取设备指纹列表 | 获取可选设备指纹 |
| 添加账号 | 向当前节点添加账号 |
| 编辑账号 | 编辑离线账号配置 |
| 离线账号 | 取消正在进行的登录，或下线已登录账号 |
| 删除账号 | 删除当前节点下的离线账号 |
| 密码登录 | 发起密码登录 |
| 检查登录缓存 | 检查本地登录缓存 |
| 缓存登录 | 使用本地缓存登录 |
| 提交滑块验证 | 提交滑块结果 |
| 查询安全验证方式 | 查询安全验证原因与可用方式 |
| 创建登录二维码 | 创建安全验证登录二维码 |
| 查询登录二维码状态 | 查询扫码状态并在确认后继续登录 |
| 获取短信验证码 | 下发安全验证短信 |
| 提交短信验证码 | 提交短信验证码并继续登录 |
通用约定
self_id是执行 API 的在线 Bot QQ 号。self_id是 Bot 管理 API 操作的 QQ 号。- 插件只能访问管理后台中绑定节点下的 Bot。
- Bot API 通常要求目标 Bot 在线。
- SDK请求超时为 30 秒。