Files
bililive-go/docs/notify.md
T
jonpostel/ d3903930d2 feat(notify): 新增Telegram和email 录制通知功能 (#935)
* feat(notify): 新增Telegram和邮件通知功能

新增Telegram和邮件通知服务,用户可在直播开始、结束和异常时接收通知。添加相关配置项和文档说明,并更新依赖。

新增通知模块,支持Telegram和邮件两种通知方式。用户可在配置文件中启用相应服务并设置参数。添加了测试用例和示例图片。

更新了README和文档,详细说明通知功能的配置和使用方法。同时添加了相关依赖包。

* 修复 Copilot,golangci-lint 的问题

* 完善 Copilot 建议

* fix: 修复listener_test.go中GetRawUrl和DispatchEvent方法调用未预期的问题

* 添加 GetRawUrl,GetPlatformCNName 测试预期调用。让测试完善通过。

* Delete coverage.txt

* end fix and end test,简化通知代码.

* 发现一个bug,有一定几率拿不到主播名称。如果拿不到就从缓存中拿。
2025-09-27 12:28:40 +09:00

1.6 KiB

Notify 通知模块

功能说明

该模块提供统一的通知发送功能,支持以下通知方式:

  • Telegram 消息通知
  • Email 邮件通知

使用方法

发送telegram通知

https://core.telegram.org/bots#6-botfather

示例展示

wechat_2025-09-22_055408_506

发送email测试通知(QQ邮箱示例)

https://wx.mail.qq.com/list/readtemplate?name=app_intro.html#/agreement/authorizationCode

示例展示

wechat_2025-09-22_055510_164

配置说明

在配置文件中启用相应的通知服务:

# 通知服务配置
notify:
  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"  # 接收者邮箱

注意事项

  1. 请确保在使用通知功能前已正确配置相关参数
  2. 函数会自动检测启用的通知方式并发送,如果某种通知方式发送失败,不会影响其他通知方式的发送
  3. 邮件通知使用SMTP协议发送,请确保SMTP服务器配置正确