95 lines
3.1 KiB
Markdown
95 lines
3.1 KiB
Markdown
# Notify 通知模块
|
|
|
|
## 功能说明
|
|
|
|
该模块提供统一的通知发送功能，支持以下通知方式：
|
|
- Telegram 消息通知
|
|
- Email 邮件通知
|
|
- ntfy 推送通知
|
|
- Bark 推送通知 (iOS)
|
|
|
|
## 使用方法
|
|
|
|
### 发送telegram通知
|
|
|
|
https://core.telegram.org/bots#6-botfather
|
|
|
|
#### 示例展示
|
|
|
|
|
|
|
|
|
|
|
|
### 发送email测试通知(QQ邮箱示例)
|
|
|
|
https://wx.mail.qq.com/list/readtemplate?name=app_intro.html#/agreement/authorizationCode
|
|
|
|
|
|
|
|
#### 示例展示
|
|
|
|
|
|
|
|
|
|
|
|
### 发送ntfy通知
|
|
|
|
ntfy是一个开源的推送通知服务，您可以使用公共服务器 https://ntfy.sh 或者搭建自己的ntfy服务器
|
|
|
|
#### scheme URL配置
|
|
|
|
在直播间配置中，您可以为每个直播间设置一个scheme URL，当开始录制的ntfy通知被触发时，该URL将作为Click头部添加到通知中，用户在手机端点击通知时会跳转到该URL
|
|
|
|
配置方法是在直播间的配置中添加scheme字段：
|
|
|
|
```yaml
|
|
live_rooms:
|
|
- url: "https://live.bilibili.com/123456"
|
|
is_listening: true
|
|
scheme: "bilibili://live/123456" # 这里设置scheme URL
|
|
```
|
|
|
|
## 配置说明
|
|
|
|
在配置文件中启用相应的通知服务：
|
|
|
|
```yaml
|
|
# 通知服务配置
|
|
notify:
|
|
send_recording_summary: true # 是否在录制结束后推送录制文件摘要
|
|
telegram:
|
|
enable: true # 是否启用Telegram通知
|
|
withNotification: true # 是否在Telegram通知中包含通知内容（是否有声音通知）
|
|
botToken: "YOUR_BOT_TOKEN" # Telegram机器人的Token
|
|
chatID: "YOUR_CHAT_ID" # 接收通知的Chat ID
|
|
|
|
email:
|
|
enable: true # 是否启用邮件通知
|
|
smtpHost: "smtp.example.com" # SMTP服务器地址
|
|
smtpPort: 465 # SMTP服务器端口
|
|
senderEmail: "sender@example.com" # 发送者邮箱
|
|
senderPassword: "password" # 发送者邮箱密码或授权码
|
|
recipientEmail: "recipient@example.com" # 接收者邮箱
|
|
|
|
ntfy:
|
|
enable: true # 是否启用ntfy通知
|
|
URL: "https://ntfy.sh/your-topic" # ntfy服务器地址和主题
|
|
token: "your-token" # 如果需要认证，填写访问令牌
|
|
tag: "new" # 消息标签
|
|
|
|
bark:
|
|
enable: true # 是否开启Bark通知(iOS)
|
|
serverURL: "https://api.day.app" # Bark服务器地址，默认 https://api.day.app，支持自建
|
|
deviceKey: "your-device-key" # 设备推送密钥（在Bark App首页获取）
|
|
sound: "alarm" # 推送铃声（可选，如 alarm、birdsong、glass 等）
|
|
group: "bililive-go" # 通知分组名称（可选）
|
|
icon: "" # 自定义图标URL（可选）
|
|
level: "timeSensitive" # 通知级别（可选）: active/timeSensitive/passive/critical
|
|
```
|
|
|
|
## 注意事项
|
|
|
|
1. 请确保在使用通知功能前已正确配置相关参数
|
|
2. 函数会自动检测启用的通知方式并发送，如果某种通知方式发送失败，不会影响其他通知方式的发送
|
|
3. 邮件通知使用SMTP协议发送，请确保SMTP服务器配置正确
|