From 178cd18a76d469e9a99b4dd2c86430e08d04ae08 Mon Sep 17 00:00:00 2001 From: MX-fox <1009592348@qq.com> Date: Sat, 12 Oct 2024 09:32:03 +0800 Subject: [PATCH] =?UTF-8?q?docs(QQ):=20=E5=B0=86=E5=AE=98=E6=96=B9?= =?UTF-8?q?=E6=9C=BA=E5=99=A8=E4=BA=BA=E7=9B=B8=E5=85=B3=E5=86=85=E5=AE=B9?= =?UTF-8?q?=E8=BF=81=E7=A7=BB=E8=87=B3=E5=8D=95=E7=8B=AC=E4=B8=80=E8=8A=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/catalogue.ts | 3 +- docs/deploy/platform-qq-official.md | 157 ++++++++++++++++++++++++++++ docs/deploy/platform-qq.md | 151 +------------------------- 3 files changed, 161 insertions(+), 150 deletions(-) create mode 100644 docs/deploy/platform-qq-official.md diff --git a/docs/.vitepress/catalogue.ts b/docs/.vitepress/catalogue.ts index cf2bf69cd..0d962ed40 100644 --- a/docs/.vitepress/catalogue.ts +++ b/docs/.vitepress/catalogue.ts @@ -24,6 +24,7 @@ export const deployNav = { items: [ { text: "QQ", link: "/deploy/platform-qq" }, { text: "QQ - Docker 中的海豹", link: "/deploy/platform-qq-docker" }, + { text: "QQ 官方机器人", link: "/deploy/platform-qq-official" }, { text: "KOOK", link: "/deploy/platform-kook" }, { text: "DoDo", link: "/deploy/platform-dodo" }, { text: "Discord", link: "/deploy/platform-discord" }, @@ -80,10 +81,10 @@ export const deploySidebar = { { text: "LLOneBot", link: "/deploy/platform-qq#llonebot" }, { text: "NapCatQQ", link: "/deploy/platform-qq#napcatqq" }, { text: "Chronocat", link: "/deploy/platform-qq#chronocat" }, - { text: "官方机器人", link: "/deploy/platform-qq#%E5%AE%98%E6%96%B9%E6%9C%BA%E5%99%A8%E4%BA%BA" }, ] }, { text: "QQ - Docker 中的海豹", link: "/deploy/platform-qq-docker" }, + { text: "QQ 官方机器人", link: "/deploy/platform-qq-official" }, { text: "KOOK", link: "/deploy/platform-kook" }, { text: "DoDo", link: "/deploy/platform-dodo" }, { text: "Discord", link: "/deploy/platform-discord" }, diff --git a/docs/deploy/platform-qq-official.md b/docs/deploy/platform-qq-official.md new file mode 100644 index 000000000..e53e7823c --- /dev/null +++ b/docs/deploy/platform-qq-official.md @@ -0,0 +1,157 @@ +--- +lang: zh-cn +title: QQ 官方机器人 +--- + +# QQ 官方机器人 + +海豹从 开始支持对接 QQ 官方的机器人服务。 + +::: info 本节内容 + +本节将包含你在 QQ 官方机器人平台接入海豹核心需要了解的特定内容。 + +::: + +::: tip 提示：QQ 机器人 + +QQ 官方目前已开放了机器人功能，可进入 [QQ 开放平台](https://q.qq.com/#/) 进行申请。 + +搭建机器人官方请参考 [QQ 机器人文档](https://bot.q.qq.com/wiki/#/)。 + +目前， **QQ 官方机器人已开放个体使用权限。但官方文档没有及时更新**。 + +同时，由于 QQ 官方对机器人能力的严格限制（包括获取 QQ 号、昵称，非 @ 时响应，私聊，群控、发送本地图片等大量功能目前不支持），目前**对接官方接口的骰子很多功能无法支持**（如跑团 Log ，暗骰，对抗等）。 + +QQ 官方机器人的优点，就是不用担心被风控。 + +::: + +## 尝试一下 + +如果你想尝试一下这样的机器人，非常欢迎你使用海豹官方的骰子： + +海豹机器人二维码 + +## 获取连接所需信息 + +要获取用于连接海豹的信息之前，你需要建立好一个 QQ 机器人应用。可前往 [QQ 开放平台](https://q.qq.com/#/) 进行申请，**实名**注册后，创建一个机器人应用。 + +创建完成后，进入机器人管理后台，切换到「开发设置」页面： + +切换到开发设置 + +在页面中你可以看到这样的信息，其中「机器人 ID 」「机器人令牌」「机器人密钥」这三项是海豹进行连接所需要的。 + +![开发设置](./images/platform-qq-official-2.png) + +然后在「开发设置 IP 白名单」一栏中，填写你骰子所在电脑的 **公网** IP。（使用云服务器时，请填写对应云服务商在控制台提供的 IP） + +连接官方 Bot + +::: warning 注意：家庭网络的 IP 变动 + +如果你使用的是家用网络，在本地电脑运行海豹，要注意家庭网络的 IP 通常是不固定的，运营商随时可能会更换你的 IP，遇到问题时请先检查。 + +::: + +## 连接海豹 + +登录海豹并添加账号，选择「QQ(官方机器人)」。填写对应的信息点击连接。你的海豹应该可以正常连接官方机器人运作了！ + +连接官方 Bot + +## 指令配置 + +1. 进入「发布配置」页面； +2. 点击「功能配置」； +3. 点击「指令配置」； +4. 再点击右上角的「重新配置」开始编辑； +5. 点开「指令」页添加指令，「指令名」里面输入对应指令（例如 `r`、`ra`、`en`），`/` 是 QQ 官方机器人默认的指令前缀（海豹也支持使用 `/`）； +6. 然后在「指令介绍」一栏填写指令的简介； +7. 然后在「使用场景」一栏点击「QQ 频道」、「频道私信」、「QQ 群」，切记不能选中「消息列表」； +8. 确认配置完成后，扫码确认修改，就可以完成指令配置。 + +进入指令配置页 + +进行指令配置 + +::: details 推荐指令列表模版 + +推荐指令列表模版1 + +推荐指令列表模版2 + +::: + +## 机器人上线 + +点开「使用范围和人员页面」，进入「编辑」页，参考下面图片中编辑使用范围与人员。 + +连接官方 Bot + +配置完成后，点击「发布配置」页面，上传「自测报告」与「隐私协议」。 + +::: details 「隐私协议」与「自测报告」模板 + +这里提供了海豹骰的机器人「隐私协议」与「自测报告」模版。 + +**强烈建议你按自身情况进行修改，绝对不要原样上传，这涉及到你的机器人是否能被 QQ 官方的工作人员审核通过。** + +[机器人自测报告.xlsx](https://github.com/sealdice/sealdice-manual-next/blob/main/assets/%E6%9C%BA%E5%99%A8%E4%BA%BA%E8%87%AA%E6%B5%8B%E6%8A%A5%E5%91%8A.xlsx?raw=true) + +[第三方机器人隐私保护指引.docx](https://github.com/sealdice/sealdice-manual-next/blob/main/assets/%E7%AC%AC%E4%B8%89%E6%96%B9%E6%9C%BA%E5%99%A8%E4%BA%BA%E9%9A%90%E7%A7%81%E4%BF%9D%E6%8A%A4%E6%8C%87%E5%BC%95.docx?raw=true) + +如果你对「指令列表」的指令进行了修改，或者新增了其他功能，请自行修改，需要在「预期输出」一栏填「指令简介」。 + +::: + +点击「提交审核」后，等待 QQ 官方人员测试并审核（时间不定）。审核通过后，在「发布设置」页面中点击「上线机器人」。 + +::: tip 提示：关于 QQ 审核 + +目前 QQ 审核主要是测试机器人能否在所选支持的场景下，正常回应指令列表里的指令（在没有添加任何其他内容前提下），为人工审核。 + +在提交审核前，请善用沙盒群，测试你提交的自测报告中，所提到的指令是否都能正常工作，机器人需要正常发出回应。 + +如果你的指令包含一些需要填写的参数，请务必在「自测报告」表格「特殊说明」一栏里补充说明。（你可以参考模板中对 `.ra` `.sc` `.en` 指令的特殊说明。） + +如果审核未通过，点击右上角的「通知」查看原因，解决后再次提交。 如果实在无法解决，可加入「QQ 机器人官方频道」，在「寻求｜｜审核和及 bug 」一栏里，发帖询问。 + +::: + +## 使用海豹 + +点击「使用人员与范围」页面，查看你的机器人对应的邀请二维码，扫码添加即可。 + +::: warning 注意 + +目前官方机器人只响应包含 `@` 的消息，操作时请注意。 + +同时，官方机器人一次只能发一条消息，一次性发送消息太多，官方机器人会因为消息发送过于频繁而报错。 + +此外，官方机器人目前无法发送本地图片。 + +::: + +## 注意事项 + +大部分事项 [QQ 机器人文档](https://bot.q.qq.com/wiki) 都有说明，这里补充一些文档中没有说明的其他事项： + +### 企业账号的开发者资质审核 + +如果你使用企业账号进行了注册，请记得在资料一栏中进行开发者资质状态审核。该审核需要将对应企业的银行卡号上传至腾讯审核，期间的等待时间可能较久。在开发者资质状态通过后，你才能将官方机器人送审。 + +开发者资质状态审核 + +### 机器人官方频道跳转 + +机器人「资料卡」页面中资料卡设置一栏中，「机器人官方频道跳转」不能是骰子的「沙盒频道」。 + +机器人官方频道跳转 + +### 功能审核未通过 + +有时候「功能配置」页面中，「功能配置与提审」旁显示审核通过，但实际并没有通过，这时点击「机器人上线」的会显示发送错误。 + +遇见这种情况请点击「通知」，看机器人哪方面没过审，修改后再次提交审核。 diff --git a/docs/deploy/platform-qq.md b/docs/deploy/platform-qq.md index b7b1b8569..f87f9f7bb 100644 --- a/docs/deploy/platform-qq.md +++ b/docs/deploy/platform-qq.md @@ -23,7 +23,7 @@ title: QQ 因此，*是否在 QQ 平台搭建这样的非官方机器人取决于你的慎重考虑*。同时，第三方方案的可用性也可能会随时间推移而存在变化，海豹官方无法做出任何保证。 -目前，仅有 [官方机器人服务](#官方机器人) 是被 QQ 官方认可的机器人方案。该方案可用性由 QQ 官方保证，但目前 **仅对企业用户和部分受邀个人用户开放**，同时在功能上非常受限。 +目前，仅有 [官方机器人服务](./platform-qq-official.md) 是被 QQ 官方认可的机器人方案。该方案可用性由 QQ 官方保证，但目前 **仅对企业用户和部分受邀个人用户开放**，同时在功能上非常受限。 如果有可能，建议迁移到其它平台，在 QQ 平台选择何种方式取决于你自己的选择。 @@ -44,7 +44,7 @@ title: QQ - 需要比较简单的部署流程，希望资源占用低的，见 [Lagrange](#lagrange)； - 需要比较简单的部署流程，不是特别在意资源占用的，见 [LLOneBot](#llonebot)； - 通过 docker 部署海豹的，见 [QQ - Docker 中的海豹](./platform-qq-docker)； -- 如果你有 QQ 官方机器人权限，见 [官方机器人](#官方机器人)； +- 如果你有 QQ 官方机器人权限，见 [官方机器人](./platform-qq-official.md)； - Go-cqhttp 与 QSign 方案因可用性原因已被弃用。**我们不建议任何用户再使用此方式部署 QQ 接入，同时强烈建议正在使用该方案的用户迁移**。 不同的对接方式适应不同的情况，可能会存在途径特有的功能缺失和其它问题，请根据自己的情况选择适合的方式。 @@ -241,150 +241,3 @@ NapCat 是基于官方 NTQQ 实现的 Bot 框架，因此在开始前，你需 #### Chronocat Satori 协议 在账号添加中，选择「[WIP]Satori」，填写相应信息进行连接。 - -## 官方机器人 - -海豹从 开始支持对接 QQ 官方的机器人服务。 - -::: tip 提示：QQ 机器人 - -QQ 官方目前已开放了机器人功能，可进入 [QQ 开放平台](https://q.qq.com/#/) 进行申请。 - -搭建机器人官方请参考 [QQ 机器人文档](https://bot.q.qq.com/wiki/#/)。 - -目前， **QQ 官方机器人已开放个体使用权限。但官方文档没有及时更新**。 - -同时，由于 QQ 官方对机器人能力的严格限制（包括获取 QQ 号、昵称，非 @ 时响应，私聊，群控、发送本地图片等大量功能目前不支持），目前**对接官方接口的骰子很多功能无法支持**（如跑团 Log ，暗骰，对抗等）。 - -QQ 官方机器人的优点，就是不用担心被风控。 - -::: - -### 尝试一下 - -如果你想尝试一下这样的机器人，非常欢迎你使用海豹官方的骰子： - -海豹机器人二维码 - -### 获取连接所需信息 - -要获取用于连接海豹的信息之前，你需要建立好一个 QQ 机器人应用。可前往 [QQ 开放平台](https://q.qq.com/#/) 进行申请，**实名**注册后，创建一个机器人应用。 - -创建完成后，进入机器人管理后台，切换到「开发设置」页面： - -切换到开发设置 - -在页面中你可以看到这样的信息，其中「机器人 ID 」「机器人令牌」「机器人密钥」这三项是海豹进行连接所需要的。 - -![开发设置](./images/platform-qq-official-2.png) - -然后在「开发设置 IP 白名单」一栏中，填写你骰子所在电脑的 **公网** IP。（使用云服务器时，请填写对应云服务商在控制台提供的 IP） - -连接官方 Bot - -::: warning 注意：家庭网络的 IP 变动 - -如果你使用的是家用网络，在本地电脑运行海豹，要注意家庭网络的 IP 通常是不固定的，运营商随时可能会更换你的 IP，遇到问题时请先检查。 - -::: - -### 连接海豹 - -登录海豹并添加账号，选择「QQ(官方机器人)」。填写对应的信息点击连接。你的海豹应该可以正常连接官方机器人运作了！ - -连接官方 Bot - -### 指令配置 - -1. 进入「发布配置」页面； -2. 点击「功能配置」； -3. 点击「指令配置」； -4. 再点击右上角的「重新配置」开始编辑； -5. 点开「指令」页添加指令，「指令名」里面输入对应指令（例如 `r`、`ra`、`en`），`/` 是 QQ 官方机器人默认的指令前缀（海豹也支持使用 `/`）； -6. 然后在「指令介绍」一栏填写指令的简介； -7. 然后在「使用场景」一栏点击「QQ 频道」、「频道私信」、「QQ 群」，切记不能选中「消息列表」； -8. 确认配置完成后，扫码确认修改，就可以完成指令配置。 - -进入指令配置页 - -进行指令配置 - -::: details 推荐指令列表模版 - -推荐指令列表模版1 - -推荐指令列表模版2 - -::: - -### 机器人上线 - -点开「使用范围和人员页面」，进入「编辑」页，参考下面图片中编辑使用范围与人员。 - -连接官方 Bot - -配置完成后，点击「发布配置」页面，上传「自测报告」与「隐私协议」。 - -::: details 「隐私协议」与「自测报告」模板 - -这里提供了海豹骰的机器人「隐私协议」与「自测报告」模版。 - -**强烈建议你按自身情况进行修改，绝对不要原样上传，这涉及到你的机器人是否能被 QQ 官方的工作人员审核通过。** - -[机器人自测报告.xlsx](https://github.com/sealdice/sealdice-manual-next/blob/main/assets/%E6%9C%BA%E5%99%A8%E4%BA%BA%E8%87%AA%E6%B5%8B%E6%8A%A5%E5%91%8A.xlsx?raw=true) - -[第三方机器人隐私保护指引.docx](https://github.com/sealdice/sealdice-manual-next/blob/main/assets/%E7%AC%AC%E4%B8%89%E6%96%B9%E6%9C%BA%E5%99%A8%E4%BA%BA%E9%9A%90%E7%A7%81%E4%BF%9D%E6%8A%A4%E6%8C%87%E5%BC%95.docx?raw=true) - -如果你对「指令列表」的指令进行了修改，或者新增了其他功能，请自行修改，需要在「预期输出」一栏填「指令简介」。 - -::: - -点击「提交审核」后，等待 QQ 官方人员测试并审核（时间不定）。审核通过后，在「发布设置」页面中点击「上线机器人」。 - -::: tip 提示：关于 QQ 审核 - -目前 QQ 审核主要是测试机器人能否在所选支持的场景下，正常回应指令列表里的指令（在没有添加任何其他内容前提下），为人工审核。 - -在提交审核前，请善用沙盒群，测试你提交的自测报告中，所提到的指令是否都能正常工作，机器人需要正常发出回应。 - -如果你的指令包含一些需要填写的参数，请务必在「自测报告」表格「特殊说明」一栏里补充说明。（你可以参考模板中对 `.ra` `.sc` `.en` 指令的特殊说明。） - -如果审核未通过，点击右上角的「通知」查看原因，解决后再次提交。 如果实在无法解决，可加入「QQ 机器人官方频道」，在「寻求｜｜审核和及 bug 」一栏里，发帖询问。 - -::: - -### 使用海豹 - -点击「使用人员与范围」页面，查看你的机器人对应的邀请二维码，扫码添加即可。 - -::: warning 注意 - -目前官方机器人只响应包含 `@` 的消息，操作时请注意。 - -同时，官方机器人一次只能发一条消息，一次性发送消息太多，官方机器人会因为消息发送过于频繁而报错。 - -此外，官方机器人目前无法发送本地图片。 - -::: - -### 注意事项 - -大部分事项 [QQ 机器人文档](https://bot.q.qq.com/wiki) 都有说明，这里补充一些文档中没有说明的其他事项： - -#### 企业账号的开发者资质审核 - -如果你使用企业账号进行了注册，请记得在资料一栏中进行开发者资质状态审核。该审核需要将对应企业的银行卡号上传至腾讯审核，期间的等待时间可能较久。在开发者资质状态通过后，你才能将官方机器人送审。 - -开发者资质状态审核 - -#### 机器人官方频道跳转 - -机器人「资料卡」页面中资料卡设置一栏中，「机器人官方频道跳转」不能是骰子的「沙盒频道」。 - -机器人官方频道跳转 - -#### 功能审核未通过 - -有时候「功能配置」页面中，「功能配置与提审」旁显示审核通过，但实际并没有通过，这时点击「机器人上线」的会显示发送错误。 - -遇见这种情况请点击「通知」，看机器人哪方面没过审，修改后再次提交审核。