API 参考

按功能分类查找接口。

调用方式

通过已认证的 HTTP、WebSocket 或 IPC 插件调用接口。连接方法见通信协议。

仅限托管插件的委托管理接口单列在托管 IPC 委托接口，不能通过普通 HTTP / WebSocket 调用。

json

{
  "type": "action",
  "id": "get_group_list-1",
  "action": "get_group_list",
  "params": {
    "self_id": 123456789,
    "protocol_id": 0
  }
}

账号使用 self_id + protocol_id 定位；protocol_id 由 get_protocol_list 查询，0 是有效值。接口操作当前框架内的账号，并遵守插件权限。

当前协议为 Android 9.3.75（手机 / 平板）和 Linux QQ 3.2.32；各接口的实际范围及待核验限制见页面顶部“适用协议”。框架仅有本机节点，不接受 node_id、代理等路由参数。

自定义发包、等级加速、第三方扫码授权及红包领取相关接口：Free 不可调用；Plus 每次核验所选 QQ 最新等级，至少 32 级；Pro 不设这项 QQ 等级门槛。账号页的正常扫码、免扫登录保留。自框架 3.0.7 起，其他 API 不额外限制 QQ 等级，仍需满足账号在线、当前授权及接口业务条件。已移除接口始终拒绝调用，见各页标记；错误字段与处理方式不应按成功响应处理。

自身扫码登录与第三方扫码授权分别校验：支持此规则的框架中，get_login_qr、query_login_qr、登录安全验证二维码及 login_account 的 Linux 无密码扫码分支，Free 禁止调用，Plus / Pro 不设 QQ 等级前置条件；仍须通过 VM 实时权益检查。scan_qr / auth_qr 等第三方扫码授权继续要求 Plus 每次通过 VM 核验所选在线 QQ 的最新等级至少 32 级；Free 仍禁用，Pro 无此等级门槛。仅更新 SDK 不会改变旧框架权益，账号页正常登录及其他安全校验保持。

成功响应读取 data，失败响应读取 error；有业务状态的结果还需检查相应状态字段。

账号相关

账号管理

API	Action
获取 Bot 列表	`get_bot_list`
获取 Bot 信息	`get_bot_info`
添加账号	`add_account`
编辑账号	`update_account`
删除账号	`delete_account`
设置 QQ 头像	`set_qq_avatar`
获取协议列表	`get_protocol_list`
获取设备指纹列表	`get_device_profile_list`
创建设备指纹	`create_device_profile`
获取账号设置	`get_account_settings`
获取账号最近日志	`get_account_recent_logs`
获取账号管理上下文	`get_account_management_context`
查询社交功能限制	`get_social_lock_status`
下线账号	`offline_account`

登录类

API	Action
密码登录	`login_account`
检查登录缓存	`check_cache`
缓存登录	`cache_login`
清理账号缓存	`clear_account_cache`
提交滑块验证	`submit_slider`
查询安全验证方式	`get_security_verify_methods`
获取短信验证码	`get_sms`
提交短信验证码	`check_sms`
Android 扫描登录二维码	`scan_qr`
Android 授权登录二维码	`auth_qr`
重试身份验证登录	`retry_account_identity_verify`
调用账号安全验证	`open_account_security_access`
重试安全验证登录	`retry_account_security_verify`
查询滑块验证结果	`captcha_heartbeat`
确认身份短信	`confirm_identity_sms`
获取登录二维码	`get_login_qr`
获取安全验证二维码	`get_security_verify_qr`
登录验证码	`login_captcha`
NT 提交短信验证码	`ntlogin_check_sms`
NT 查询安全验证方式	`ntlogin_get_security_verify_methods`
NT 获取安全验证二维码	`ntlogin_get_security_verify_qr`
NT 获取短信验证码	`ntlogin_get_sms`
NT 密码登录	`ntlogin_login_account`
NT 查询安全验证二维码	`ntlogin_query_security_verify_qr`
NT 提交滑块验证	`ntlogin_submit_slider`
查询登录二维码	`query_login_qr`
查询安全验证二维码	`query_security_verify_qr`
创建滑块验证会话	`register_captcha`
提交身份验证滑块	`submit_identity_captcha`
提交身份验证手机号	`submit_identity_phone`
WTLogin 提交短信验证码	`wtlogin_check_sms`
WTLogin 查询安全验证方式	`wtlogin_get_security_verify_methods`
WTLogin 获取短信验证码	`wtlogin_get_sms`
WTLogin 密码登录	`wtlogin_login_account`
WTLogin 提交滑块验证	`wtlogin_submit_slider`

凭据类

API	Action
获取 skey	`get_skey`
获取媒体 RKey	`get_rkey`
获取 User-Agent	`get_user_agent`
获取 PSKey	`get_ps_key`
获取 Client Key	`get_client_key`

任务类

API	Action
获取等级加速任务	`get_level_tasks`
执行等级加速任务	`execute_level_tasks`
等级任务管理	`level_task_management`

好友相关

消息类

API	Action
发送好友消息	`send_friend_msg`
获取好友历史消息	`get_friend_msg_history`
撤回好友消息	`recall_friend_msg`

媒体类

API	Action
上传好友图片	`upload_friend_image`
~~上传私聊文件~~（已移除）	`upload_private_file`
获取好友视频地址	`get_friend_video_url`
获取好友语音地址	`get_friend_voice_url`
上传或发送好友合并转发	`upload_friend_forward_msg`
上传好友视频	`upload_friend_video`
上传好友语音	`upload_friend_voice`

功能类

API	Action
获取好友列表	`get_friend_list`
获取单向好友列表	`get_unidirectional_friend_list`
~~主动申请加好友~~（已移除）	`send_friend_request`
删除好友	`delete_friend`
设置好友备注	`set_friend_remark`
获取最近会话	`get_recent_contact`
设置正在输入状态	`set_input_status`
同意过滤好友申请	`approve_filtered_friend_apply`
同意好友申请	`approve_friend_apply`
删除过滤好友通知	`delete_filtered_friend_notification`
获取过滤好友通知	`get_filtered_friend_notifications`
获取好友申请	`get_friend_requests`
查询好友状态	`get_friend_status`
获取好友系统通知	`get_friend_system_notifications`
拒绝好友申请	`reject_friend_apply`
处理好友申请	`set_friend_request`

群聊相关

消息类

API	Action
发送群聊消息	`send_group_msg`
~~发送群临时会话消息~~（已移除）	`send_group_temp_msg`
获取群聊历史消息	`get_group_msg_history`
按序号范围获取群历史消息	`get_group_history_messages`
获取群聊合并转发消息	`get_group_forward_msg`
撤回群聊消息	`recall_group_msg`

媒体类

API	Action
上传群图片	`upload_group_image`
上传群语音	`upload_group_voice`
上传群视频	`upload_group_video`
获取群视频地址	`get_group_video_url`
获取群语音地址	`get_group_voice_url`
上传或发送群合并转发	`upload_group_forward_msg`

红包类

API	Action
发送群红包	`send_group_red_packet`
查询红包详细信息	`get_red_packet_info`
领取红包	`grab_red_packet`
获取群红包	`get_group_red_packets`
领取群语音红包	`grab_group_voice_red_packet`
上传语音红包验证音频	`upload_red_packet_voice`

功能类

API	Action
获取群聊列表	`get_group_list`
获取群聊成员列表	`get_group_member_list`
获取群聊系统通知	`get_group_system_notifications`
同意加入群聊申请	`approve_group_apply`
拒绝加入群聊申请	`reject_group_apply`
同意群聊邀请	`approve_group_invite`
设置群聊管理员	`set_group_admin`
设置群聊成员禁言	`set_group_mute`
设置群聊全员禁言	`set_group_mute_all`
设置群聊专属头衔	`set_group_special_title`
移出群聊成员	`kick_group_member`
获取 @全体成员剩余次数	`get_group_at_all_remain`
获取群荣誉信息	`get_group_honor_info`
获取群组今日打卡列表	`get_group_signed_list`
创建群聊	`create_group`
设置成员邀请策略	`set_group_member_invite_policy`
设置成员权限	`set_group_member_permissions`
设置新成员历史消息可见性	`set_group_new_member_history_visibility`
设置入群方式	`set_group_add_option`
设置群搜索	`set_group_search`
设置机器人入群规则	`set_group_robot_add_option`
修改群成员名片	`set_group_card`
~~主动申请入群~~（已移除）	`send_group_join_request`
主动退群	`leave_group`
修改群名	`set_group_name`
设置群头像	`set_group_portrait`
查询入群方式	`get_group_join_info`
获取群分享链接	`get_group_share_link`
获取群共享历史消息	`get_group_share_messages`
邀请群成员	`invite_group_members`
~~申请加入群聊~~（已移除）	`join_group`
群签到	`sign_group`

文件管理

API	Action
获取群文件系统信息	`get_group_file_system_info`
创建群文件夹	`create_group_file_folder`
删除群文件夹	`delete_group_folder`
~~上传群文件~~（已移除）	`upload_group_file`
删除群文件	`delete_group_file`
重命名群文件	`rename_group_file`
移动群文件	`move_group_file`
获取群文件列表	`get_group_files`

相册管理

API	Action
获取群相册列表	`get_qun_album_list`
获取群相册媒体列表	`get_group_album_media_list`
上传图片到群相册	`upload_image_to_qun_album`
评论群相册媒体	`do_group_album_comment`
点赞群相册媒体	`set_group_album_media_like`
删除群相册媒体	`del_group_album_media`

公告与精华

API	Action
获取群公告	`get_group_notice`
发布群公告	`send_group_notice`
设置精华消息	`set_group_essence`
获取群精华消息	`get_essence_msg_list`
删除群公告	`delete_group_notice`

QQ 空间

动态与互动

API	Action
获取好友动态	`get_qzone_friend_feeds`
发布空间动态	`publish_qzone_feed`
点赞好友动态	`like_qzone_feed`
取消好友动态点赞	`unlike_qzone_feed`
评论好友动态	`comment_qzone_feed`
删除空间动态	`delete_qzone_feed`

QQ 宠物

QQ 搭子

API	Action
~~接受搭子邀请~~（已移除）	`qmate_accept_invite`
~~领取搭子任务奖励~~（已移除）	`qmate_claim_task_reward`
~~确认搭子邀请~~（已移除）	`qmate_confirm_invite`
~~解除搭子关系~~（已移除）	`qmate_dissolve`
~~查询搭子领养信息~~（已移除）	`qmate_get_adoption_info`
~~获取搭子信息~~（已移除）	`qmate_get_info`
~~获取搭子背包~~（已移除）	`qmate_get_inventory`
~~获取搭子邀请卡片~~（已移除）	`qmate_get_invite_ark`
~~获取搭子任务~~（已移除）	`qmate_get_tasks`
~~孵化搭子~~（已移除）	`qmate_hatch`
~~上报搭子孵化连击~~（已移除）	`qmate_report_incubation_combo`
~~上报搭子任务动作~~（已移除）	`qmate_report_task_action`
~~使用搭子道具~~（已移除）	`qmate_use_item`

资料与属性

API	Action
~~领养宠物~~（已移除）	`qqpet_adopt_pet`
~~获取候选宠物~~（已移除）	`qqpet_get_candidate_pets`
~~获取展示值~~（已移除）	`qqpet_get_display_value`
~~获取数值指标~~（已移除）	`qqpet_get_numeric_metrics`
~~获取资料~~（已移除）	`qqpet_get_profile`
~~获取升级配置~~（已移除）	`qqpet_get_upgrade_config`
~~获取用户宠物~~（已移除）	`qqpet_get_user_pet`
~~设置设备信息~~（已移除）	`qqpet_set_device_info`
~~更新资料~~（已移除）	`qqpet_update_profile`

喂食与洗护

API	Action
~~购买食物~~（已移除）	`qqpet_buy_food`
~~领取每日食物~~（已移除）	`qqpet_claim_daily_food`
~~执行照料~~（已移除）	`qqpet_do_care`
喂食（已移除）	`qqpet_feeding`
~~获取洗护目录~~（已移除）	`qqpet_get_bath_catalog`
~~获取洗护库存~~（已移除）	`qqpet_get_bath_inventory`
~~获取照料配置~~（已移除）	`qqpet_get_care_config`
~~获取照料补给信息~~（已移除）	`qqpet_get_care_supply_info`
~~获取喂食红点~~（已移除）	`qqpet_get_feed_red_dot`
~~获取喂食次数信息~~（已移除）	`qqpet_get_feed_times_info`
~~推送喂食消息~~（已移除）	`qqpet_push_feed_msg`
~~上报喂食红点~~（已移除）	`qqpet_report_feed_red_dot`
~~设置照料配置~~（已移除）	`qqpet_set_care_config`
~~使用洗护物品~~（已移除）	`qqpet_use_bath_item`

活动与疲劳

API	Action
~~处理活动结束信息~~（已移除）	`qqpet_do_after_story_info`
~~鼓励活动~~（已移除）	`qqpet_encourage_story`
~~鼓励 QQ 宠物~~（已移除）	`qqpet_encourage_pet`
~~获取活动选项~~（已移除）	`qqpet_get_activity_options`
~~获取活动概况~~（已移除）	`qqpet_get_activity_overview`
~~获取互动历史~~（已移除）	`qqpet_get_interaction_history`
~~获取宠物活动状态~~（已移除）	`qqpet_get_pet_story_status`
~~获取活动信息~~（已移除）	`qqpet_get_story_info`
~~获取活动进度~~（已移除）	`qqpet_get_story_process`
~~开始活动~~（已移除）	`qqpet_start_story`

好友与 PK

API	Action
~~删除互动记录~~（已移除）	`qqpet_delete_interaction_record`
~~获取私聊宠物信息~~（已移除）	`qqpet_get_c2c_pet_info`
~~获取互动消息~~（已移除）	`qqpet_get_interaction_messages`
~~获取其他宠物状态信息~~（已移除）	`qqpet_get_other_pet_status_info`
~~获取其他用户宠物~~（已移除）	`qqpet_get_other_user_pet`
~~获取PK战力~~（已移除）	`qqpet_get_pk_power`
~~获取关系列表~~（已移除）	`qqpet_get_relation_list`
点赞（已移除）	`qqpet_like`
~~戳一戳好友宠物~~（已移除）	`qqpet_poke_friend_pet`
~~查询点赞数量~~（已移除）	`qqpet_query_like_count`
~~设置私聊宠物信息~~（已移除）	`qqpet_set_c2c_pet_info`
~~设置私聊宠物开关~~（已移除）	`qqpet_set_c2c_pet_switch`

形象与装扮

API	Action
~~装备职业~~（已移除）	`qqpet_equip_career`
~~装备勋章~~（已移除）	`qqpet_equip_medal`
~~获取职业树~~（已移除）	`qqpet_get_career_tree`
~~获取服装~~（已移除）	`qqpet_get_clothing`
~~获取服装红点~~（已移除）	`qqpet_get_clothing_red_dot`
~~获取勋章详情~~（已移除）	`qqpet_get_medal_detail`
~~获取勋章陈列~~（已移除）	`qqpet_get_medal_gallery`
~~获取我的套装~~（已移除）	`qqpet_get_my_suits`
~~移除单个套装~~（已移除）	`qqpet_remove_one_suit`
~~上报服装红点~~（已移除）	`qqpet_report_clothing_red_dot`
~~保存头像~~（已移除）	`qqpet_save_avatar`
~~保存单个套装~~（已移除）	`qqpet_save_one_suit`
~~卸下勋章~~（已移除）	`qqpet_unequip_medal`

钱袋与商店

API	Action
~~查询宠物钱袋~~（已移除）	`qqpet_get_coin_bag_detail`
~~获取食物商店~~（已移除）	`qqpet_get_food_shop`
~~创建订单~~（已移除）	`qqpet_place_order`
~~领取宠物钱袋~~（已移除）	`qqpet_snatch_coin_bag`

其他接口

API	Action
~~检查用户灰度~~（已移除）	`qqpet_check_user_in_gray`
~~获取事件规则~~（已移除）	`qqpet_get_event_rule`
~~获取主页资源~~（已移除）	`qqpet_get_home_resource`
~~获取增量资源~~（已移除）	`qqpet_get_incr_resource`
~~获取页面规则~~（已移除）	`qqpet_get_page_rules`
~~获取反应~~（已移除）	`qqpet_get_reaction`
~~获取资源~~（已移除）	`qqpet_get_resource`
~~获取资源详情~~（已移除）	`qqpet_get_resource_detail`
~~获取序列~~（已移除）	`qqpet_get_sequence`
心跳（已移除）	`qqpet_heart_beat`
宠物业务操作	`qqpet_operation`
~~上报动作~~（已移除）	`qqpet_report_action`
~~上报事件~~（已移除）	`qqpet_report_event`
~~上报引导~~（已移除）	`qqpet_report_guide`

QQ 农场

农场接口

API	Action
获取 QQ 农场登录码	`get_qq_classic_farm_code`

通用工具

消息工具

API	Action
获取缓存消息	`get_msg`
标记消息已读	`mark_msg_as_read`
获取消息表情回应	`get_emoji_likes`
设置消息表情回应	`set_msg_emoji_like`
戳一戳	`send_poke`

媒体工具

API	Action
获取闪照原图地址	`get_flash_image`
生成音乐 Ark 卡片	`get_music_ark`
生成小程序 Ark 卡片	`get_mini_app_ark`
获取 AI 声音角色	`get_ai_characters`
语音转文字	`fetch_ptt_text`
生成 AI 语音	`generate_ai_voice`

辅助工具

API	Action
检查网址安全性	`check_url_safely`
英文翻译为中文	`translate_en2zh`
发送原始协议包	`send_packet`
文件传输	`file_transfer`
获取联系人卡片	`get_contact_ark`
获取收到的名片赞	`get_received_profile_likes`
获取送出的名片赞	`get_sent_profile_likes`
获取用户资料	`get_user_profile`
点赞用户资料	`like_user_profile`
资料管理	`profile_operation`
撤回消息	`recall_message`
第三方应用授权	`sdk_auth_api`

框架管理

服务与运行

API	Action
获取插件上下文	`get_plugin_context`
获取版本信息	`get_version_info`

API 参考 ​

调用方式 ​

账号相关 ​

账号管理 ​

登录类 ​

凭据类 ​

任务类 ​

好友相关 ​

消息类 ​

媒体类 ​

功能类 ​

群聊相关 ​

消息类 ​

媒体类 ​

红包类 ​

功能类 ​

文件管理 ​

相册管理 ​

公告与精华 ​

QQ 空间 ​

动态与互动 ​

QQ 宠物 ​

QQ 搭子 ​

资料与属性 ​

喂食与洗护 ​

活动与疲劳 ​

好友与 PK ​

形象与装扮 ​

钱袋与商店 ​

其他接口 ​

QQ 农场 ​

农场接口 ​

通用工具 ​

消息工具 ​

媒体工具 ​

辅助工具 ​

框架管理 ​

服务与运行 ​