From 454d45fcc2b3926f292bc1ed366ace0554cad416 Mon Sep 17 00:00:00 2001 From: liuwei Date: Tue, 21 Apr 2026 16:39:21 +0800 Subject: [PATCH] =?UTF-8?q?refactor(trendradar):=20=E5=90=88=E5=B9=B6?= =?UTF-8?q?=E8=AF=B4=E6=98=8E=E6=96=87=E6=A1=A3=E5=88=B0=E6=9D=83=E9=99=90?= =?UTF-8?q?=E6=8F=92=E4=BB=B6=E7=9B=AE=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 将 webhook 对接与群权限说明迁移到 plugins/trendradar_permission/README.md - 删除已无实际职责的 plugins/trendradar_webhook 文档目录内容 - 保持目录职责一致:权限插件目录承载配置与使用说明 --- .../README.md | 41 +++++++++++-------- 1 file changed, 24 insertions(+), 17 deletions(-) rename plugins/{trendradar_webhook => trendradar_permission}/README.md (56%) diff --git a/plugins/trendradar_webhook/README.md b/plugins/trendradar_permission/README.md similarity index 56% rename from plugins/trendradar_webhook/README.md rename to plugins/trendradar_permission/README.md index 2526621..1a4ee05 100644 --- a/plugins/trendradar_webhook/README.md +++ b/plugins/trendradar_permission/README.md @@ -1,8 +1,18 @@ -# TrendRadar Webhook 适配说明 +# TrendRadar Webhook + 权限插件说明 -## 1. 接口地址 +## 1. 组成说明 -在 ABOT 侧新增了 webhook 入口: +当前实现分两部分: + +1. 权限插件(本目录) +- 负责注册群级功能开关:`TRENDRADAR_WEBHOOK` +- 你可以在后台按群启用/关闭 + +2. webhook 接口(Dashboard 蓝图) +- 路径:`POST /webhook/trendradar` +- 文件:`admin/dashboard/blueprints/trendradar_webhook.py` + +## 2. 接口地址 `POST /webhook/trendradar` @@ -10,9 +20,9 @@ `http://<你的ABOT地址>:8888/webhook/trendradar` -## 2. ABOT 配置 +## 3. ABOT 配置 -编辑 [admin/dashboard/config.toml](/D:/learn/abot/admin/dashboard/config.toml): +编辑 [config.toml](/D:/learn/abot/admin/dashboard/config.toml): ```toml [trendradar_webhook] @@ -23,21 +33,17 @@ allow_payload_target_groups = false send_timeout_seconds = 20 ``` -## 2.1 群权限开关(必做) - -已新增空插件用于权限管理: - -- [main.py](/D:/learn/abot/plugins/trendradar_permission/main.py) +## 4. 群权限开关(必做) 请在后台给目标群开启: `📡 TrendRadar Webhook推送 [群级开关]` 说明: -1. webhook 在发送前会强制校验该群是否开启权限; -2. 未开启的群会被拦截,并在接口返回里出现在 `blocked_groups`。 +1. webhook 发送前会强制校验该群权限; +2. 未开启的群会被拦截,并在返回中出现在 `blocked_groups`。 -## 3. TrendRadar 配置(Generic Webhook) +## 5. TrendRadar 配置(Generic Webhook) 在 TrendRadar 里设置: @@ -47,7 +53,7 @@ send_timeout_seconds = 20 4. `GENERIC_WEBHOOK_HEADERS={"Content-Type":"application/json"}` 5. `GENERIC_WEBHOOK_TEMPLATE={"token":"your_secure_token","title":"{title}","content":"{content}","source":"TrendRadar"}` -## 4. 可选:让 TrendRadar 指定目标群 +## 6. 可选:让 TrendRadar 指定目标群 若你希望不同热点推送到不同群: @@ -59,15 +65,16 @@ send_timeout_seconds = 20 "token": "your_secure_token", "title": "{title}", "content": "{content}", - "target_group_ids": ["xxxx@chatroom","yyyy@chatroom"] + "target_group_ids": ["xxxx@chatroom", "yyyy@chatroom"] } ``` -## 5. 返回结果 +## 7. 返回结果 接口返回 JSON,包含: 1. `success` 2. `sent_groups` 3. `blocked_groups` -3. `failed_groups` +4. `failed_groups` +