@koishijs/plugin-adapter-onebot
OneBot 是一个聊天机器人应用接口标准,目前可用于 QQ 等平台。
接入方式
请自行参考 OneBot 实现侧的文档进行搭建,随后填写下面的配置项。
配置项
config.protocol
- 可选值: http, ws, ws-reverse
要使用的协议类型。
config.token
- 类型:
string
发送信息时用于验证的字段。
config.endpoint
- 类型:
string
如果使用了 HTTP,则该配置将作为发送信息的服务端;如果使用了 WebSocket,则该配置将作为监听事件和发送信息的服务端。
config.proxyAgent
- 类型:
string
- 默认值:
app.config.request.proxyAgent
请求时默认使用的网络代理。
config.path
- 类型:
string
- 默认值:
'/onebot'
服务器监听的路径。仅用于 HTTP 或 WS Reverse 通信方式。
config.secret
- 类型:
string
接收信息时用于验证的字段,应与 OneBot 的 secret
配置保持一致。
内部 API
你可以通过 bot.internal
或 session.onebot
访问内部 API,参见 访问内部接口。
OneBot v11 标准 API
onebot.sendPrivateMsg()
onebot.sendGroupMsg()
onebot.deleteMsg()
onebot.getMsg()
onebot.getForwardMsg()
onebot.sendLike()
onebot.setGroupKick()
onebot.setGroupBan()
onebot.setGroupAnonymousBan()
onebot.setGroupWholeBan()
onebot.setGroupAdmin()
onebot.setGroupAnonymous()
onebot.setGroupCard()
onebot.setGroupName()
onebot.setGroupLeave()
onebot.setGroupSpecialTitle()
onebot.setFriendAddRequest()
onebot.setGroupAddRequest()
onebot.getLoginInfo()
onebot.getStrangerInfo()
onebot.getFriendList()
onebot.getGroupInfo()
onebot.getGroupList()
onebot.getGroupMemberInfo()
onebot.getGroupMemberList()
onebot.getGroupHonorInfo()
onebot.getCookies()
onebot.getCsrfToken()
onebot.getCredentials()
onebot.getRecord()
onebot.getImage()
onebot.canSendImage()
onebot.canSendRecord()
onebot.getStatus()
onebot.getVersionInfo()
onebot.setRestart()
onebot.cleanCache()
go-cqhttp 扩展 API
onebot.sendGroupForwardMsg()
onebot.markMsgAsRead()
onebot.sendGroupSign()
onebot.qidianGetAccountInfo()
onebot.setQqProfile()
onebot.getUnidirectionalFriendList()
onebot.deleteFriend()
onebot.setGroupPortrait()
onebot.getWordSlices()
onebot.ocrImage()
onebot.getGroupSystemMsg()
onebot.uploadPrivateFile()
onebot.uploadGroupFile()
onebot.getGroupFileSystemInfo()
onebot.getGroupRootFiles()
onebot.getGroupFilesByFolder()
onebot.createGroupFileFolder()
onebot.deleteGroupFolder()
onebot.deleteGroupFile()
onebot.getGroupFileUrl()
onebot.getGroupAtAllRemain()
onebot.getVipInfo()
onebot.sendGroupNotice()
onebot.getGroupNotice()
onebot.reloadEventFilter()
onebot.downloadFile()
onebot.getOnlineClients()
onebot.getGroupMsgHistory()
onebot.setEssenceMsg()
onebot.deleteEssenceMsg()
onebot.getEssenceMsgList()
onebot.checkUrlSafely()
onebot.getModelShow()
onebot.setModelShow()
onebot.delete_unidirectional_friend()
onebot.send_private_forward_msg()