Skip to content
Powered by VitePress OpenAPI
API 文档
NapCatOneBot11 HTTP POST 接口文档
清理流式传输临时文件
下载语音文件流
下载图片文件流
测试下载流
下载文件流
POST
/download_file_stream
以流式方式从网络或本地下载文件
Request Body
application/json
JSON
{
"file": "http://example.com/file.png"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"type": "stream",
"data_type": "file_info",
"file_name": "file.png",
"file_size": 1024
},
"message": "",
"wording": "",
"stream": "normal-action"
}
上传文件流
POST
/upload_file_stream
以流式方式上传文件数据到机器人
Request Body
application/json
JSON
{
"stream_id": "uuid-1234-5678",
"chunk_data": "SGVsbG8gV29ybGQ=",
"chunk_index": 0,
"total_chunks": 1,
"file_size": 11
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"type": "stream",
"stream_id": "uuid-1234-5678",
"status": "chunk_received",
"received_chunks": 1,
"total_chunks": 1
},
"message": "",
"wording": "",
"stream": "normal-action"
}
群组扩展
Operations
POST/del_group_album_mediaPOST/set_group_album_media_likePOST/do_group_album_commentPOST/get_group_album_media_listPOST/get_qun_album_listPOST/upload_image_to_qun_albumPOST/set_group_add_optionPOST/set_group_robot_add_optionPOST/set_group_searchPOST/set_group_remarkPOST/get_group_info_exPOST/set_group_signPOST/send_group_sign
删除群相册媒体
点赞群相册媒体
发表群相册评论
获取群相册媒体列表
POST
/get_group_album_media_list
Request Body
application/json
JSON
{
"group_id": "123456",
"album_id": "album_id_1"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"media_list": [
{
"media_id": "media_id_1",
"url": "http://example.com/1.jpg"
}
]
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取群相册列表
POST
/get_qun_album_list
Request Body
application/json
JSON
{
"group_id": "123456"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": [
{
"album_id": "album_1",
"album_name": "测试相册",
"cover_url": "http://example.com/cover.jpg",
"create_time": 1734567890
}
],
"message": "",
"wording": "",
"stream": "normal-action"
}
上传图片到群相册
POST
/upload_image_to_qun_album
Request Body
application/json
JSON
{
"group_id": "123456",
"album_id": "album_id_1",
"album_name": "相册1",
"file": "/path/to/image.jpg"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"result": null
},
"message": "",
"wording": "",
"stream": "normal-action"
}
设置群加群选项
设置群机器人加群选项
设置群搜索选项
设置群备注
获取群详细信息 (扩展)
群打卡
群打卡
群组接口
群组管理、成员管理相关接口
Operations
POST/get_group_detail_infoPOST/get_group_listPOST/get_group_infoPOST/get_group_member_listPOST/get_group_member_infoPOST/send_group_msgPOST/set_group_add_requestPOST/set_group_leavePOST/set_group_whole_banPOST/set_group_banPOST/set_group_kickPOST/set_group_adminPOST/set_group_namePOST/set_group_cardPOST/_get_group_noticePOST/get_essence_msg_listPOST/get_group_ignored_notifiesPOST/delete_essence_msgPOST/set_essence_msgPOST/_del_group_noticePOST/get_group_shut_listPOST/get_group_ignore_add_request
获取群详细信息
POST
/get_group_detail_info
获取群聊的详细信息，包括成员数、最大成员数等
Request Body
application/json
JSON
{
"group_id": "123456"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"group_id": 123456,
"group_name": "测试群",
"member_count": 100,
"max_member_count": 500
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取群列表
获取群信息
获取群成员列表
POST
/get_group_member_list
获取群聊中的所有成员列表
Request Body
application/json
JSON
{
"group_id": "123456"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": [
{
"group_id": 123456,
"user_id": 123456789,
"nickname": "昵称",
"card": "名片",
"role": "member"
}
],
"message": "",
"wording": "",
"stream": "normal-action"
}
获取群成员信息
POST
/get_group_member_info
获取群聊中指定成员的信息
Request Body
application/json
JSON
{
"group_id": "123456",
"user_id": "123456789"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"group_id": 123456,
"user_id": 123456789,
"nickname": "昵称",
"card": "名片",
"role": "member"
},
"message": "",
"wording": "",
"stream": "normal-action"
}
发送群消息
处理加群请求
退出群组
全员禁言
群组禁言
群组踢人
设置群管理员
设置群名称
设置群名片
获取群公告
POST
/_get_group_notice
获取指定群聊中的公告列表
Request Body
application/json
JSON
{
"group_id": "123456"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": [
{
"notice_id": "notice_123",
"sender_id": 123456,
"publish_time": 1710000000,
"message": {
"text": "公告内容",
"image": [
]
}
}
],
"message": "",
"wording": "",
"stream": "normal-action"
}
获取群精华消息
POST
/get_essence_msg_list
获取指定群聊中的精华消息列表
Request Body
application/json
JSON
{
"group_id": "123456"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": [
{
"message_id": 123456,
"sender_id": 123456,
"sender_nick": "昵称",
"operator_id": 123456,
"operator_nick": "昵称",
"operator_time": 1710000000,
"content": "精华内容"
}
],
"message": "",
"wording": "",
"stream": "normal-action"
}
获取群忽略通知
移出精华消息
设置精华消息
删除群公告
获取群禁言列表
获取群被忽略的加群请求
POST
/get_group_ignore_add_request
Request Body
application/json
JSON
{
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": [
{
"request_id": 12345,
"invitor_uin": 123456789,
"invitor_nick": "邀请者",
"group_id": 123456789,
"message": "加群请求",
"group_name": "群名称",
"checked": false,
"actor": 0,
"requester_nick": "请求者"
}
],
"message": "",
"wording": "",
"stream": "normal-action"
}
批量踢出群成员
创建收藏
设置个性签名
设置QQ头像
英文单词翻译
获取ClientKey
图片 OCR 识别
图片 OCR 识别 (内部)
设置专属头衔
获取AI角色列表
POST
/get_ai_characters
获取群聊中的AI角色列表
Request Body
application/json
JSON
{
"group_id": "123456"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": [
{
"type": "string",
"characters": [
{
"character_id": "id",
"character_name": "name",
"preview_url": "url"
}
]
}
],
"message": "",
"wording": "",
"stream": "normal-action"
}
处理可疑好友申请
获取可疑好友申请
POST
/get_doubt_friends_add_request
获取系统的可疑好友申请列表
Request Body
application/json
JSON
{
"count": 10
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": [
{
"user_id": 123456789,
"nickname": "昵称",
"age": 20,
"sex": "male",
"reason": "申请理由",
"flag": "flag_123"
}
],
"message": "",
"wording": "",
"stream": "normal-action"
}
获取登录号信息
获取版本信息
是否可以发送语音
是否可以发送图片
获取运行状态
获取 CSRF Token
获取登录凭证
获取Packet状态
重启服务
获取群系统消息
清理缓存
设置好友备注
点赞
获取好友列表
处理加好友请求
获取 Cookies
获取最近会话
POST
/get_recent_contact
获取最近会话
Request Body
application/json
JSON
{
"count": 10
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": [
{
"peerUin": "123456",
"peerName": "测试",
"msgTime": "1734567890",
"msgId": "12345",
"lastestMsg": {
}
}
],
"message": "",
"wording": "",
"stream": "normal-action"
}
获取扩展 RKey
获取 RKey 服务器
设置在线状态
POST
/set_online_status
状态列表
在线
{ "status": 10, "ext_status": 0, "battery_status": 0; }
Q我吧
{ "status": 60, "ext_status": 0, "battery_status": 0; }
离开
{ "status": 30, "ext_status": 0, "battery_status": 0; }
忙碌
{ "status": 50, "ext_status": 0, "battery_status": 0; }
请勿打扰
{ "status": 70, "ext_status": 0, "battery_status": 0; }
隐身
{ "status": 40, "ext_status": 0, "battery_status": 0; }
听歌中
{ "status": 10, "ext_status": 1028, "battery_status": 0; }
春日限定
{ "status": 10, "ext_status": 2037, "battery_status": 0; }
一起元梦
{ "status": 10, "ext_status": 2025, "battery_status": 0; }
求星搭子
{ "status": 10, "ext_status": 2026, "battery_status": 0; }
被掏空
{ "status": 10, "ext_status": 2014, "battery_status": 0; }
今日天气
{ "status": 10, "ext_status": 1030, "battery_status": 0; }
我crash了
{ "status": 10, "ext_status": 2019, "battery_status": 0; }
爱你
{ "status": 10, "ext_status": 2006, "battery_status": 0; }
恋爱中
{ "status": 10, "ext_status": 1051, "battery_status": 0; }
好运锦鲤
{ "status": 10, "ext_status": 1071, "battery_status": 0; }
水逆退散
{ "status": 10, "ext_status": 1201, "battery_status": 0; }
嗨到飞起
{ "status": 10, "ext_status": 1056, "battery_status": 0; }
元气满满
{ "status": 10, "ext_status": 1058, "battery_status": 0; }
宝宝认证
{ "status": 10, "ext_status": 1070, "battery_status": 0; }
一言难尽
{ "status": 10, "ext_status": 1063, "battery_status": 0; }
难得糊涂
{ "status": 10, "ext_status": 2001, "battery_status": 0; }
emo中
{ "status": 10, "ext_status": 1401, "battery_status": 0; }
我太难了
{ "status": 10, "ext_status": 1062, "battery_status": 0; }
我想开了
{ "status": 10, "ext_status": 2013, "battery_status": 0; }
我没事
{ "status": 10, "ext_status": 1052, "battery_status": 0; }
想静静
{ "status": 10, "ext_status": 1061, "battery_status": 0; }
悠哉哉
{ "status": 10, "ext_status": 1059, "battery_status": 0; }
去旅行
{ "status": 10, "ext_status": 2015, "battery_status": 0; }
信号弱
{ "status": 10, "ext_status": 1011, "battery_status": 0; }
出去浪
{ "status": 10, "ext_status": 2003, "battery_status": 0; }
肝作业
{ "status": 10, "ext_status": 2012, "battery_status": 0; }
学习中
{ "status": 10, "ext_status": 1018, "battery_status": 0; }
搬砖中
{ "status": 10, "ext_status": 2023, "battery_status": 0; }
摸鱼中
{ "status": 10, "ext_status": 1300, "battery_status": 0; }
无聊中
{ "status": 10, "ext_status": 1060, "battery_status": 0; }
timi中
{ "status": 10, "ext_status": 1027, "battery_status": 0; }
睡觉中
{ "status": 10, "ext_status": 1016, "battery_status": 0; }
熬夜中
{ "status": 10, "ext_status": 1032, "battery_status": 0; }
追剧中
{ "status": 10, "ext_status": 1021, "battery_status": 0; }
我的电量
{
"status": 10,
"ext_status": 1000,
"battery_status": 0;
}
Request Body
application/json
JSON
{
"status": 11,
"ext_status": 0,
"battery_status": 100
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取机器人 UIN 范围
获取自定义表情
设置输入状态
获取用户在线状态
获取 RKey
获取小程序 Ark
POST
/get_mini_app_ark
Request Body
application/json
JSON
{
"type": "bili",
"title": "测试标题",
"desc": "测试描述",
"picUrl": "http://example.com/pic.jpg",
"jumpUrl": "http://example.com"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"data": {
"ark": "ark_content"
}
},
"message": "",
"wording": "",
"stream": "normal-action"
}
发送原始数据包
退出登录
获取收藏列表
POST
/get_collection_list
Request Body
application/json
JSON
{
"category": "0",
"count": "50"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"errCode": 0,
"errMsg": "",
"collectionSearchList": {
"collectionItemList": [
{
"cid": "123456",
"type": 8,
"status": 1,
"author": {
"type": 2,
"numId": "123456",
"strId": "昵称",
"groupId": "123456",
"groupName": "群名",
"uid": "123456"
},
"bid": 1,
"category": 1,
"createTime": "1769169157000",
"collectTime": "1769413477691",
"modifyTime": "1769413477691",
"sequence": "1769413476735",
"shareUrl": "",
"customGroupId": 0,
"securityBeat": false,
"summary": {
"textSummary": null,
"linkSummary": null,
"gallerySummary": null,
"audioSummary": null,
"videoSummary": null,
"fileSummary": null,
"locationSummary": null,
"richMediaSummary": {
"title": "",
"subTitle": "",
"brief": "text",
"picList": [
],
"contentType": 1,
"originalUri": "",
"publisher": "",
"richMediaVersion": 0
}
}
}
],
"hasMore": false,
"bottomTimeStamp": "1769413477691"
}
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取表情点赞详情
POST
/fetch_emoji_like
Request Body
application/json
JSON
{
"message_id": 12345,
"emojiId": "123",
"emojiType": 1,
"count": 10,
"cookie": ""
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"emojiLikesList": [
{
"tinyId": "123456",
"nickName": "测试用户",
"headUrl": "http://example.com/avatar.png"
}
],
"cookie": "",
"isLastPage": true,
"isFirstPage": true,
"result": 0,
"errMsg": ""
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取消息表情点赞列表
分享群 (Ark)
分享用户 (Ark)
分享群 (Ark)
分享用户 (Ark)
设置消息表情点赞
点击内联键盘按钮
POST
/click_inline_keyboard_button
Request Body
application/json
JSON
{
"group_id": "123456",
"bot_appid": "1234567890",
"button_id": "btn_1",
"callback_data": "",
"msg_seq": "10086"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取文件
POST
/get_file
获取指定文件的详细信息及下载路径
Request Body
application/json
JSON
{
"file": "file_id_123"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"file": "/path/to/file",
"url": "http://...",
"file_size": 1024,
"file_name": "test.jpg"
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取图片
获取语音
获取群文件URL
获取私聊文件URL
Go-CQHTTP
Operations
POST/set_qq_profilePOST/get_group_root_filesPOST/delete_friendPOST/check_url_safelyPOST/get_online_clientsPOST/get_group_honor_infoPOST/_send_group_noticePOST/get_group_at_all_remainPOST/send_forward_msgPOST/send_group_forward_msgPOST/send_private_forward_msgPOST/get_stranger_infoPOST/download_filePOST/upload_group_filePOST/get_group_msg_historyPOST/get_forward_msgPOST/get_friend_msg_historyPOST/.handle_quick_operationPOST/set_group_portraitPOST/upload_private_filePOST/_get_model_showPOST/_set_model_showPOST/delete_group_filePOST/create_group_file_folderPOST/delete_group_folderPOST/get_group_file_system_infoPOST/get_group_files_by_folder
设置QQ资料
获取群根目录文件列表
删除好友
检查URL安全性
获取在线客户端
获取群荣誉信息
POST
/get_group_honor_info
获取指定群聊的荣誉信息，如龙王等
Request Body
application/json
JSON
{
"group_id": "123456",
"type": "all"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"group_id": 123456,
"current_talkative": {
},
"talkative_list": [
]
},
"message": "",
"wording": "",
"stream": "normal-action"
}
发送群公告
获取群艾特全体剩余次数
POST
/get_group_at_all_remain
获取指定群聊中艾特全体成员的剩余次数
Request Body
application/json
JSON
{
"group_id": "123456"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"can_at_all": true,
"remain_at_all_count_for_group": 10,
"remain_at_all_count_for_self": 10
},
"message": "",
"wording": "",
"stream": "normal-action"
}
发送合并转发消息
发送群合并转发消息
发送私聊合并转发消息
获取陌生人信息
下载文件
POST
/download_file
下载网络文件到本地临时目录
Request Body
application/json
JSON
{
"url": "https://example.com/file.png",
"thread_count": 1,
"headers": "User-Agent: NapCat"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"file": "/path/to/downloaded/file"
},
"message": "",
"wording": "",
"stream": "normal-action"
}
上传群文件
POST
/upload_group_file
上传资源路径或URL指定的文件到指定群聊的文件系统中
Request Body
application/json
JSON
{
"group_id": "123456",
"file": "/path/to/file",
"name": "test.txt"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"file_id": "file_uuid_123"
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取群历史消息
获取合并转发消息
获取好友历史消息
处理快速操作
设置群头像
上传私聊文件
获取机型显示
设置机型
删除群文件
创建群文件目录
删除群文件目录
获取群文件系统信息
POST
/get_group_file_system_info
获取群聊文件系统的空间及状态信息
Request Body
application/json
JSON
{
"group_id": "123456"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"file_count": 10,
"limit_count": 10000,
"used_space": 1024,
"total_space": 10737418240
},
"message": "",
"wording": "",
"stream": "normal-action"
}
获取群文件夹文件列表
转发单条消息
转发单条消息
标记群聊已读
标记私聊已读
获取消息
POST
/get_msg
根据消息 ID 获取消息详细信息
Request Body
application/json
JSON
{
"message_id": 123456
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"time": 1710000000,
"message_type": "group",
"message_id": 123456,
"real_id": 123456,
"sender": {
"user_id": 123456789,
"nickname": "昵称"
},
"message": "hello"
},
"message": "",
"wording": "",
"stream": "normal-action"
}
发送私聊消息
发送消息
撤回消息
标记消息已读 (Go-CQHTTP)
标记所有消息已读
文件扩展
Operations
POST/move_group_filePOST/rename_group_filePOST/trans_group_filePOST/create_flash_taskPOST/get_flash_file_listPOST/get_flash_file_urlPOST/send_flash_msgPOST/get_share_linkPOST/get_fileset_infoPOST/get_online_file_msgPOST/send_online_filePOST/send_online_folderPOST/receive_online_filePOST/refuse_online_filePOST/cancel_online_filePOST/download_filesetPOST/get_fileset_id
移动群文件
POST
/move_group_file
Request Body
application/json
JSON
{
"group_id": "123456",
"file_id": "/file_id",
"current_parent_directory": "/current_folder_id",
"target_parent_directory": "/target_folder_id"
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"ok": true
},
"message": "",
"wording": "",
"stream": "normal-action"
}
重命名群文件
传输群文件
创建闪传任务
获取闪传文件列表
获取闪传文件链接
发送闪传消息
获取文件分享链接
获取文件集信息
获取在线文件消息
发送在线文件
发送在线文件夹
接收在线文件
拒绝在线文件
取消在线文件
下载文件集
获取文件集 ID
获取带分组的好友列表
获取资料点赞
POST
/get_profile_like
Request Body
application/json
JSON
{
"user_id": "123456789",
"start": 0,
"count": 10
}
Responses
业务响应
application/json
JSON
{
"status": "ok",
"retcode": 0,
"data": {
"uid": "u_123",
"time": "1734567890",
"favoriteInfo": {
"userInfos": [
],
"total_count": 10,
"last_time": 1734567890,
"today_count": 5
},
"voteInfo": {
"total_count": 100,
"new_count": 2,
"new_nearby_count": 0,
"last_visit_time": 1734567890,
"userInfos": [
]
}
},
"message": "",
"wording": "",
"stream": "normal-action"
}
