From adbec7ee0ca8f8d093397e5411710c58b174d748 Mon Sep 17 00:00:00 2001
From: wangcham <wangcham233@gmail.com>
Date: Tue, 4 Feb 2025 11:14:59 -0500
Subject: [PATCH] add docs for qqofficial

---
 docs/config/function/platform.md             | 10 ++++++-
 docs/deploy/platforms/qq/official.md         |  2 +-
 docs/deploy/platforms/qq/official_webhook.md | 16 +++++++++++
 docs/deploy/quick-config/config.md           | 29 +++++++++++++++++++-
 4 files changed, 54 insertions(+), 3 deletions(-)
 create mode 100644 docs/deploy/platforms/qq/official_webhook.md

diff --git a/docs/config/function/platform.md b/docs/config/function/platform.md
index 9bc001c3a..8269f974b 100644
--- a/docs/config/function/platform.md
+++ b/docs/config/function/platform.md
@@ -35,6 +35,14 @@
             "direct_message"
         ]
     },
+    {
+        "adapter": "qqofficial",
+        "enable": false,
+        "appid": "",
+        "secret": "",
+        "port": 2284,
+        "token": ""
+    },
     {
         "adapter": "wecom",
         "enable": false,
@@ -49,7 +57,7 @@
 ],
 ```
 
-目前支持 `go-cqhttp`、`aiocqhttp`、`qq-botpy`、`wecom`  四种消息平台适配器，也可以同时启用多个同种类或不同种类的平台适配器。  
+目前支持 `go-cqhttp`、`aiocqhttp`、`qq-botpy`、`qqofficial`、 `wecom`  等八种消息平台适配器，也可以同时启用多个同种类或不同种类的平台适配器。  
 各个消息平台的配置方式请查看[部署文档](/deploy/quick-config/config.html#platform-json)。
 
 ### 多开示例
diff --git a/docs/deploy/platforms/qq/official.md b/docs/deploy/platforms/qq/official.md
index 6dce3191a..f37bc9380 100644
--- a/docs/deploy/platforms/qq/official.md
+++ b/docs/deploy/platforms/qq/official.md
@@ -1,4 +1,4 @@
-# 使用 QQ 官方机器人 API
+# 使用 QQ 官方机器人 API（使用websocket方式）
 
 QQ官方机器人所有人均可申请，可以在频道和群聊中使用，私聊也可。
 
diff --git a/docs/deploy/platforms/qq/official_webhook.md b/docs/deploy/platforms/qq/official_webhook.md
new file mode 100644
index 000000000..0eb99153d
--- /dev/null
+++ b/docs/deploy/platforms/qq/official_webhook.md
@@ -0,0 +1,16 @@
+# 使用 QQ 官方机器人 API（使用webhook方式）
+
+QQ官方机器人所有人均可申请，可以在频道和群聊中使用，私聊也可。
+再使用此适配器时，必须使用https请求，并将回调地址设置成 ` https://你的域名（或地址）/callback/command `。
+
+## 注册 QQ 机器人
+
+前往[QQ开放平台](https://q.qq.com/#/)，找到下方的 QQ 机器人文档，按照指引注册 QQ 频道机器人。
+
+## 获取凭证
+
+注册完成后，前往机器人控制台，找到 开发设置，获取 `AppId(机器人ID)` , `AppSecret(机器人密钥)` 和 `Token(机器人令牌)`，将其填入配置信息页的 qqofficial（ webhook 方式）中。
+
+## 发布方式
+
+进入 开发管理 ，按照机器人文档步骤进行机器人发布。
\ No newline at end of file
diff --git a/docs/deploy/quick-config/config.md b/docs/deploy/quick-config/config.md
index 9a5e1ea31..b24d72fc7 100644
--- a/docs/deploy/quick-config/config.md
+++ b/docs/deploy/quick-config/config.md
@@ -40,7 +40,7 @@
 
 `access-token`：设置访问密钥，与 NapCat/Lagrange/LLOneBot 等框架中设置的保持一致
 
-### qq-botpy 适配器
+### qq-botpy 适配器（使用websocket方式）
 
 用于接入 QQ 官方机器人 API。
 
@@ -72,6 +72,33 @@
 - `direct_message` QQ 频道私聊消息
 - `public_messages` Q群 和 列表私聊消息
 
+### qqofficial 适配器（使用webhook方式）
+
+用于接入QQ官方机器人（webhook接入）。
+
+```json
+{
+    "adapter": "qqofficial",
+    "enable": false,
+    "appid": "",
+    "secret": "",
+    "port": 2284,
+    "token": ""
+},
+```
+
+`"adapter": "qqofficial"`，无需改动。
+
+`enable`：是否启用，配置完成后请将其设为`true`
+
+`appid`：申请到的QQ官方机器人的appid
+
+`secret`：申请到的QQ官方机器人的secret
+
+`token`: 申请到的QQ官方机器人的token
+
+`port`: 启动端口，一般不改动。
+
 ### Nakuru 适配器
 
 用于接入 go-cqhttp。