feat: udpate docs
This commit is contained in:
engigu
@@ -176,6 +176,144 @@ Message Nest 支持多种消息推送渠道，您可以根据需求配置不同
|
||||
- 建议使用 Markdown 格式，展示效果更好
|
||||
:::
|
||||
|
||||
## 飞书机器人
|
||||
|
||||
通过飞书群机器人发送消息到飞书群。
|
||||
|
||||
### 配置步骤
|
||||
|
||||
1. **创建飞书群**
|
||||
- 在飞书中创建群聊
|
||||
|
||||
2. **添加自定义机器人**
|
||||
- 进入群设置 → 群机器人 → 添加机器人 → 自定义机器人
|
||||
- 设置机器人名称和描述
|
||||
|
||||
3. **配置安全设置**
|
||||
- 选择"签名校验"方式
|
||||
- 记录 Webhook 地址和签名密钥
|
||||
|
||||
4. **在 Message Nest 中配置**
|
||||
- 渠道名称：自定义名称
|
||||
- Webhook URL：复制的 Webhook 地址
|
||||
- 签名密钥：复制的签名密钥
|
||||
|
||||
### 配置参数
|
||||
|
||||
| 参数 | 说明 | 必填 |
|
||||
|------|------|------|
|
||||
| 渠道名称 | 自定义渠道名称 | 是 |
|
||||
| Webhook URL | 机器人 Webhook 地址 | 是 |
|
||||
| 签名密钥 | 签名校验密钥 | 否 |
|
||||
|
||||
### 消息格式
|
||||
|
||||
飞书支持以下格式：
|
||||
- **Text** - 纯文本
|
||||
- **Markdown** - 支持 Markdown 格式（推荐）
|
||||
|
||||
### 使用场景
|
||||
|
||||
- ✅ 团队协作通知
|
||||
- ✅ 项目进度更新
|
||||
- ✅ 系统监控告警
|
||||
- ✅ 工作流提醒
|
||||
- ✅ 日报周报推送
|
||||
|
||||
### 注意事项
|
||||
|
||||
::: warning 注意
|
||||
- 每个机器人每分钟最多发送 20 条消息
|
||||
- 建议使用签名校验提高安全性
|
||||
- 机器人被移除后 Webhook 将失效
|
||||
- Markdown 格式展示效果更好
|
||||
:::
|
||||
|
||||
## Telegram 机器人
|
||||
|
||||
通过 Telegram Bot 发送消息到 Telegram 聊天。
|
||||
|
||||
### 配置步骤
|
||||
|
||||
1. **创建 Telegram Bot**
|
||||
- 在 Telegram 中搜索 `@BotFather`
|
||||
- 发送 `/newbot` 命令创建新机器人
|
||||
- 按提示设置机器人名称和用户名
|
||||
- 记录 Bot Token（格式：`123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`）
|
||||
|
||||
2. **获取 Chat ID**
|
||||
- **个人聊天**：向机器人发送任意消息，然后访问 `https://api.telegram.org/bot<YourBOTToken>/getUpdates` 查看 `chat.id`
|
||||
- **群组聊天**：将机器人添加到群组，发送消息后同样方式获取 `chat.id`（群组 ID 通常为负数）
|
||||
- **频道**：将机器人添加为频道管理员，使用频道用户名（如 `@channel_name`）或频道 ID
|
||||
|
||||
3. **在 Message Nest 中配置**
|
||||
- Bot Token：填入创建机器人时获得的 Token
|
||||
- Chat ID：填入接收消息的聊天 ID
|
||||
- 自定义 API 地址（可选）：如使用自建代理服务器
|
||||
- 代理地址（可选）：如需通过代理访问 Telegram API
|
||||
|
||||
### 配置参数
|
||||
|
||||
| 参数 | 说明 | 必填 | 示例 |
|
||||
|------|------|------|------|
|
||||
| 渠道名称 | 自定义渠道名称 | 是 | `Telegram通知` |
|
||||
| Bot Token | 机器人 Token | 是 | `123456:ABC-DEF...` |
|
||||
| Chat ID | 接收消息的聊天 ID | 是 | `123456789` 或 `-100123456789` |
|
||||
| 自定义 API 地址 | 自建代理服务器地址 | 否 | `https://api.example.com` |
|
||||
| 代理地址 | HTTP/SOCKS5 代理 | 否 | `socks5://127.0.0.1:1080` |
|
||||
|
||||
### 代理配置说明
|
||||
|
||||
Telegram 在某些地区可能无法直接访问，支持以下代理方式：
|
||||
|
||||
**1. 自定义 API 地址（优先级最高）**
|
||||
- 适用于自建 Telegram API 代理服务器
|
||||
- 示例：`https://api.example.com`
|
||||
- 如果配置了此项，代理地址将被忽略
|
||||
|
||||
**2. 代理地址（优先级较低）**
|
||||
- 支持 HTTP/HTTPS/SOCKS5 代理
|
||||
- HTTP 代理：`http://127.0.0.1:7890`
|
||||
- HTTPS 代理：`https://proxy.example.com:8080`
|
||||
- SOCKS5 代理：`socks5://127.0.0.1:1080`
|
||||
- 带认证的 SOCKS5：`socks5://username:password@host:1080`
|
||||
|
||||
### 消息格式
|
||||
|
||||
Telegram 支持以下格式：
|
||||
- **Text** - 纯文本
|
||||
- **Markdown** - Markdown 格式（支持 Telegram Markdown 语法）
|
||||
- **HTML** - HTML 格式（支持部分 HTML 标签）
|
||||
|
||||
### 使用场景
|
||||
|
||||
- ✅ 个人消息通知
|
||||
- ✅ 系统监控告警
|
||||
- ✅ 自动化脚本通知
|
||||
- ✅ 跨国团队协作
|
||||
- ✅ 服务器状态推送
|
||||
- ✅ 定时任务提醒
|
||||
|
||||
### 注意事项
|
||||
|
||||
::: warning 注意
|
||||
- Bot Token 需要妥善保管，泄露后需要重新生成
|
||||
- 群组 Chat ID 通常为负数（如 `-100123456789`）
|
||||
- 机器人需要有发送消息的权限
|
||||
- 在群组中使用时，需要将机器人添加为成员
|
||||
- 在频道中使用时，需要将机器人设为管理员
|
||||
- 代理配置优先级：自定义 API 地址 > 代理地址
|
||||
- 如果在国内使用，建议配置代理或自定义 API 地址
|
||||
:::
|
||||
|
||||
::: tip 提示
|
||||
**获取 Chat ID 的简便方法：**
|
||||
1. 将机器人添加到聊天中
|
||||
2. 向机器人发送任意消息
|
||||
3. 在浏览器访问：`https://api.telegram.org/bot<YourBOTToken>/getUpdates`
|
||||
4. 在返回的 JSON 中找到 `"chat":{"id":123456789}` 即为 Chat ID
|
||||
:::
|
||||
|
||||
## 微信测试公众号
|
||||
|
||||
通过微信测试公众号发送模板消息。
|
||||
|
||||
Reference in New Issue
Block a user