AdapterOneBot
约 4118 字大约 14 分钟
2025-10-13
Karin API Docs / AdapterOneBot
类: AdapterOneBot\<T\>
定义于: packages/core/src/adapter/onebot/core/core.ts:15
适配器基类 一个示例 AdapterBase
继承
类型参数
T
T extends OneBotType
构造函数
构造函数
new AdapterOneBot<
T>(_onebot):AdapterOneBot<T>
定义于: packages/core/src/adapter/onebot/core/core.ts:19
参数
_onebot
T
返回
AdapterOneBot<T>
重写了
属性
_onebot
_onebot:
T
定义于: packages/core/src/adapter/onebot/core/core.ts:17
account
account:
AccountInfo
定义于: packages/core/src/adapter/base/index.ts:31
账号信息
继承自
adapter
adapter:
AdapterInfo
定义于: packages/core/src/adapter/base/index.ts:32
适配器信息
继承自
raw
raw:
any
定义于: packages/core/src/adapter/base/index.ts:34
原生方法
继承自
super
super:
any
定义于: packages/core/src/adapter/base/index.ts:33
原生方法
继承自
访问器
selfId
Getter 签名
get selfId():
string
定义于: packages/core/src/adapter/base/index.ts:58
获取Bot的id
返回
string
继承自
selfName
Getter 签名
get selfName():
string
定义于: packages/core/src/adapter/base/index.ts:62
获取Bot的name
返回
string
继承自
方法
AdapterConvertKarin()
AdapterConvertKarin(
data):Promise<Elements[]>
定义于: packages/core/src/adapter/onebot/core/core.ts:124
onebot11转karin
参数
data
OneBotMessage[]
onebot11格式消息
返回
Promise<Elements[]>
karin格式消息
createGroupFolder()
createGroupFolder(
_groupId,_name):Promise<CreateGroupFolderResponse>
定义于: packages/core/src/adapter/base/index.ts:438
创建群文件夹
参数
_groupId
string
群号
_name
string
文件夹名
返回
Promise<CreateGroupFolderResponse>
返回文件夹id和已使用空间
继承自
createResId()
createResId(
_contact,_elements):Promise<string>
定义于: packages/core/src/adapter/base/index.ts:203
构造一个资源ID 即上传合并转发消息后不进行发送
参数
_contact
目标信息
_elements
转发消息元素
返回
Promise<string>
Description
此接口并不是所有协议端都支持的，因此在使用时请注意
继承自
delGroupFile()
delGroupFile(
_groupId,_fileId,_busId):Promise<boolean>
定义于: packages/core/src/adapter/base/index.ts:492
删除群文件
参数
_groupId
string
群号
_fileId
string
文件id
_busId
number
文件类型ID
返回
Promise<boolean>
无返回值
继承自
delGroupFolder()
delGroupFolder(
_groupId,_folderId):Promise<boolean>
定义于: packages/core/src/adapter/base/index.ts:459
删除群文件的文件夹
参数
_groupId
string
群号
_folderId
string
文件夹id
返回
Promise<boolean>
无返回值
继承自
downloadFile()
downloadFile(
_options?):Promise<DownloadFileResponse>
定义于: packages/core/src/adapter/base/index.ts:428
让协议端下载文件到协议端本地
参数
_options?
下载文件的选项
返回
Promise<DownloadFileResponse>
下载文件的绝对路径和文件MD5
继承自
DownloadForwardMessage()
DownloadForwardMessage(
_):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:891
参数
_
string
返回
Promise<any>
forwardKarinConvertAdapter()
forwardKarinConvertAdapter(
elements,options?):NodeMessage[]
定义于: packages/core/src/adapter/onebot/core/core.ts:1043
合并转发 karin -> adapter
参数
elements
消息元素
options?
首层小卡片外显参数
返回
NodeMessage[]
适配器消息元素
getAiCharacters()
getAiCharacters():
Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:1228
获取群 Ai 语音可用声色列表
返回
Promise<any>
声色列表
重写了
getAtAllCount()
getAtAllCount(
_groupId):Promise<GetAtAllCountResponse>
定义于: packages/core/src/adapter/base/index.ts:537
获取艾特全体成员剩余次数
参数
_groupId
string
群号
返回
Promise<GetAtAllCountResponse>
返回是否允许at全体成员和全群剩余次数、个人剩余次数
继承自
getAvatarUrl()
getAvatarUrl(
userId,size):Promise<string>
定义于: packages/core/src/adapter/onebot/core/core.ts:142
获取头像url
参数
userId
string = ...
头像大小，默认0
size
number = 0
头像大小，默认0
返回
Promise<string>
头像的url地址
重写了
getCookies()
getCookies(
domain):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:1193
获取 Cookies
参数
domain
string
The domain to get cookies from
返回
Promise<any>
重写了
getCredentials()
getCredentials(
domain):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:1202
获取 QQ 相关接口凭证
参数
domain
string
The domain to get credentials from
返回
Promise<any>
重写了
getCSRFToken()
getCSRFToken():
Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:1210
获取 CSRF Token
返回
Promise<any>
重写了
getFileUrl()
getFileUrl(
contact,fid):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:1116
获取文件url
参数
contact
目标信息
fid
string
文件id
返回
Promise<any>
文件url
Description
napcat支持仅提供fid获取url(但是你要伪造一个假的contact...)
重写了
getForwardMsg()
getForwardMsg(
_resId):Promise<MessageResponse[]>
定义于: packages/core/src/adapter/base/index.ts:182
获取合并转发消息
参数
_resId
string
资源ID
返回
Promise<MessageResponse[]>
包含MessageResponse对象的数组
继承自
getFriendList()
getFriendList(
_?):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:573
获取好友列表
参数
_?
boolean
返回
Promise<any>
好友列表数组
重写了
GetFriendList()
GetFriendList():
Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:626
获取好友列表
返回
Promise<any>
getGroupAvatarUrl()
getGroupAvatarUrl(
groupId,size,history):Promise<string>
定义于: packages/core/src/adapter/onebot/core/core.ts:155
获取群头像
参数
groupId
string
群号
size
number = 0
头像大小，默认0
history
number = 0
历史头像记录，默认0，若要获取历史群头像则填写1,2,3...
返回
Promise<string>
群头像的url地址
重写了
getGroupFileList()
getGroupFileList(
groupId,folderId?):Promise<{files:any;folders:any; }>
定义于: packages/core/src/adapter/onebot/core/core.ts:1157
获取群文件列表
参数
groupId
string
群ID
folderId?
string
文件夹ID
返回
Promise<{ files: any; folders: any; }>
群文件列表
重写了
getGroupFileSystemInfo()
getGroupFileSystemInfo(
groupId):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:1140
获取群文件系统信息
参数
groupId
string
群ID
返回
Promise<any>
群文件系统信息
重写了
AdapterBase.getGroupFileSystemInfo
getGroupHighlights()
getGroupHighlights(
groupId,_,__):Promise<GetGroupHighlightsResponse&object[]>
定义于: packages/core/src/adapter/onebot/core/core.ts:902
获取精华消息
参数
groupId
string
群ID
_
number
__
number
返回
Promise<GetGroupHighlightsResponse & object[]>
EssenceMessageBody对象
重写了
AdapterBase.getGroupHighlights
getGroupHonor()
getGroupHonor(
groupId):Promise<QQGroupHonorInfo[]>
定义于: packages/core/src/adapter/onebot/core/core.ts:791
获取群荣誉信息
参数
groupId
string
群ID
返回
Promise<QQGroupHonorInfo[]>
群荣誉信息数组
重写了
getGroupInfo()
getGroupInfo(
groupId,noCache?):Promise<{admins:any;avatar:string;group_name:any;group_remark:any;group_uin:string;groupDesc:string;groupId:string;groupName:any;groupRemark:any;max_member_count:any;maxMemberCount:any;member_count:any;memberCount:any;owner:string; }>
定义于: packages/core/src/adapter/onebot/core/core.ts:636
获取群信息
参数
groupId
string
群ID
noCache?
boolean
是否刷新缓存
返回
Promise<{ admins: any; avatar: string; group_name: any; group_remark: any; group_uin: string; groupDesc: string; groupId: string; groupName: any; groupRemark: any; max_member_count: any; maxMemberCount: any; member_count: any; memberCount: any; owner: string; }>
群信息
重写了
getGroupList()
getGroupList(
_refresh?):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:667
获取群列表
参数
_refresh?
boolean
返回
Promise<any>
群列表数组
重写了
getGroupMemberInfo()
getGroupMemberInfo(
groupId,targetId,refresh?):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:701
获取群成员信息 此接口在非QQ平台上很难获取到标准信息，因此返回的数据可能会有所不同
参数
groupId
string
群ID
targetId
string
目标用户的ID
refresh?
boolean
是否刷新缓存
返回
Promise<any>
群成员信息
重写了
AdapterBase.getGroupMemberInfo
getGroupMemberList()
getGroupMemberList(
groupId,refresh?):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:745
获取群成员列表
参数
groupId
string
群ID
refresh?
boolean
是否刷新缓存
返回
Promise<any>
群成员列表数组
重写了
AdapterBase.getGroupMemberList
getGroupMuteList()
getGroupMuteList(
_groupId):Promise<GetGroupMuteListResponse[]>
定义于: packages/core/src/adapter/base/index.ts:546
获取群被禁言用户列表
参数
_groupId
string
返回
Promise<GetGroupMuteListResponse[]>
返回禁言用户列表
继承自
getHistoryMsg()
getHistoryMsg(
contact,startMsgId,count):Promise<any[]>
定义于: packages/core/src/adapter/onebot/core/core.ts:345
获取msgId获取历史消息
参数
contact
目标信息
startMsgId
起始消息ID
string | number
count
number
获取消息数量 默认为1
返回
Promise<any[]>
包含历史消息的数组
重写了
getMsg()
getMsg(
_contact,messageId?):Promise<{contact:Contact;elements:Elements[];message_id:string;message_seq:number;messageId:string;messageSeq:number;sender: {area:any;card:any;level:number;name:any;nick:any;role:Role;sex:any;title:any;uid:string;uin:any;userId:string; } | {area?:undefined;card?:undefined;level?:undefined;name:any;nick:any;role:Role;sex:any;title?:undefined;uid:string;uin:any;userId:string; };time:any; }>
定义于: packages/core/src/adapter/onebot/core/core.ts:273
获取消息
参数
_contact
string | Contact
messageId?
string
消息ID
返回
Promise<{ contact: Contact; elements: Elements[]; message_id: string; message_seq: number; messageId: string; messageSeq: number; sender: { area: any; card: any; level: number; name: any; nick: any; role: Role; sex: any; title: any; uid: string; uin: any; userId: string; } | { area?: undefined; card?: undefined; level?: undefined; name: any; nick: any; role: Role; sex: any; title?: undefined; uid: string; uin: any; userId: string; }; time: any; }>
重写了
getNotJoinedGroupInfo()
getNotJoinedGroupInfo(
_groupId):Promise<GroupInfo>
定义于: packages/core/src/adapter/base/index.ts:528
获取陌生群信息
参数
_groupId
string
群号
返回
Promise<GroupInfo>
继承自
AdapterBase.getNotJoinedGroupInfo
getRkey()
getRkey():
Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:1248
获取 rkey
返回
Promise<any>
rkey
重写了
getStrangerInfo()
getStrangerInfo(
targetId):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:519
获取陌生人信息
参数
targetId
string
用户ID 任选其一
返回
Promise<any>
陌生人信息数组
重写了
getVersion()
getVersion():
Promise<{app_name:any;name:any;protocol:any;version:any; }>
定义于: packages/core/src/adapter/onebot/core/core.ts:881
获取版本信息
返回
Promise<{ app_name: any; name: any; protocol: any; version: any; }>
groupKickMember()
groupKickMember(
groupId,targetId,rejectAddRequest?,_?):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:436
群踢人
参数
groupId
string
群ID
targetId
string
被踢出目标的ID 任选其一
rejectAddRequest?
boolean
是否拒绝再次申请，默认为false
_?
string
返回
Promise<void>
此接口的返回值不值得信任
重写了
init()
init():
Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:26
返回
Promise<void>
KarinConvertAdapter()
KarinConvertAdapter(
data):OneBotMessage[]
定义于: packages/core/src/adapter/onebot/core/core.ts:132
karin转onebot11
参数
data
karin格式消息
返回
OneBotMessage[]
logger()
logger(
level, ...args):void
定义于: packages/core/src/adapter/base/index.ts:75
打印当前Bot的专属日志
参数
level
日志等级
args
...any[]
日志内容
返回
void
继承自
PokeMember()
PokeMember(
_,__):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:1000
参数
_
string
__
string
返回
Promise<void>
pokeUser()
pokeUser(
_contact,_count?):Promise<boolean>
定义于: packages/core/src/adapter/base/index.ts:555
戳一戳用户 支持群聊和私聊
参数
_contact
目标信息
_count?
number
戳一戳次数 默认为1
返回
Promise<boolean>
继承自
recallMsg()
recallMsg(
_,messageId):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:264
撤回消息
参数
_
messageId
string
消息ID
返回
Promise<void>
重写了
registerBot()
registerBot():
void
定义于: packages/core/src/adapter/onebot/core/core.ts:67
注册机器人
返回
void
renameGroupFolder()
renameGroupFolder(
_groupId,_folderId,_name):Promise<boolean>
定义于: packages/core/src/adapter/base/index.ts:449
重命名群文件的文件夹
参数
_groupId
string
群号
_folderId
string
文件夹id
_name
string
文件夹名
返回
Promise<boolean>
无返回值
继承自
selfSubId()
selfSubId(
key):string
定义于: packages/core/src/adapter/base/index.ts:66
获取Bot的subId
参数
key
string
子ID的key
返回
string
继承自
sendAiCharacter()
sendAiCharacter(
groupId,character,text):Promise<{messageId:string; }>
定义于: packages/core/src/adapter/onebot/core/core.ts:1239
设置群 Ai 语音声色
参数
groupId
string
群号
character
string
声色ID
text
string
转换的文本
返回
Promise<{ messageId: string; }>
重写了
sendApi()
sendApi<
T>(action,params,timeout?):Promise<OneBotApi>
定义于: packages/core/src/adapter/onebot/core/core.ts:110
类型参数
T
T extends string | number | symbol
参数
action
T
params
OneBotApi
timeout?
number
返回
Promise<OneBotApi>
sendForwardMsg()
sendForwardMsg(
contact,elements,options?):Promise<any>
定义于: packages/core/src/adapter/onebot/core/core.ts:1083
发送合并转发消息
参数
contact
目标信息
elements
消息元素
options?
首层小卡片外显参数
返回
Promise<any>
重写了
sendLike()
sendLike(
targetId,count):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:424
发送好友赞
参数
targetId
string
目标ID
count
number
赞的次数
返回
Promise<void>
此接口的返回值不值得信任
重写了
sendLongMsg()
sendLongMsg(
contact,resId):Promise<{message_id:string;message_time:number;messageId:string;messageTime:number;rawData:any;time:number; }>
定义于: packages/core/src/adapter/onebot/core/core.ts:230
发送长消息
参数
contact
目标信息
resId
string
资源ID
返回
Promise<{ message_id: string; message_time: number; messageId: string; messageTime: number; rawData: any; time: number; }>
重写了
sendMsg()
sendMsg(
contact,elements,retryCount?):Promise<SendMsgResults>
定义于: packages/core/src/adapter/onebot/core/core.ts:165
发送消息
参数
contact
elements
retryCount?
number
返回
Promise<SendMsgResults>
消息ID
重写了
setAdapterInfo()
setAdapterInfo():
void
定义于: packages/core/src/adapter/onebot/core/core.ts:81
设置登录号信息
返回
void
setAvatar()
setAvatar(
file):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:1220
设置头像
参数
file
string
base64:// file:// http(s)😕/
返回
Promise<void>
是否设置成功
重写了
setBotInfo()
setBotInfo():
Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:104
设置登录号详细信息
返回
Promise<void>
setFriendApplyResult()
setFriendApplyResult(
requestId,isApprove,remark?):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:1012
设置好友请求结果
参数
requestId
string
请求事件ID
isApprove
boolean
是否同意
remark?
string
好友备注 同意时有效
返回
Promise<void>
设置结果
重写了
AdapterBase.setFriendApplyResult
setGroupAdmin()
setGroupAdmin(
groupId,targetId,isAdmin):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:468
设置群管理员
参数
groupId
string
群ID
targetId
string
目标用户的ID
isAdmin
boolean
是否设置为管理员
返回
Promise<void>
此接口的返回值不值得信任
重写了
setGroupAllMute()
setGroupAllMute(
groupId,isBan):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:457
群全员禁言
参数
groupId
string
群ID
isBan
boolean
是否开启全员禁言
返回
Promise<void>
此接口的返回值不值得信任
重写了
setGroupApplyResult()
setGroupApplyResult(
requestId,isApprove,denyReason?):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:1023
设置申请加入群请求结果
参数
requestId
string
请求事件ID
isApprove
boolean
是否同意
denyReason?
string
拒绝理由 拒绝时有效
返回
Promise<void>
此接口的返回值不值得信任
重写了
AdapterBase.setGroupApplyResult
setGroupHighlights()
setGroupHighlights(
_,messageId,create):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:992
设置、取消群精华消息
参数
_
string
messageId
string
群消息ID
create
boolean
true为添加精华消息，false为删除精华消息 默认为true
返回
Promise<void>
重写了
AdapterBase.setGroupHighlights
setGroupMemberCard()
setGroupMemberCard(
groupId,targetId,card):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:479
设置群名片
参数
groupId
string
群ID
targetId
string
目标用户的ID
card
string
新的群名片
返回
Promise<void>
此接口的返回值不值得信任
重写了
AdapterBase.setGroupMemberCard
setGroupMemberTitle()
setGroupMemberTitle(
groupId,targetId,title):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:510
设置群专属头衔 仅群主可用
参数
groupId
string
群ID
targetId
string
目标用户的ID
title
string
新的专属头衔
返回
Promise<void>
此接口的返回值不值得信任
重写了
AdapterBase.setGroupMemberTitle
setGroupMute()
setGroupMute(
groupId,targetId,duration):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:447
禁言群成员
参数
groupId
string
群ID
targetId
string
被禁言目标的ID 任选其一
duration
number
禁言时长 单位:秒
返回
Promise<void>
此接口的返回值不值得信任
重写了
setGroupName()
setGroupName(
groupId,groupName):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:489
设置群名
参数
groupId
string
群ID
groupName
string
新的群名
返回
Promise<void>
此接口的返回值不值得信任
重写了
setGroupQuit()
setGroupQuit(
groupId,isDismiss):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:499
退出群组
参数
groupId
string
群ID
isDismiss
boolean
如果Bot是群主，是否解散群
返回
Promise<void>
此接口的返回值不值得信任
重写了
setGroupRemark()
setGroupRemark(
_groupId,_remark):Promise<boolean>
定义于: packages/core/src/adapter/base/index.ts:520
设置群备注
参数
_groupId
string
群号
_remark
string
新的备注
返回
Promise<boolean>
继承自
setInvitedJoinGroupResult()
setInvitedJoinGroupResult(
requestId,isApprove):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:1033
设置邀请加入群请求结果
参数
requestId
string
请求事件ID
isApprove
boolean
是否同意
返回
Promise<void>
此接口的返回值不值得信任
重写了
AdapterBase.setInvitedJoinGroupResult
setMsgReaction()
setMsgReaction(
contact,messageId,faceId,isSet):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:864
设置消息表情回应
参数
contact
目标信息
messageId
string
消息ID
faceId
表情ID
string | number
isSet
boolean
返回
Promise<void>
此接口的返回值不值得信任
重写了
unregisterBot()
unregisterBot():
void
定义于: packages/core/src/adapter/onebot/core/core.ts:75
卸载注册的机器人
返回
void
uploadFile()
uploadFile(
contact,file,name,folder?):Promise<void>
定义于: packages/core/src/adapter/onebot/core/core.ts:977
上传群文件、私聊文件
参数
contact
目标信息
file
string
本地文件绝对路径
name
string
文件名称 必须提供
folder?
string
父目录ID 不提供则上传到根目录 仅在群聊时有效
返回
Promise<void>
此接口的返回值不值得信任
重写了
uploadGroupFile()
uploadGroupFile(
_groupId,_file,_name?):Promise<boolean>
定义于: packages/core/src/adapter/base/index.ts:471
上传群文件
参数
_groupId
string
群号
_file
string
文件绝对路径
_name?
string
文件名
返回
Promise<boolean>
无返回值
Description
此接口仅可以在Bot和协议端在同一台设备上时使用