资源

API列表

本列表中各指令按模块划分和排序。

提示

API注记规则

注记 说明 用例
<提示信息> 此处应填入指定内容 !t <编号> <译文> 应填入 !t #1234 早上好
[可选内容] 此处内容可以不填写 !反馈 <反馈标题>[ <反馈内容>] 写入 !反馈 有BUG 使用不了命令!反馈 命令无效 均合法

提示

指令识别规则

  • 指令前方的 ! 为注记符,可以使用全角(中文)的 进行替换。
  • 指令前方的 # 做注记符时,不可以使用全角(日文)的 进行替换。
  • 指令通常有多种表示形式,其功能完全相同。
  • 指令中通常使用半角空格作为分隔符,实际上可以使用回车换行进行分隔,与半角空格等价,但不可以使用全角空格替代。

提示

ToBot * 部分指令为了排除同一群内有多个使用本后端的BOT而导致的冲突问题,因此设置了 ToBot 限制:

  • 群聊中需要@BOT使命令生效
  • 私聊中默认全部命令ToBot有效
  • 在API中以 是/否 进行标明,否即为无需 ToBot ,是即为必须使 ToBot 有效

提示

权限 各指令均有对权限的要求,大致分为 超级管理员 | 管理员 | 用户 三类。

参见

详情参见 权限管理

BOT管理命令

用户反馈

插件:反馈

本插件用于让用户向管理员提出消息反馈,以便项目维护和意见问题收集。

信息反馈

LTS 新版功能.

指令 !反馈 <反馈标题>[ <反馈内容>]
!feedback <反馈标题>[ <反馈内容>]
权限 反馈权限
ToBot
参数 反馈标题 想要反馈的问题标题
反馈内容 想要反馈的问题内容
可选参数默认值 反馈内容

处理反馈

LTS 新版功能.

指令 !处理反馈 <反馈ID> <反馈答复>
!dealfeedback <反馈ID> <反馈答复>
权限 管理权限
ToBot
参数 反馈ID 反馈信息ID(可通过 `反馈列表`_ 查看)
反馈答复 关于反馈信息的答复

完成反馈

v3 新版功能.

指令 !反馈完成 <反馈ID>
!反馈处理完成 <反馈ID>
权限 管理权限
ToBot
参数 反馈ID 反馈信息ID(可通过 `反馈列表`_ 查看)

查看反馈列表

LTS 新版功能.

指令 !反馈列表[ <页码>]
!feedbacklist[ <页码>]
权限 管理权限
ToBot
参数 页码 反馈列表对应的页码(5条/页)
可选参数默认值 页码 1

消息流管理

插件:消息流管理

本插件会对BOT的消息流进行管理,并支持打开/关闭/编辑消息流状态。

查看指定消息流状态

v3 新版功能.

指令 !查询指定信息流状态 <BOT标识> <BOTID>
权限 信息查看权限
ToBot
参数 BOT标识 BOT使用的协议名(cqhttp/dingding)
BOTID BOT编号

提示

消息流默认状态

消息流默认处于开启状态,此时BOT将正常运行。 关闭BOT的消息流后,BOT将不会接收消息,处于禁用状态。

开启指定消息流

v3 新版功能.

指令 !开启指定信息流 <BOT标识> <BOTID>
权限 管理权限
ToBot
参数 BOT标识 BOT使用的协议名(cqhttp/dingding)
BOTID BOT编号

关闭指定消息流

v3 新版功能.

指令 !关闭指定信息流 <BOT标识> <BOTID>
权限 管理权限
ToBot
参数 BOT标识 BOT使用的协议名(cqhttp/dingding)
BOTID BOT编号

查看当前消息流状态

v3 新版功能.

指令 !消息流状态
权限 信息查看权限
ToBot
参数

开启当前消息流

v3 新版功能.

指令 !开启消息流
权限 管理权限
ToBot
参数

关闭当前消息流

v3 新版功能.

指令 !关闭消息流
权限 管理权限
ToBot
参数

获取消息流组标识

v3 新版功能.

指令 !获取消息流组标识
权限 信息查看权限
ToBot
参数

消息流定向放行

v3 新版功能.

指令 !消息流定向放行 <消息来源> <BOTID>
权限 管理权限
ToBot
参数 消息来源 目标放行的(BOT的)消息来源组(群聊/私聊)
BOTID 目标放行的BOT

消息流定向阻止

v3 新版功能.

指令 !消息流定向阻止 <消息来源> <BOTID>
权限 管理权限
ToBot
参数 消息来源 目标阻止的(BOT的)消息来源组(群聊/私聊)
BOTID 目标阻止的BOT

放行当前数据流

v3 新版功能.

指令 !消息流放行
权限 管理权限
ToBot
参数

阻止当前数据流

v3 新版功能.

指令 !消息流阻止
权限 管理权限
ToBot
参数

权限管理

插件:权限管理

本插件用于用户的权限管理,部分命令需要用户持有相应权限才可以触发使用。

提示

关于权限

OneTweBot中各插件权限均保持独立,其中超级管理员拥有最高权限,不受任何权限管理约束(须在启动服务时使用QQ号配置)。 对于用户权限等级做以下划分:

  • 超级管理员
  • 任何人(无需任何授权即可使用)
  • 插件管理者(仅用于超级管理员授权)
  • 临时群聊
  • 临时私聊
  • 群聊
  • 私聊
  • 未知(仅用于事件生成)
  • 未授权(需要授权使用插件的默认值)

各插件均会有初始默认权限,并可以进行授权。 (部分需要使用有限API资源的插件默认权限为 未授权 ,此时必须需要超级管理员授权方可正常使用该插件。例如:烤推插件、推送插件等) 插件在授权后,通常会有两个权限等级:

  • 插件管理员
  • 插件授权用户

在各插件中会使用对应插件的权限等级进行标注和说明。

合法权限组列表

LTS 新版功能.

指令 !合法权限组列表[ <页码>]
权限 信息查看权限
ToBot
参数 页码 反馈列表对应的页码(5条/页)
可选参数默认值 页码 1

查看合法权限组内合法权限列表

指令 !合法权限列表 <合法权限组>[ <页码>]
权限 信息查看权限
ToBot
参数 合法权限组 想要查看的合法权限组
页码 反馈列表对应的页码(5条/页)
可选参数默认值 页码 1

查看授权

LTS 新版功能.

指令 !查看授权 <合法权限组>[ <页码>]
权限 任何人
ToBot
参数 页码 反馈列表对应的页码(5条/页)
可选参数默认值 页码 1

远程授权

v3 新版功能.

指令 !远程授权 <消息来源> <消息来源ID> <权限组>
权限 管理权限
ToBot
参数 消息来源 所要授权的(BOT的)消息来源组(群聊/私聊)
消息来源ID 授权的消息来源组(群聊/私聊)ID
权限组 所要授权权限所在的合法权限组
权限名 所要授权权限的权限名
可选参数默认值 页码 1

远程取消授权

v3 新版功能.

指令 !远程取消授权 <消息来源> <消息来源ID> <权限组>
权限 管理权限
ToBot
参数 消息来源 所要授权的(BOT的)消息来源组(群聊/私聊)
消息来源ID 授权的消息来源组(群聊/私聊)ID
权限组 所要授权权限所在的合法权限组
权限名 所要授权权限的权限名
可选参数默认值 页码 1

远程禁用授权

v3 新版功能.

指令 !远程禁用授权 <消息来源> <消息来源ID> <权限组>
权限 任何人
ToBot
参数 消息来源 所要授权的(BOT的)消息来源组(群聊/私聊)
消息来源ID 授权的消息来源组(群聊/私聊)ID
权限组 所要授权权限所在的合法权限组
权限名 所要授权权限的权限名
可选参数默认值 页码 1

查询授权

LTS 新版功能.

指令 !查询授权 <消息来源> <消息来源ID> <权限组>
权限 任何人
ToBot
参数 消息来源 所要授权的(BOT的)消息来源组(群聊/私聊)
消息来源ID 授权的消息来源组(群聊/私聊)ID
权限组 所要授权权限所在的合法权限组
权限名 所要授权权限的权限名
可选参数默认值 页码 1

插件管理

插件:插件管理

本插件为内置插件管理,可通过远程和本地编辑全局和某一聊天内的插件启用状态。

查看插件帮助信息

v3 新版功能.

指令 !帮助[ <插件名> <页码>]
权限 任何人
ToBot

全局禁用插件

v3 新版功能.

指令 !全局禁用插件 <插件名>
权限 全局管理权限
ToBot

全局启用插件

v3 新版功能.

指令 !全局启用插件 <插件名>
权限 全局管理权限
ToBot

禁用插件

v3 新版功能.

指令 !禁用插件 <插件名>
权限 群聊管理员/群主
ToBot

启用插件

v3 新版功能.

指令 !启用插件 <插件名>
权限 群聊管理员/群主
ToBot

查看插件列表

LTS 新版功能.

指令 !插件列表 <页码>
权限 信息查看权限
ToBot

推送命令

推特推送

插件:推特推送管理

本插件基于推特开发者账号所使用的TwitterAPI进行推文获取和推送,可作为稳定的推特订阅途径。

推特订阅授权

LTS 新版功能.

指令 !转推授权
权限 使用的管理权限
ToBot

取消推特订阅授权

LTS 新版功能.

指令 !取消转推授权
权限 使用的管理权限
ToBot

定向清空转推列表

LTS 新版功能.

指令 !定向清空转推列表 <消息来源标识> <消息来源ID>
权限 任何人
ToBot

定向清空转推对象

LTS 新版功能.

指令 !定向清空转推对象 <用户名>
权限 任何人
ToBot

全局转推列表

LTS 新版功能.

指令 !全局转推列表
权限 任何人
ToBot

添加辅助转推

v3 新版功能.

指令 !添加辅助转推 <用户名>
权限 任何人
ToBot

删除辅助转推

v3 新版功能.

指令 !删除辅助转推 <用户名>
权限 任何人
ToBot

查看辅助转推列表

v3 新版功能.

指令 !辅助转推列表[ <页码>]
权限 获取缓存信息权限
ToBot

启动主监听

v3 新版功能.

关闭主监听

v3 新版功能.

启动辅助监听

v3 新版功能.

关闭辅助监听

v3 新版功能.

获取推文

LTS 新版功能.

指令 !获取推文 <推文ID>
权限 管理权限
ToBot

推送优先级设置列表

v3 新版功能.

指令 !推送优先级设置列表
权限 管理权限
ToBot

设置推送优先级

v3 新版功能.

指令 !设置推送优先级 <用户ID> <优先级>
权限 管理权限
ToBot

查询推特用户

LTS 新版功能.

指令 !查询推特用户 <推特用户ID/推特用户名>
权限 使用权限
ToBot

查看推文列表

LTS 新版功能.

指令 !推文列表[ <推特用户ID/推特用户名> <页码>]
权限 使用权限
ToBot

添加推特账号订阅

LTS 新版功能.

指令 !加推 <用户名>[ <昵称> <描述>]
指令 !addone <用户名>[ <昵称> <描述>]
指令 !D一个 <用户名>[ <昵称> <描述>]
权限 群聊管理员/群主
ToBot

删除推特账号订阅

LTS 新版功能.

指令 !减推 <用户名>[ <昵称> <描述>]
!delone <用户名>[ <昵称> <描述>]
!少D一个 <用户名>[ <昵称> <描述>]
权限 群聊管理员/群主
ToBot

查看当前账号订阅列表

LTS 新版功能.

指令 !转推列表[ <用户名>]
!pushlist[ <用户名>]
!DD列表[ <用户名>]
!单推列表[ <用户名>]
权限 群聊管理员/群主
ToBot

清空当前账号订阅列表

LTS 新版功能.

指令 !清空推送
!delallpush
权限 任何人
ToBot

查看转推设置列表

LTS 新版功能.

指令 !转推设置列表[ <配置名>]
权限 任何人
ToBot

修改转推设置

LTS 新版功能.

指令 !转推设置 <属性> <属性值>
权限 任何人
ToBot

转推单元设置

v3 新版功能.

指令 !转推单元设置 <对象ID> <属性> <属性值>
权限 任何人
ToBot

转推单元设置列表

v3 新版功能.

指令 !转推单元设置列表 <用户名> <配置名>
权限 任何人
ToBot

压缩推特ID

LTS 新版功能.

指令 !64进制编码 <推文ID>
!2t64编码 <推文ID>
!压缩推文ID <推文ID>
权限 任何人
ToBot

解压推特ID

LTS 新版功能.

指令 !64进制解码 <推文ID>
!2t64解码 <推文ID>
!解压推文ID <推文ID>
权限 任何人
ToBot

RSS订阅

插件:RSShub推送管理

本插件基于RSSHub,支持一切合法RSS订阅。同时针对Bilibili直播/动态与推特时间线,支持直接使用主页/直播间地址进行订阅。

RSS订阅授权

LTS 新版功能.

指令 !RSS订阅授权
权限 管理授权开关权限
ToBot

取消RSS订阅授权

LTS 新版功能.

指令 !取消RSS订阅授权
权限 管理授权开关权限
ToBot

启动RSS监听

LTS 新版功能.

指令 !启动RSS监听
权限 管理权限
ToBot

关闭RSS监听

LTS 新版功能.

指令 !关闭RSS监听
权限 管理权限
ToBot

设置RSS优先级

v3 新版功能.

指令 !设置RSS优先级 <RSS订阅地址> <优先级>
权限 管理权限
ToBot

RSS优先级设置列表

v3 新版功能.

指令 !RSS优先级设置列表
权限 管理权限
ToBot

添加RSS订阅

LTS 新版功能.

指令 !订阅 <RSS订阅地址>[ <昵称> <推送描述> <选项>]
权限 使用权限
ToBot

取消RSS订阅

LTS 新版功能.

指令 !取消订阅 <RSS订阅地址>
权限 任何人
ToBot

订阅源解码

LTS 新版功能.

指令 !订阅源解码 <RSS订阅地址>
权限 群聊管理员/群主
ToBot

查看订阅列表

LTS 新版功能.

指令 !订阅列表 <页码>
权限 群聊管理员/群主
ToBot

清空订阅列表

LTS 新版功能.

指令 !清空订阅
权限 群聊管理员/群主
ToBot

翻译命令

推特翻译

插件:烤推

本插件主要实现的功能是对推特推文的人工翻译自动嵌字, 可通过消息中的文本生成含有翻译的图片,支持使用自定义 的嵌字模板。

推特翻译授权

LTS 新版功能.

指令 !烤推授权
权限 管理权限
ToBot

取消推特翻译授权

LTS 新版功能.

指令 !取消烤推授权
权限 管理权限
ToBot

设置烤推模板

v3 新版功能.

指令 !设置烤推模板 <模板内容>
!设置烤推模版 <模板内容>
权限 群聊管理员/群主
ToBot

发起推特翻译

LTS 新版功能.

指令 !烤推 <推文标识> <推文译文>
!t <推文标识> <推文译文>
#<推文临时ID> <推文译文>
权限 使用权限
ToBot

已翻译推特列表

LTS 新版功能.

指令 !烤推列表
!tl
权限 使用权限
ToBot

获取最新推特翻译结果

LTS 新版功能.

指令 !烤推结果
权限 使用权限
ToBot

获取指定推特翻译结果

LTS 新版功能.

指令 !推文任务
权限 使用权限
ToBot

显示推特翻译帮助信息

LTS 新版功能.

指令 !烤推帮助
权限 使用权限
ToBot

机器翻译

插件:翻译翻译

本插件通过调用各翻译引擎的公开API进行机器翻译,用以为推文翻译提供参考。

警告

API限额

本插件所使用的API为免费版本的公开API,故存在翻译限额,使用时请节约流量。

手动机器翻译

v3 新版功能.

指令 翻译[ <翻译引擎> <源语言> <目标语言>] <待翻译文本>
!机翻[ <翻译引擎> <源语言> <目标语言>] <待翻译文本>
机翻[ <翻译引擎> <源语言> <目标语言>] <待翻译文本>
权限 翻译权限
ToBot

启用流式翻译

v3 新版功能.

指令 !启动流式翻译 <对象> [ <翻译引擎> <源语言> <目标语言>]
权限 设置流式翻译的权限
ToBot

关闭流式翻译

v3 新版功能.

指令 !关闭流式翻译 <对象> [ <翻译引擎> <源语言> <目标语言>]
权限 设置流式翻译的权限
ToBot

显示流式翻译列表

v3 新版功能.

指令 !流式翻译列表
权限 设置流式翻译的权限
ToBot

清空流式翻译列表

v3 新版功能.

指令 !清空流式翻译列表
权限 设置流式翻译的权限
ToBot

其他功能

内置的周边功能,欢迎使用BothBot协议进行个性化开发!

测试插件

插件:插件例程

本插件的示例插件。目前内置的示例可用于BOT收发测试的功能,主要目的为测试联通性。

权限组测试

v3 新版功能.

指令 !233
权限 使用233的权限
ToBot

固定回复测试

v3 新版功能.

指令 !爬
权限 任何人
ToBot

图片传输测试

v3 新版功能.

指令 !来图
权限 任何人
ToBot

随机回复测试

LTS 新版功能.

指令 !爪巴
权限 任何人
ToBot

消息解析测试

v3 新版功能.

指令 !复读 <复读内容>
权限 任何人
参数 复读内容 需要BOT复读的内容
ToBot

异常返回测试

LTS 新版功能.

指令 !绝活
!异常
!无内鬼报个错
权限 任何人
ToBot

拓展资料阅读

部分部署时需要的前置知识相关资料,在此罗列以供阅读。