增加模块支持描述
This commit is contained in:
meoacgx committed
1 parent
09feeed2db
commit
d9580070ac
1 file changed
+11
-61
@@ -12,35 +12,12 @@
|
||||
- 📥 **多账号批量导入/登录**：支持 Session/压缩包导入；支持手机号验证码登录与 2FA 密码
|
||||
- 🔁 **账号维度一键切换操作**：选择不同账号创建频道/群组、查看与管理账号创建的数据
|
||||
- 👥 **批量运营能力**：批量邀请成员/机器人、批量设置管理员、导出链接等高频操作
|
||||
- 🧩 **用户任务：批量订阅/加群**：任务中心新建「用户任务 → 批量订阅/加群」，支持按账号分类筛选；账号列表支持单账号“进群/订阅”入口（多链接换行分隔）
|
||||
- 🧩 **模块化扩展能力**：任务 / API / UI 可安装扩展（内置含：批量订阅/加群、踢人/封禁等示例模块）
|
||||
- 🔐 **二级密码（2FA）与找回邮箱**：支持单个/批量修改二级密码；支持绑定/换绑 2FA 找回邮箱（验证码确认）
|
||||
- 🧯 **忘记二级密码可申请重置**：支持单个或批量向 Telegram 提交“忘记密码重置”申请（通常等待 7 天后可重新设置）
|
||||
- 🪪 **账号资料管理**：支持单账号编辑昵称/Bio/用户名/头像；支持批量修改昵称（自动追加手机号后 4 位便于区分）与批量修改 Bio
|
||||
- 🤖 **Bot 频道管理**：用于管理“频道创建人不在系统中”的频道（把 Bot 设为管理员即可纳入管理），支持批量导出链接、批量设置管理员（踢人能力可扩展）
|
||||
|
||||
## 批量订阅/加群（用户任务）
|
||||
|
||||
说明：这是**用户账号**任务（Bot 无法主动加群/订阅）。
|
||||
|
||||
### 入口 1：任务中心批量执行
|
||||
|
||||
1. 进入「任务中心」→ 点击「新建任务」
|
||||
2. 选择：任务分类 =「用户任务」，任务类型 =「批量订阅/加群」
|
||||
3. 选择执行账号（支持按**账号分类**筛选 + 搜索）
|
||||
4. 粘贴链接/用户名（**换行分隔**），设置间隔（建议 1500–4000ms）
|
||||
5. 提交后到「任务中心」查看进度与结果
|
||||
|
||||
### 入口 2：账号列表单账号执行
|
||||
|
||||
在「账号列表」每行账号的操作区点击「进群/订阅」，输入多个链接/用户名（换行分隔）后确认即可提交后台任务。
|
||||
|
||||
### 支持的链接/格式
|
||||
|
||||
- `https://t.me/xxx`
|
||||
- `t.me/+hash`
|
||||
- `@username` / `username`
|
||||
- `tg://join?invite=hash`
|
||||
|
||||
|
||||
## 🧊 防冻结指南（新号必看）
|
||||
|
||||
@@ -206,49 +183,22 @@ location / {
|
||||
dotnet run --project src/TelegramPanel.Web
|
||||
```
|
||||
|
||||
## 外部 API（可选）
|
||||
## 🧩 模块扩展（可选）
|
||||
|
||||
项目提供少量外部可调用接口，用于与其他系统联动。出于安全考虑，接口默认关闭，且使用请求头 `X-API-Key` 鉴权。
|
||||
项目已支持“可安装/可卸载”的模块扩展（任务 / API / UI），用于后续按需扩展能力、按场景自由定制开发自己的模块，而不是把功能写死在核心里。
|
||||
|
||||
在面板左侧菜单「API 管理」中可以：
|
||||
面板入口：
|
||||
|
||||
- 新建 API，并为该 API 配置项命名
|
||||
- 选择 API 类型（后续可扩展更多类型）
|
||||
- 为每个配置项生成独立的 `X-API-Key`（同一接口可创建多个配置项，通过 Key 区分）
|
||||
- 「模块管理」：安装/启用/停用/卸载模块（通常需重启生效）
|
||||
- 「API 管理」：基于已启用的模块，创建对应的外部 API 配置项（`X-API-Key` 鉴权）
|
||||
- 「任务中心」：基于已启用的模块，动态展示任务类型与分类
|
||||
|
||||
### 全局踢人/封禁：`POST /api/kick`
|
||||
内置扩展只是示例（可按需启用/停用，也可自行开发/上传模块）：
|
||||
|
||||
用途：从配置的 Bot 管理的频道/群组中踢出或封禁指定用户（按 Telegram 用户 ID）。服务端会根据请求头 `X-API-Key` 匹配对应的 API 配置项并执行。
|
||||
- **外部 API：踢人/封禁**：`POST /api/kick`（配置入口：面板左侧菜单「API 管理」）
|
||||
- **用户任务：批量订阅/加群**：任务中心新建「用户任务 → 批量订阅/加群」
|
||||
|
||||
请求头：
|
||||
|
||||
- `Content-Type: application/json`
|
||||
- `X-API-Key: <KICK_API_KEY>`
|
||||
|
||||
请求体：
|
||||
|
||||
```json
|
||||
{ "user_id": 123456789 }
|
||||
```
|
||||
|
||||
可选参数：
|
||||
|
||||
```json
|
||||
{ "user_id": 123456789, "permanent_ban": true }
|
||||
```
|
||||
|
||||
调用示例：
|
||||
|
||||
```bash
|
||||
curl -X POST "http://localhost:5000/api/kick" \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "X-API-Key: <KICK_API_KEY>" \
|
||||
-d '{"user_id": 123456789}'
|
||||
```
|
||||
|
||||
把 `http://localhost:5000` 替换为你实际访问面板的地址即可。
|
||||
|
||||
配置入口：面板左侧菜单「API 管理」。
|
||||
更多说明见：`docs/modules.md`（模块目录结构、manifest、任务/API/UI 扩展点）。
|
||||
|
||||
## 详细文档
|
||||
|
||||
|
||||
Reference in new issue
Block a user