Skip to content

API 参考 ​

通过已认证的 WebSocket 服务调用接口。Node.js SDK 的正向与反向连接使用相同方法;成功时 Promise 返回业务数据,失败时抛出异常。

调用方式 ​

js
const androidApi = api.forProtocol('android')
const linuxApi = api.forProtocol('linuxqq')
const info = await androidApi.get_login_info(self_id)

账号接口使用 self_id 指定 QQ。client_type 取 android 或 linuxqq;SDK 未设置协议作用域时默认 Android。服务管理接口是否需要账号参数,以各接口参数表为准。

WebSocket 请求 ​

json
{
  "type": "action",
  "id": "request-1",
  "action": "get_login_info",
  "params": { "self_id": 123456789, "client_type": "android" }
}

成功响应 ​

json
{
  "type": "action_result",
  "id": "request-1",
  "ok": true,
  "data": { "user_id": 123456789, "nickname": "示例账号", "client_type": "android" }
}

错误响应 ​

json
{
  "type": "action_result",
  "id": "request-1",
  "ok": false,
  "error": "账号未在线"
}

各接口的返回说明对应 data。流式接口通过回调接收分片,详见 download_file_stream。连接与认证见 SDK 接入,推送格式见 事件参考。

系统信息 ​

API可用协议说明
获取登录信息Android / Linux 双协议可用读取当前账号 ID、昵称和客户端类型
获取运行状态Android / Linux 双协议可用读取当前账号连接状态与本地收发统计
获取版本信息Android / Linux 双协议可用读取萌卡 NT 和插件协议版本
检查图片发送能力Android / Linux 双协议可用查询当前账号平台是否支持图片发送
检查语音发送能力Android / Linux 双协议可用查询当前账号平台是否支持语音发送
下载文件Android / Linux 双协议可用将公网 HTTP/HTTPS 文件安全下载到框架隔离目录
上传文件流Android / Linux 双协议可用分片上传文件到框架临时目录
清理流临时文件Android / Linux 双协议可用清理上传流状态与临时文件
测试流式传输Android / Linux 双协议可用发送十个测试分片并返回完成结果
流式下载文件Android / Linux 双协议可用通过分片帧下载文件
流式下载图片Android / Linux 双协议可用通过分片帧下载图片并返回宽高
流式下载语音Android / Linux 双协议可用通过分片帧下载语音并可转换格式
获取在线客户端Android / Linux 双协议可用返回账号在线设备列表
设置在线状态Android 协议可用设置在线、离开、忙碌、隐身及扩展状态
设置自定义在线状态Android 协议可用设置自定义状态图标和文字
设置正在输入状态Android 协议可用向指定好友同步正在输入或结束输入状态
获取用户在线状态Android / Linux 双协议可用查询指定 QQ 当前的在线状态与扩展状态
重启框架服务Android / Linux 双协议可用保留账号缓存会话并重启当前框架进程
检查网址安全性Android / Linux 双协议可用由 QQ Android 服务返回安全、未知或危险等级
英文翻译为中文Android / Linux 双协议可用调用 QQ Android 批量翻译服务
发送原始协议包Android 协议可用使用当前账号会话发送已组装的原生协议包
获取在线机型显示Android 协议可用使用账号会话和设备指纹查询 QQ 服务端可用机型名称
设置在线机型显示Android 协议可用设置在线机型名称,或恢复 QQ 默认显示

消息与媒体 ​

API可用协议说明
发送群聊消息Android / Linux 双协议可用向指定群聊发送消息
发送好友消息Android / Linux 双协议可用向指定好友发送消息
发送消息Android / Linux 双协议可用按好友或群聊目标复用现有消息发送链路
获取群聊历史消息Android / Linux 双协议可用从 QQ 服务器按消息序号分页读取群聊历史消息
获取好友历史消息Android / Linux 双协议可用从 QQ 服务器按消息时间分页读取好友漫游消息
转发单条好友消息Android 协议可用将进程内缓存消息重新发送给指定好友
转发单条群消息Android 协议可用将进程内缓存消息重新发送到指定群聊
上传好友图片Android / Linux 双协议可用上传好友聊天图片
设置 QQ 头像Android 协议可用通过 Highway 上传当前 Bot 头像
上传群聊图片Android / Linux 双协议可用上传图片并生成图片消息段
上传群聊语音Android / Linux 双协议可用上传音频并生成语音消息段
上传群聊视频Android / Linux 双协议可用上传 MP4 视频并生成视频消息段
获取群聊合并转发消息Android / Linux 双协议可用获取合并转发的完整内容
获取合并转发消息Android / Linux 双协议可用从消息 ID 或资源 ID 获取合并转发节点
发送群聊合并转发消息Android / Linux 双协议可用创建文本合并转发消息
生成好友分享 ArkAndroid 协议可用根据现有好友资料生成联系人分享 Ark
生成好友分享 Ark(通用 action)Android 协议可用与 ArkSharePeer 使用同一套萌卡原生处理链路
生成群聊分享 ArkAndroid 协议可用根据现有群资料生成群聊分享 Ark
生成群聊分享 Ark(通用 action)Android 协议可用与 ArkShareGroup 使用同一套萌卡原生处理链路
发送群红包Android 协议可用发送拼手气、普通、专属、语音或口令群红包
查询红包详细信息Android 协议可用查询收到的 QQ 红包状态与金额信息
领取红包Android 协议可用领取收到的 QQ 群红包
获取群聊可领取红包Android 协议可用获取指定群聊中当前仍可领取的红包
获取可领取红包Android 协议可用与群聊可领取红包查询使用同一套萌卡原生处理链路
获取消息Android / Linux 双协议可用读取框架保留的标准消息引用和消息段
获取闪照原图地址Android 协议可用读取当前账号实时收到的闪照原图地址与图片信息
生成音乐 Ark 卡片Android 协议可用根据 QQ 或网易云歌曲信息生成带内容绑定签名的可播放音乐卡片
分页获取消息表情回应Android 协议可用分页获取指定群消息的表情回应用户
获取全部消息表情回应Android 协议可用自动翻页获取指定群消息的全部表情回应用户
发送私聊消息Android / Linux 双协议可用按用户 ID 使用萌卡原生好友消息链路发送消息
发送群临时会话消息Android / Linux 双协议可用通过共同群聊向非好友群成员发起临时私聊
撤回消息Android / Linux 双协议可用根据消息引用自动分派群聊或私聊撤回
标记群聊已读Android / Linux 双协议可用将指定群消息序号作为群聊已读游标上报
标记私聊已读Android / Linux 双协议可用将指定好友消息时间作为私聊已读游标上报
标记消息已读Android / Linux 双协议可用自动识别群聊或私聊并上报已读游标
设置群头像Android 协议可用按 QQ Android 9.2.70 的真实上传链路设置群聊头像
上传私聊文件Android / Linux 双协议可用通过 QQ Android 9.2.70 离线文件通道向好友发送文件
发送合并转发消息Android / Linux 双协议可用按 user_id 或 group_id 自动选择私聊或群聊目标
发送私聊合并转发消息Android / Linux 双协议可用创建文本合并转发消息并发送给指定好友
生成小程序 Ark 卡片Android 协议可用生成可发送的小程序 Ark 数据
获取 AI 声音角色Android 协议可用获取群聊可用的 AI 声音角色列表
生成 AI 语音Android 协议可用合成 AI 语音并返回可访问地址
发送群聊 AI 语音Android 协议可用合成并直接发送群聊 AI 语音
识别语音文字Android 协议可用识别框架消息缓存中的群语音
设置消息表情回应Android 协议可用添加或取消群消息表情回应
标记所有消息已读Android / Linux 双协议可用批量上报框架近期缓存的最新会话游标
处理事件快速操作Android 协议可用根据消息或申请事件上下文执行回复、撤回、群管理和申请处理

好友与空间 ​

API可用协议说明
获取好友列表Android / Linux 双协议可用获取完整好友列表
获取单向好友列表Android 协议可用获取当前账号的真实单向好友关系
获取资料获赞Android 协议可用获取当前登录 QQ 的真实资料获赞记录与统计
获取可疑好友申请Android 协议可用获取 QQ 标记为可疑的待处理好友申请
删除好友Android 协议可用删除指定好友
获取好友动态Android 协议可用获取好友空间最新动态
发布空间动态Android 协议可用发布一条文本空间动态
点赞好友动态Android 协议可用点赞指定动态
取消好友动态点赞Android 协议可用取消指定动态的点赞
获取 QQ 名片Android / Linux 双协议可用获取自己或指定用户的 QQ 名片
点赞 QQ 名片Android / Linux 双协议可用点赞指定用户的 QQ 名片
获取 skeyAndroid / Linux 双协议可用获取当前 Bot 的 skey
获取 User-AgentAndroid / Linux 双协议可用获取当前 Bot 协议和设备指纹对应的 User-Agent
获取 clientkeyAndroid / Linux 双协议可用获取十六进制 clientkey
获取 PsKeyAndroid / Linux 双协议可用获取指定域名的 PsKey
获取媒体 RKeyAndroid 协议可用读取框架后台已维护的媒体 RKey 缓存
获取媒体 RKey(通用 action)Android 协议可用与 get_rkey 使用同一套萌卡原生缓存
获取媒体 RKey 服务信息Android 协议可用读取私聊、群聊 RKey 与统一过期时间
获取最近会话Android 协议可用获取框架近期观察到的私聊与群聊会话
设置好友备注Android 协议可用设置或清除指定好友的备注
处理好友申请Android / Linux 双协议可用同意或拒绝好友申请,可在同意时设置备注
主动申请加好友Android / Linux 双协议可用提交好友申请,不等同于好友关系已建立
主动申请入群Android 协议可用Android 提交入群说明,不等同于账号已入群
主动退群Android / Linux 双协议可用当前账号退出群聊,禁止群主调用,不提供解散群能力
修改群名Android / Linux 双协议可用设置群名称,以服务器确认及通知为准
设置精华消息Android / Linux 双协议可用设置或取消已缓存群消息的精华状态
戳一戳Android / Linux 双协议可用向好友或群成员发送普通戳一戳
处理可疑好友申请Android 协议可用同意指定可疑好友申请
发布空间动态(完整参数)Android 协议可用发布带图片、可见范围和指定好友范围的空间动态
删除空间动态Android 协议可用按动态 tid 删除本人空间动态
评论好友动态Android 协议可用评论指定动态
设置 QQ 资料Android 协议可用设置当前账号昵称、性别和个性签名,并回读最新名片
设置 QQ 个性签名Android 协议可用按 QQ Android 9.2.70 的审核与保存链路设置或清空当前账号签名

群聊管理 ​

API可用协议说明
获取群聊列表Android / Linux 双协议可用获取完整群聊列表
获取群聊成员列表Android / Linux 双协议可用获取指定群聊的成员
获取群聊系统通知Android 协议可用获取群聊申请与通知
同意加入群聊申请Android 协议可用同意指定申请
拒绝加入群聊申请Android 协议可用拒绝指定申请
同意群聊邀请Android 协议可用同意好友发来的群聊邀请
设置群聊管理员Android / Linux 双协议可用设置或取消管理员
群聊打卡Android 协议可用在指定群聊打卡
设置群聊成员禁言Android / Linux 双协议可用设置或取消成员禁言
设置群聊全员禁言Android / Linux 双协议可用开启或取消全员禁言
设置群聊专属头衔Android / Linux 双协议可用设置或清除成员专属头衔
移出群聊成员Android / Linux 双协议可用将指定成员移出群聊
批量移出群聊成员Android / Linux 双协议可用按顺序复用单人移出链路,单次最多 20 人
撤回群聊消息Android / Linux 双协议可用撤回指定群聊消息
获取 @全体成员 剩余次数Android 协议可用查询当前账号和群聊的实时 @全体成员权限与限额
获取群荣誉信息Android 协议可用获取龙王、群聊之火、群聊炽焰和快乐源泉榜单
获取群精华消息Android / Linux 双协议可用获取指定群聊的精华消息列表
获取群组今日打卡列表Android 协议可用获取群聊当天的打卡成员和排名
获取群文件系统信息Android 协议可用获取文件数量限制和存储空间使用情况
创建群聊Android 协议可用创建普通 QQ 群,并可在创建成功后邀请成员
设置成员邀请策略Android 协议可用控制普通成员能否直接邀请他人入群
设置成员权限Android 协议可用单独开启或关闭成员邀请、上传等权限位
设置新成员历史消息可见性Android 协议可用控制新成员是否能查看入群前历史消息
设置群加群选项Android 协议可用设置入群验证方式、问题与答案
设置群搜索选项Android 协议可用设置群号和条件搜索开关
设置机器人入群选项Android 协议可用设置机器人账号入群时是否允许及是否需要审核
获取群相册列表Android 协议可用分页获取群相册及封面信息
获取群相册媒体列表Android 协议可用分页获取相册内的图片和视频
上传图片到群相册Android 协议可用使用当前 Android QQ 登录态分片上传图片
评论群相册媒体Android 协议可用评论指定相册图片或视频
点赞群相册媒体Android 协议可用点赞一批或指定相册媒体
取消群相册媒体点赞Android 协议可用取消一批或指定相册媒体的点赞
删除群相册媒体Android 协议可用删除相册图片或视频
获取群文件根目录Android / Linux 双协议可用获取根目录文件与文件夹,并自动处理分页
获取群文件夹内容Android / Linux 双协议可用获取指定文件夹中的文件与子文件夹
创建群文件夹Android 协议可用由群主或管理员在根目录创建文件夹
删除群文件夹Android 协议可用按真实文件夹 ID 删除群文件夹
上传群文件Android / Linux 双协议可用通过 QQ Android 9.2.70 文件通道真实上传群文件
删除群文件Android 协议可用删除群文件,缺省业务参数由框架自动查询补齐
重命名群文件Android 协议可用按文件 ID 重命名群文件
移动群文件Android 协议可用在群文件目录之间移动文件
修改群成员名片Android / Linux 双协议可用修改或清空指定成员在群内显示的昵称
获取群公告Android 协议可用使用当前 Android QQ 登录态获取群公告
发布群公告Android 协议可用发布文字公告,并可附带本地、URL 或 Base64 图片
删除群公告Android 协议可用删除指定群聊中的公告

账号、登录与等级任务 ​

API可用协议说明
获取 Bot 列表Android / Linux 双协议可用获取当前框架实例中的全部协议账号;不接受参数
获取 Bot 信息Android / Linux 双协议可用获取指定 Bot 的运行信息
获取协议列表Android / Linux 双协议可用获取可选协议
获取设备指纹列表Android / Linux 双协议可用获取可选设备指纹
添加账号Android / Linux 双协议可用创建账号并指定其登录节点
编辑账号Android / Linux 双协议可用编辑离线账号配置
停止账号会话Android / Linux 双协议可用取消正在进行的登录,或下线已登录账号
删除账号Android / Linux 双协议可用删除指定协议的离线账号
密码登录Android / Linux 双协议可用发起密码登录
检查登录缓存Android / Linux 双协议可用检查本地登录缓存
缓存登录Android / Linux 双协议可用使用本地缓存登录
提交滑块验证Android / Linux 双协议可用提交滑块结果
查询安全验证方式Android / Linux 双协议可用查询安全验证原因与可用方式
创建登录二维码Android / Linux 双协议可用创建安全验证登录二维码
查询登录二维码状态Android / Linux 双协议可用查询扫码状态并在确认后继续登录
获取短信验证码Android / Linux 双协议可用下发安全验证短信
提交短信验证码Android / Linux 双协议可用提交短信验证码并继续登录
Android 扫描登录二维码Android 协议可用使用在线 Android Bot 扫描登录二维码
Android 授权登录二维码Android 协议可用使用在线 Android Bot 确认二维码授权
获取等级加速任务Android / Linux 双协议可用获取 QQ 等级加速面板
执行等级加速任务Android / Linux 双协议可用执行指定的等级加速任务
获取等级加速账号列表Android / Linux 双协议可用获取框架共享等级任务账号及协议支持情况
获取等级加速账号详情Android / Linux 双协议可用读取单个账号的共享任务状态
获取等级任务状态Android / Linux 双协议可用只读获取等级任务状态
获取等级加速面板Android / Linux 双协议可用刷新或读取共享任务面板
读取等级任务计划Android / Linux 双协议可用读取框架统一调度配置
保存等级任务计划Android / Linux 双协议可用保存计划,不立即执行
执行选定等级任务Android / Linux 双协议可用复用框架执行过滤、缓存与并发控制
注册滑块验证反代Android / Linux 双协议可用注册滑块反代并返回改写后的验证脚本
滑块验证反代请求Android / Linux 双协议可用反代转发滑块请求到腾讯验证服务

框架服务管理 ​

API可用协议说明
获取插件上下文Android / Linux 双协议可用读取当前服务、节点、契约版本、可用管理 action 与管理端地址
获取账号管理上下文Android / Linux 双协议可用一次读取账号、协议、指纹和节点快照
创建账号归属验证二维码Android / Linux 双协议可用创建只用于证明 QQ 归属的临时二维码
查询账号归属验证Android / Linux 双协议可用查询扫码状态,确认后只返回 QQ 号
获取节点列表Android / Linux 双协议可用获取全部节点及账号统计,不返回代理密码
创建节点Android / Linux 双协议可用创建直连或 HTTP/SOCKS5 代理节点
更新节点Android / Linux 双协议可用更新已停用节点,代理密码支持保留或清除
删除节点Android / Linux 双协议可用删除已停用且未被账号引用的节点
测试节点延迟Android / Linux 双协议可用测试节点代理 TCP 连接延迟
创建设备指纹Android / Linux 双协议可用创建可选自定义名称的随机设备指纹
删除设备指纹Android / Linux 双协议可用删除未被任何账号使用的设备指纹
获取账号设置Android / Linux 双协议可用读取缓存登录、自动登录和离线清理设置
更新账号设置Android / Linux 双协议可用更新框架级账号设置并校验依赖关系
获取账号离线通知Android / Linux 双协议可用读取指定 QQ 与协议的离线邮件通知设置
更新账号离线通知Android / Linux 双协议可用更新指定 QQ 与协议的离线邮件通知设置
清理账号缓存Android / Linux 双协议可用清理指定 QQ 和协议的本地登录缓存
提交身份滑块Android 协议可用提交身份验证滑块结果
提交身份手机号Android 协议可用提交身份验证手机号并请求短信
确认身份短信Android 协议可用确认身份验证短信已完成
重试身份验证登录Android 协议可用使用验证结果重试账号登录
调用账号安全验证Android / Linux 双协议可用调用指定 SsoSecureAccess 验证类型
重试安全验证登录Android / Linux 双协议可用使用安全验证结果重试账号登录
获取账号授权租约Android / Linux 双协议可用获取当前服务创建的账号授权租约
设置账号授权租约Android / Linux 双协议可用为指定 QQ 与协议创建或更新授权租约
清除账号授权租约Android / Linux 双协议可用清除当前服务对指定 QQ 与协议的租约
获取账号最近日志Android / Linux 双协议可用获取指定 QQ 与协议最近 200 条账号日志

QQ 宠物 ​

API可用协议说明
获取宠物资料Android 协议可用获取本人宠物资料
获取宠物勋章图鉴Android 协议可用获取全部勋章及获得、佩戴状态
获取宠物数值Android 协议可用根据 pet_id 获取本人或好友宠物的心情、饱腹、清洁和金币
获取宠物三维属性Android 协议可用获取力量、智力、魅力等成长属性
获取食物目录Android 协议可用获取食物目录与库存
给宠物喂食Android 协议可用使用指定名称或 ID 的食物喂食
购买宠物食物Android 协议可用按食物名称或 ID 购买宠物食物
获取洗护用品目录Android 协议可用获取洗护用品与价格
获取洗护用品库存Android 协议可用获取洗护用品持有数量
给宠物洗护Android 协议可用按名称或 ID 使用洗护用品
购买洗护用品Android 协议可用按名称或 ID 购买洗护用品
获取活动概览Android 协议可用获取学习或打工概览
获取活动选项Android 协议可用获取可选课程、岗位或冒险
开始宠物活动Android 协议可用开始学习、打工或冒险
获取活动状态Android 协议可用获取当前活动状态
结算宠物活动Android 协议可用结算当前活动
鼓励活动中的宠物Android 协议可用鼓励当前活动中的宠物
获取宠物疲劳状态Android 协议可用获取学习/打工目录下发的疲劳档位与收益倍率
获取 PK 好友列表Android 协议可用获取可 PK 的好友
获取推荐 PK 对手Android 协议可用获取宠物服务推荐的陌生人对手
获取宠物互动消息Android 协议可用获取来访、投喂等互动动态
获取宠物 PK 数值Android 协议可用根据 pet_id 获取本人或好友宠物战力
戳一戳好友宠物Android 协议可用与好友宠物互动
获取好友宠物资料Android 协议可用获取好友宠物资料与当前数值
给好友宠物喂食Android 协议可用使用指定食物给好友宠物喂食
给好友宠物洗护Android 协议可用使用指定用品给好友宠物洗护
访问好友宠物Android 协议可用访问好友的宠物页面
发起宠物 PKAndroid 协议可用与指定好友的宠物开始 PK
获取宠物 PK 状态Android 协议可用查询指定 PK 任务状态
结算宠物 PKAndroid 协议可用结算指定 PK 任务

QQ 农场 ​

API可用协议说明
获取 QQ 农场登录 codeAndroid 协议可用获取一个新的 32 位 QQ 农场登录 code

萌卡 · 自托管 QQ 机器人框架