API 总览

icqq-rust-onebot 实现了 OneBot 11 标准动作集，并兼容大量 go-cqhttp 扩展动作、QQ 频道动作及少量 icqq 扩展动作。

所有动作以统一格式调用：

{
  "action": "<动作名>",
  "params": { ... },
  "echo": null
}

统一响应信封：

{
  "status": "ok",
  "retcode": 0,
  "data": { ... },
  "echo": null
}

retcode 约定

retcode	status	说明
0	ok	成功。
1	async	已接受异步处理（_async 后缀触发）。
1400	failed	参数错误或消息 ID 非法。
1404	failed	未知动作或不支持的动作。
1500	failed	操作失败，例如风控、传输错误、服务器拒绝。

动作后缀

• 动作名以 _async 结尾时，立即返回 { "status": "async", "retcode": 1 } 并在后台执行。
• _rate_limited 后缀会被剥离后按基础动作分发。

消息

action	描述	分页
send_private_msg	发送私聊消息	消息
send_group_msg	发送群消息	消息
send_msg	发送消息（自动判定类型）	消息
send_group_forward_msg	发送群合并转发	消息
send_private_forward_msg	发送私聊合并转发	消息
delete_msg	撤回消息	消息
get_msg	获取单条消息	消息
get_forward_msg	获取合并转发内容	消息
get_group_msg_history	获取群消息历史	消息
mark_msg_as_read	标记消息已读	消息
set_msg_emoji_like	消息表情回应	消息
handle_quick_operation	快速操作	消息

群管理

action	描述	分页
set_group_kick	群踢人	群管理
set_group_ban	群禁言	群管理
set_group_whole_ban	群全员禁言	群管理
set_group_anonymous_ban	匿名用户禁言	群管理
set_group_admin	设置/取消群管理员	群管理
set_group_anonymous	群匿名开关	群管理
set_group_card	设置群名片	群管理
set_group_name	设置群名	群管理
set_group_leave	退群/解散群	群管理
set_group_special_title	设置群专属头衔	群管理
set_essence_msg	设置精华消息	群管理
delete_essence_msg	移除精华消息	群管理
get_group_at_all_remain	获取群 @全体 剩余次数	群管理
send_group_sign	群打卡	群管理
send_group_notice	发送群公告	群管理
set_friend_add_request	处理加好友请求	群管理
set_group_add_request	处理加群请求/邀请	群管理

账号资料

action	描述	分页
send_like	点赞（名片赞）	账号资料
set_qq_profile	设置自身资料	账号资料
set_qq_avatar	设置自身头像	账号资料
set_online_status	设置在线状态	账号资料
set_self_longnick	设置个性签名	账号资料
get_roaming_stamp	获取漫游表情	账号资料
delete_stamp	删除漫游表情	账号资料
add_friend_category	新增好友分组	账号资料
delete_friend_category	删除好友分组	账号资料
rename_friend_category	重命名好友分组	账号资料
delete_friend	删除好友	账号资料
get_unidirectional_friend_list	获取单向好友列表	账号资料
set_group_portrait	设置群头像	账号资料
delete_unidirectional_friend	删除单向好友（不支持）	账号资料

信息查询

action	描述	分页
get_login_info	获取登录号信息	信息查询
get_stranger_info	获取陌生人信息	信息查询
get_friend_list	获取好友列表	信息查询
get_group_info	获取群信息	信息查询
get_group_list	获取群列表	信息查询
get_group_member_info	获取群成员信息	信息查询
get_group_member_list	获取群成员列表	信息查询
get_group_honor_info	获取群荣誉信息	信息查询
get_cookies	获取 Cookies	信息查询
get_csrf_token	获取 CSRF Token	信息查询
get_credentials	获取凭证	信息查询
can_send_image	能否发送图片	信息查询
can_send_record	能否发送语音	信息查询
get_online_clients	获取在线设备	信息查询
get_group_system_msg	获取群系统消息	信息查询

群文件

action	描述	分页
get_group_file_system_info	获取群文件系统信息	群文件
get_group_root_files	获取群根目录文件	群文件
get_group_files_by_folder	获取群子目录文件	群文件
get_group_file_url	获取群文件下载地址	群文件
upload_group_file	上传群文件	群文件
upload_private_file	上传私聊文件	群文件
delete_group_file	删除群文件	群文件
create_group_file_folder	创建群文件目录	群文件
delete_group_folder	删除群文件目录	群文件

QQ 频道

action	描述	分页
get_guild_service_profile	获取频道 BOT 资料	QQ 频道
get_guild_list	获取频道列表	QQ 频道
get_guild_channel_list	获取子频道列表	QQ 频道
get_guild_member_list	获取频道成员列表	QQ 频道
send_guild_channel_msg	发送子频道消息	QQ 频道

Web

action	描述	分页
get_essence_msg_list	获取精华消息列表	Web
get_group_notice	获取群公告	Web
set_group_anonymous_ban	匿名用户禁言（同群管理）	Web
check_url_safely	检查链接安全性	Web
ocr_image	图片 OCR	Web

媒体

action	描述	分页
get_image	获取图片	媒体
get_record	获取语音	媒体

元信息与杂项

action	描述	分页
get_status	获取运行状态	元信息
get_version_info	获取版本信息	元信息
set_restart	重启（空操作）	元信息
clean_cache	清理缓存（空操作）	元信息
download_file	下载文件到本地	元信息
get_word_slices	中文分词（不支持）	元信息
reload_event_filter	重载事件过滤器（空操作）	元信息

不支持的动作

以下动作在本项目中不受支持，调用返回 1404，响应包含 not_supported: true 标记。

action	说明
delete_unidirectional_friend	删除单向好友
get_model_show / _get_model_show	获取机型展示
set_model_show / _set_model_show	设置机型展示
qidian_get_account_info	企点账号信息
.get_word_slices	中文分词
频道 meta / role 系列	get_guild_meta_by_guest、get_guild_member_profile、get_guild_msg、get_topic_channel_feeds、get_guild_roles、create_guild_role、delete_guild_role、update_guild_role、set_guild_member_role