API 参考
从运行时动作目录生成的 OpenAPI:参数、应答、示例和试调
SnowLuma 的 HTTP API 与 OneBot v11 兼容。每个动作一页,由 OpenAPI 插件渲染:请求体、鉴权、应答信封、代码示例,以及对着你自己的实例试调。
怎么调用
- 方法:
POST /{动作名} - 请求体:
Content-Type: application/json - 默认服务:
http://127.0.0.1:3000/(同一 Docker 网络里用http://snowluma:3000/) - 鉴权(配置了 token 时):
Authorization: Bearer <token>,或查询参数?access_token= - WebSocket:
ws://127.0.0.1:3001/,动作名与 HTTP 相同
应答信封
HTTP 200 仍可能是业务失败。看信封里的 retcode:
{
"status": "ok",
"retcode": 0,
"data": {},
"message": "",
"wording": ""
}retcode 为 0 才是成功。data 的形状见各动作页。
在文档里试调
打开任意动作页,填服务地址和 token,用试调面板直接发请求。请求发自你的浏览器,目标是你填的服务器,不是文档站。
MCP 客户端不必手写 HTTP,见 MCP。
全部动作
扩展
115 个动作
- 删除群公告(fid 或 notice_id 二选一) POST
- 获取指定 QQ 号正在使用的个性装扮(挂件/名片/来电/输入状态等) POST
- 获取群公告 POST
- 获取机型展示(兼容 mock) POST
- 标记全部已读 POST
- 发送群公告(支持置顶、弹窗、新成员、群昵称引导与确认) POST
- 设置机型展示(占位) POST
- 分词(未实现) POST
- 添加收藏表情 POST
- 退出机器人 POST
- 取消群待办 POST
- 检查链接安全性 POST
- 清理缓存 POST
- 点击内联键盘按钮 POST
- 完成群待办 POST
- 创建收藏(未实现) POST
- 创建闪传任务 POST
- 删除收藏表情 POST
- 移除精华消息 POST
- 删除闪传文件 POST
- 删除群文件夹 POST
- 下载文件(url 或 base64)到 data/downloads POST
- 解析闪传文件下载直链(不下载,由调用方实现下载) POST
- 获取自定义表情 POST
- 获取自定义表情详情 POST
- 获取表情回应用户(NapCat 分页) POST
- 获取语音转文字结果 POST
- 转发单条消息给好友 POST
- 转发单条消息到群 POST
- 好友拍一拍 POST
- 获取 AI 语音角色 POST
- 生成 AI 语音 POST
- 获取 clientkey POST
- 获取收藏列表 POST
- 获取 Cookies POST
- 获取凭证 POST
- 获取 CSRF 令牌 POST
- 获取可疑好友申请 POST
- 获取表情回应用户 POST
- 获取精华消息列表 POST
- 获取文件信息(仅图片/语音缓存;群文件请用 get_group_file_url) POST
- 从 QQ 闪传分享码或官方分享链接获取 fileset_id POST
- 获取文件集信息 POST
- 获取闪传文件列表 POST
- 获取闪传文件链接 POST
- 获取合并转发消息(id 或 message_id) POST
- 获取好友消息历史(无锚点时从服务器获取最新双向记录) POST
- 获取分组好友列表 POST
- 获取群 @全体成员 剩余次数 POST
- 获取群详细信息 POST
- 获取群文件系统信息 POST
- 获取被忽略的入群请求(NapCat) POST
- 获取被过滤的入群请求 POST
- 获取群信息(扩展) POST
- 获取群消息历史 POST
- 获取群禁言列表 POST
- 获取群今日打卡列表 POST
- 获取群待办列表 POST
- 获取图片信息 POST
- 获取小程序卡片 ark POST
- 获取一条消息的全部表情回应 POST
- 获取在线客户端 POST
- 获取资料点赞 POST
- 获取最近会话(占位) POST
- 获取语音信息;传 out_format 则服务端转码并附带 base64 POST
- 获取下载 rkey POST
- 获取 rkey 服务器信息 POST
- 获取文件分享链接 POST
- 获取单向好友列表 POST
- 群拍一拍 POST
- 列出当前账号的所有闪传文件集 POST
- 标记群消息已读 POST
- 标记消息已读(群聊/私聊自动路由) POST
- 标记私聊消息已读 POST
- 修改收藏表情备注 POST
- 收藏表情移到最前 POST
- 获取 packet 状态(占位) POST
- 获取用户在线/扩展状态 POST
- OCR 图片(服务端,需图片 URL 或已缓存的图片 file_id) POST
- 重命名闪传文件 POST
- 请求数据库解密密钥 POST
- 分享用户/群 Ark 卡片(NapCat 标准名) POST
- 发送闪传消息(私聊或群聊,引用 fileset_id 让对端下载) POST
- 发送合并转发(按 message_type/群号自动路由) POST
- 发送 AI 语音到群 POST
- 分享群 Ark 卡片(NapCat 标准名) POST
- 发送群合并转发 POST
- 点赞 POST
- 发送原始 SSO 包(cmd + hex data) POST
- 拍一拍(群聊/私聊自动路由) POST
- 发送私聊合并转发 POST
- 发送图文 Ark 卡片(私聊/群聊) POST
- 设置自定义在线状态 POST
- 处理可疑好友申请 POST
- 设置精华消息 POST
- 设置好友备注 POST
- 移动好友到指定分组 POST
- 群聊表情回应 POST
- 设置群备注 POST
- 设置群机器人加群选项 POST
- 群签到 POST
- 设置群待办 POST
- 设置输入状态 POST
- 设置消息表情回应 POST
- 设置在线状态 POST
- 设置 QQ 头像 POST
- 设置 QQ 资料 POST
- 重启(不支持) POST
- 设置个性签名(longNick/long_nick,严格 string) POST
- 分享群 Ark 卡片 POST
- 分享用户/群 Ark 卡片 POST
- 转存群文件 POST
- 英译中 POST
- 上传转发消息 POST
- 上传转发消息(别名拼写) POST
群管理
21 个动作
- 向某个群分类添加资料标签 POST
- 从某个群分类移除资料标签 POST
- 获取群管理设置的当前值 POST
- 读取某个群分类下的资料标签 POST
- 设置加群选项 POST
- 设置/取消管理员 POST
- 匿名开关(未实现,返回 ok) POST
- 匿名禁言(未实现,返回 ok) POST
- 禁言群成员(duration=0 解除) POST
- 设置群名片(空字符串清除) POST
- 踢出群成员 POST
- 批量踢出群成员 POST
- 退群 POST
- 设置群成员邀请策略 POST
- 设置群成员权限(仅群主可改) POST
- 设置群名 POST
- 设置新成员是否可查看历史消息 POST
- 设置群头像 POST
- 设置群被搜索方式(群指纹 / 群号搜索开关) POST
- 设置群头衔 POST
- 全员禁言开关 POST
信息
5 个动作
群相册
9 个动作
流式接口
6 个动作
空间
9 个动作
- 评论一条说说(QQ 空间,支持纯文字或带图;传 images 自动上传) POST
- 删除一条说说(QQ 空间,按 tid) POST
- 获取 QQ 空间好友动态(feed);page_num 仅首页可靠,深翻页需时间游标(暂未实现) POST
- 获取 QQ 空间说说列表(默认机器人自己的空间) POST
- 给一条说说点赞(QQ 空间) POST
- 发表说说(QQ 空间,支持纯文字或带图;传 images 自动上传;可设置查看权限) POST
- 拉黑或解除拉黑某人(修改机器人自身 QQ 空间黑名单;enable=true 拉黑,false 解除) POST
- 修改一条已发说说的查看权限(QQ 空间,按 tid) POST
- 取消对一条说说的点赞(QQ 空间;取消赞端点待真机核实) POST
群文件
12 个动作
好友
3 个动作
消息
6 个动作
系统表情
4 个动作
群信息
6 个动作
请求
2 个动作
这篇文档有帮助吗?
最后更新于