Push channels

WeChat — 微信 (XiZhi)

Sends WeChat push notifications via the XiZhi single-push webhook service (息知).Function signature (msg_push.py):

xizhi(url: str, title: str, content: str) -> Dict[str, Any]

The function POSTs {"title": ..., "content": ...} as JSON to each URL in url and checks that the response code equals 200.Required config fields:

Field	Description
`微信推送接口链接`	One or more XiZhi webhook URLs, comma-separated

How to get your webhook URL:

Register at xizhi.qqoq.net and log in.
Go to Admin → Single push (单点推送).
Copy the URL in the form https://xizhi.qqoq.net/xxxxxxxxx.send.

Example config:

直播状态推送渠道 = 微信
微信推送接口链接 = https://xizhi.qqoq.net/xxxxxxxxx.send

To push to multiple WeChat accounts, separate webhook URLs with commas.

微信推送接口链接 = https://xizhi.qqoq.net/aaa.send,https://xizhi.qqoq.net/bbb.send

DingTalk — 钉钉

Sends messages to a DingTalk group via a custom robot webhook.Function signature (msg_push.py):

dingtalk(url: str, content: str, number: str = None, is_atall: bool = False) -> Dict[str, Any]

The function POSTs a text message type to each webhook URL. When number is provided, the specified phone number is @mentioned. When is_atall is True, all group members are @mentioned.Required config fields:

Field	Description
`钉钉推送接口链接`	One or more DingTalk robot webhook URLs, comma-separated
`钉钉通知@对象(填手机号)`	Mobile number to @mention (optional)
`钉钉通知@全体(是/否)`	Set to `是` to @mention all members (optional, default `否`)

How to get your webhook URL:

Open a DingTalk group and go to Group Settings → Bots → Add Bot.
Choose Custom and follow the setup wizard.
Copy the generated webhook URL (format: https://oapi.dingtalk.com/robot/send?access_token=...).
Refer to the DingTalk custom robot documentation for security settings.

Example config:

直播状态推送渠道 = 钉钉
钉钉推送接口链接 = https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxxxxx
钉钉通知@对象(填手机号) = 13800000000
钉钉通知@全体(是/否) = 否

Email — 邮箱

Sends notifications via SMTP email, with optional SSL/TLS encryption.Function signature (msg_push.py):

send_email(
    email_host: str,
    login_email: str,
    email_pass: str,
    sender_email: str,
    sender_name: str,
    to_email: str,
    title: str,
    content: str,
    smtp_port: str = None,
    open_ssl: bool = True
) -> Dict[str, Any]

When open_ssl is True, the function uses smtplib.SMTP_SSL (default port 465). When False, it uses plain smtplib.SMTP (default port 25).Required config fields:

Field	Description
`smtp邮件服务器`	SMTP server hostname (e.g. `smtp.qq.com`)
`是否使用SMTP服务SSL加密(是/否)`	`是` for SSL (port 465), `否` for plain SMTP (port 25)
`SMTP邮件服务器端口`	Override the default port (optional)
`邮箱登录账号`	Email address used to authenticate with the SMTP server
`发件人密码(授权码)`	SMTP password or app authorization code
`发件人邮箱`	From address in the sent email
`发件人显示昵称`	Display name shown as the sender
`收件人邮箱`	One or more recipient addresses, comma-separated

Example config (QQ Mail with SSL):

直播状态推送渠道 = 邮箱
smtp邮件服务器 = smtp.qq.com
是否使用SMTP服务SSL加密(是/否) = 是
SMTP邮件服务器端口 = 465
邮箱登录账号 = [email protected]
发件人密码(授权码) = your_authorization_code
发件人邮箱 = [email protected]
发件人显示昵称 = 直播助手
收件人邮箱 = [email protected]

Most providers (QQ, 163, Gmail) require an authorization code rather than your account password. Enable SMTP access and generate an authorization code in your email provider’s account settings.

To send to multiple recipients, separate addresses with commas.

收件人邮箱 = [email protected],[email protected]

Telegram — TG

Sends messages via a Telegram Bot using the Bot API.Function signature (msg_push.py):

tg_bot(chat_id: int, token: str, content: str) -> Dict[str, Any]

The function calls https://api.telegram.org/bot{token}/sendMessage with chat_id and text as the JSON body.

Telegram is inaccessible from mainland China without a proxy. Make sure your proxy settings in [录制设置] are configured if you are running the tool in a region where Telegram is blocked.

Required config fields:

Field	Description
`tgapi令牌`	Bot token obtained from BotFather
`tg聊天id(个人或者群组id)`	Your personal chat ID or a group chat ID

How to get your credentials:

Bot token: Search for @BotFather in Telegram, send /newbot, follow the prompts, and copy the token provided.
Chat ID: Search for @userinfobot in Telegram and send /start. It will reply with your numeric chat ID. For a group, add the bot to the group and use the group’s negative numeric ID.

Example config:

直播状态推送渠道 = TG
tgapi令牌 = 123456789:ABCDefgh-XXXXXXXXXXXXXXXXXXXXXXXX
tg聊天id(个人或者群组id) = 987654321

BARK

Sends push notifications to an iPhone via the Bark app.Function signature (msg_push.py):

bark(
    api: str,
    title: str = "message",
    content: str = "test",
    level: str = "active",
    badge: int = 1,
    auto_copy: int = 1,
    sound: str = "",
    icon: str = "",
    group: str = "",
    is_archive: int = 1,
    url: str = ""
) -> Dict[str, Any]

The function POSTs a JSON payload to each URL in api and checks that the response code equals 200.Required config fields:

Field	Description
`bark推送接口链接`	One or more Bark push URLs including your device key, comma-separated
`bark推送中断级别`	Notification interruption level: `active`, `timeSensitive`, or `passive` (default: `active`)
`bark推送铃声`	Notification sound name (optional, leave empty for the default sound)

Interruption levels:

Level	Behavior
`active`	Standard notification (default)
`timeSensitive`	Time-sensitive notification, can break through Focus mode
`passive`	Delivered silently to the notification center only

How to get your Bark URL:

Install the Bark app on your iPhone.
Open the app — your push URL is displayed on the home screen (e.g. https://api.day.app/your_device_key/).
You can also self-host the Bark server; replace the domain with your own.

Example config:

直播状态推送渠道 = BARK
bark推送接口链接 = https://api.day.app/your_device_key/
bark推送中断级别 = active
bark推送铃声 = 

NTFY

Sends push notifications via ntfy, an open-source pub/sub push notification service that can be self-hosted.Function signature (msg_push.py):

ntfy(
    api: str,
    title: str = "message",
    content: str = "test",
    tags: str = "tada",
    priority: int = 3,
    action_url: str = "",
    attach: str = "",
    filename: str = "",
    click: str = "",
    icon: str = "",
    delay: str = "",
    email: str = "",
    call: str = ""
) -> Dict[str, Any]

The function splits each API URL into a server base and a topic name (the last path segment), then POSTs a JSON payload to the server. When action_url is set, a View live action button is included pointing to the stream URL.Required config fields:

Field	Description
`ntfy推送地址`	Full ntfy topic URL, e.g. `https://ntfy.sh/your_topic`
`ntfy推送标签`	Comma-separated emoji tags shown on the notification (default: `tada`)
`ntfy推送邮箱`	Email address for ntfy to forward notifications to (optional)

How to set up ntfy:

Hosted: Use https://ntfy.sh/your_unique_topic. Choose a hard-to-guess topic name since anyone who knows the topic URL can subscribe.
Self-hosted: Deploy the ntfy server and use your own domain: https://ntfy.example.com/your_topic.
Subscribe to the topic in the ntfy app (Android / iOS / web) to receive notifications.

Example config:

直播状态推送渠道 = NTFY
ntfy推送地址 = https://ntfy.sh/my-stream-alerts-abc123
ntfy推送标签 = tada,loudspeaker
ntfy推送邮箱 = 

When a live notification is sent, the tool automatically adds a View live action button to the notification that links directly to the stream URL.

PushPlus

Sends push notifications via PushPlus, a Chinese push service that delivers messages to WeChat and other channels.Function signature (msg_push.py):

pushplus(token: str, title: str, content: str) -> Dict[str, Any]

The function POSTs {"token": ..., "title": ..., "content": ...} to https://www.pushplus.plus/send for each token and checks that the response code equals 200.Required config fields:

Field	Description
`pushplus推送token`	One or more PushPlus tokens, comma-separated

How to get your PushPlus token:

Visit pushplus.plus and log in with WeChat.
Your token is displayed on the dashboard home page.
Copy the token string.

Example config:

直播状态推送渠道 = PUSHPLUS
pushplus推送token = your_pushplus_token_here

PushPlus delivers messages to your WeChat account by default. The free tier has a daily send limit. See the PushPlus API documentation for rate limits and additional channel options.

Get Started

Configuration

Notifications

Deployment

Guides

Build docs developers (and LLMs) love