Skip to content

API 总览 ​

HotCat Bot 所有公共 API 按类组织:

类访问方式说明
BotClientnew BotClient(config)Bot 客户端,封装连接和启动
BotApibot.api.xxx()所有 napcat API 的统一封装
BotEventbot.event.xxx()事件监听,按类别分组
BotSchedulerbot.scheduler.xxx()定时任务调度
BotPluginSystembot.plugin.xxx()插件注册、加载、热重载、目录监听
MessageMessage.xxx()消息段构建器

架构 ​

BotClient
 ├── api: BotApi          → bot.api.sendGroupMessage(...)
 │    └── napcat: NCWebsocket   (底层 napcat 实例)
 ├── event: BotEvent      → bot.event.message.onGroupMessage(...)
 │    ├── message: MessageEvent       (收到的消息)
 │    ├── messageSent: MessageSent    (发出的消息回执)
 │    ├── request: RequestEvent       (加好友/加群请求)
 │    └── notice: NoticeEvent         (通知事件)
 ├── scheduler: BotScheduler → bot.scheduler.cron(...)
 ├── plugin: BotPluginSystem → bot.plugin.register(...)
 ├── nickname: string     (bot 昵称)
 └── id: number           (bot QQ 号)

快速索引 ​

BotApi 方法分类 ​

分类方法数常用方法
消息发送10sendMessage, sendGroupMessage, sendPrivateMessage, sendForwardMsg
消息管理12deleteMessage, getMessage, markMsgAsRead, translateEn2zh
群管理12banMember, kickMember, setGroupAdmin, setGroupCard
群公告3sendGroupNotice, getGroupNotice, deleteGroupNotice
群信息10getGroupInfo, getGroupMemberList, getGroupHonorInfo
精华消息3getEssenceMsgList, setEssenceMsg, deleteEssenceMsg
用户/好友8getFriendList, getStrangerInfo, deleteFriend
群互动5groupPoke, friendPoke, sendLike, sendPoke
文件/资源9getImage, getRecord, uploadGroupFile, ocrImage
群文件6getGroupRootFiles, createGroupFileFolder
收藏2createCollection, getCollectionList
AI3getAiCharacters, sendGroupAiRecord
系统13getStatus, getCookies, setQQProfile
推荐2recommendContact, recommendGroup
小程序1getMiniAppArk

BotEvent 事件分类 ​

分类属性事件数
接收消息bot.event.message6
发送回执bot.event.messageSent6
请求bot.event.request4
通知bot.event.notice16

BotScheduler 定时任务 ​

方法说明示例
cron()cron 表达式cron('0 8 * * *', fn)
every()固定间隔every('5m', fn)
at()指定时间at('08:00', fn)
cancel()取消任务cancel(id)
cancelAll()取消全部cancelAll()

基于 MIT 许可发布