File size: 7,874 Bytes
d9ffd67 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | ---
title: "通知与集成"
description: "World Monitor 通知系统 API 完整参考：涵盖通知渠道注册与管理、webhook 投递重试机制、用户订阅偏好设置，以及 Telegram、Slack、Discord 与 YouTube 等第三方集成端点，让实时警报能够精准推送至团队协作工具、社区频道与个人移动设备。"
---
## 通知渠道
用户可注册多个投递渠道(webhook、Telegram、Slack、Discord、电子邮件),并将告警规则绑定到这些渠道上。
摘要与简报通知使用 [新闻摘要与简报方法论](/zh/methodology/news-digest-and-briefing) 中记录的同一故事池和编辑护栏。
### `GET /api/notification-channels`
列出调用方已注册的渠道和告警规则。
```json
{
"channels": [
{ "id": "chn_01", "type": "webhook", "url": "https://hooks.example.com/...", "active": true },
{ "id": "chn_02", "type": "telegram", "chatId": "@alerts_xyz", "active": true }
],
"alertRules": [
{ "id": "rul_01", "channelId": "chn_01", "trigger": "brief_ready", "filter": null }
]
}
```
### `POST /api/notification-channels`
基于 action 分发的写入端点。请求体中的 `action` 字段决定执行哪一类变更:
| action | 用途 |
|--------|---------|
| `create-pairing-token` | 生成一次性配对令牌(可选 `variant`),供移动端 / Tauri 客户端绑定推送渠道。 |
| `set-channel` | 注册或更新渠道。对于 `webhook` 渠道,`webhookEnvelope` URL 仅接受 HTTPS,不得解析到私有/回环地址,并在存储前使用 AES-256-GCM 加密。可选字段:`email`、`webhookLabel`(截断至 100 字符)。 |
| `set-web-push` | 为已登录用户注册浏览器 Web Push 订阅。 |
| `delete-channel` | 按类型移除渠道(`email`、`webhook`、`telegram`、`web-push` 等)。 |
| `set-alert-rules` | 一次性替换调用方的告警规则集合。 |
| `set-quiet-hours` | 设置"勿扰"时间窗口。 |
| `set-digest-settings` | 配置摘要发送节奏和渠道路由。 |
所有 action 均要求 Clerk bearer + PRO,且此处的 PRO 特指**已计费的权益记录**(`tier >= 1`)。与网关的 tier-1 REST 权限检查不同,仅有 `pro` 角色但没有权益记录的 Clerk 会话**不满足**要求:通知投递在 Convex 内部还会被再次校验(`assertProEntitlement`),因此边缘层直接返回清晰的 `403 pro_required`,而不是让请求在更深层以更无用的错误失败。无效的 action 返回 `400 Unknown action`。请求通过 `RELAY_SHARED_SECRET` 转发至 Convex。
仅当权益被确认为非 Pro 时,没有已计费权益记录的调用方才会收到 `403 pro_required`。当权益校验本身处于不确定状态时,本端点的权限检查改为遵循共享的计费校验契约:对 `entitlement_verification_unavailable` / `renewal_verification_pending` / `renewal_verification_failed` 返回带 `Retry-After` 和 `X-Billing-Verification` 的 `503`;对已确认失效的订阅返回 `403 subscription_lapsed`。参见[错误处理](/zh/usage-errors)。
客户端在向用户暴露失败之前,应至少按 `Retry-After` 重试一次该 `503` —— 仪表盘自身的服务层(`src/services/notification-channels.ts`)会执行且仅执行一次有界重试。对 `entitlement_verification_unavailable` 而言,早于 `Retry-After` 的重试是无意义的:该结果在服务端会被短时负缓存,提前重试只会拿到同一个结果。另外两个 `renewal_verification_*` 代码不会被负缓存,但其延迟对应真实的计费提供方复核或冷却期,因此提前重试同样只会得到相同状态。
- **幂等性**: `POST /api/notification-channels` 支持可选的 `Idempotency-Key`。使用相同 key 和相同请求体重试时,会重放原始响应,而不是再次应用渠道动作。
## Webhook 投递契约
当告警触发时,已注册的 webhook URL 将收到:
- **Method**: `POST`
- **Headers**:
- `Content-Type: application/json`
- `X-WM-Signature: sha256=<HMAC-SHA256(body, channelSecret)>`
- `X-WM-Delivery-Id: <ulid>`
- `X-WM-Event: <event-name>`
- **Body**(信封 v1):
```json
{
"envelope": 1,
"event": "brief_ready",
"deliveryId": "01HX...",
"occurredAt": "2026-04-19T06:00:00Z",
"data": { "issueDate": "2026-04-19", "magazineUrl": "..." }
}
```
签名校验:`hmac_sha256(rawBody, channelSecret) == X-WM-Signature[7:]`。
<Warning>
信封版本在**两个生产者之间共享**(`notification-relay`、`seed-digest-notifications`)。升级版本需协同更新。
</Warning>
### `POST /api/notify`
面向 PRO 调用方的认证事件发布端点。要求 Clerk bearer 认证和有效的 PRO 权益,随后将接受的事件入队到通知队列。中继内部控制事件(如 `flush_quiet_held` 和 `channel_welcome`)为保留事件,会被拒绝。
错误码:401(缺少/无效 JWT)、403 `pro_required`;与本文档中所有 Pro 门控端点一样,当权益校验本身处于不确定状态时遵循共享的计费校验契约:对 `entitlement_verification_unavailable` / `renewal_verification_pending` / `renewal_verification_failed` 返回带 `Retry-After` 和 `X-Billing-Verification` 的 `503`;对已确认失效的订阅返回 `403 subscription_lapsed`。参见[错误处理](/zh/usage-errors)。
- **幂等性**: 支持可选的 `Idempotency-Key`。使用相同 key 和相同请求体重试时,会重放原始入队响应,而不是再次发布通知。
## Telegram
### `GET /api/telegram-feed?userId=...`
返回指定 Telegram 关联用户已预渲染的简报流。供 Telegram mini-app 使用。
## YouTube
### `GET /api/youtube/embed?videoId=...`
带 CSP 兼容封装的 SSR YouTube embed iframe。用于绕过桌面应用中的 WKWebView 自动播放限制。
### `GET /api/youtube/live?channel=<handle>` 或 `?videoId=<11-char-id>`
返回 YouTube 频道(`channel` — 带/不带 `@` 前缀的 handle)或指定视频(`videoId` — 11 字符 YouTube id)的直播元数据。两个参数至少需提供其一;否则返回 `400 Missing channel or videoId parameter`。频道查询响应缓存 10 分钟,videoId 查询缓存 1 小时。
首先通过 Railway 中继代理(用于 YouTube 抓取的住宅代理)。中继失败时,回退到 YouTube oEmbed(用于 `videoId`)或直接频道抓取 — 两者从数据中心 IP 均不可靠。
## Slack 集成
### `POST /api/slack/oauth/start`
需认证(Clerk JWT + PRO)。请求体为空。服务端生成一次性 CSRF state token,以该 state 为键将调用方的 userId 存入 Upstash(10 分钟 TTL),并返回 Slack 授权 URL,供前端在弹窗中打开。
```json
{ "oauthUrl": "https://slack.com/oauth/v2/authorize?client_id=...&scope=incoming-webhook&..." }
```
错误码:401(缺少/无效 JWT)、403 `pro_required`、503(OAuth 未配置或 Upstash 不可用)。此处的 503 **也可能**是可重试的计费校验拒绝 —— `entitlement_verification_unavailable` / `renewal_verification_pending` / `renewal_verification_failed`,并携带 `Retry-After` 和 `X-Billing-Verification`;已确认失效的订阅为 `403 subscription_lapsed`。由于配置错误导致的 503 不可重试,请依据 `code` 字段而非仅凭状态码分支。参见[错误处理](/zh/usage-errors)。
### `GET /api/slack/oauth/callback`
无需认证 — Slack 重定向后弹窗会跳转到此。校验 state token,用 `code` 换取 incoming-webhook URL,使用 AES-256-GCM 加密该 webhook 并存入 Convex。返回一段极简 HTML 页面,通过 `postMessage` 通知 opener 并关闭。
## Discord 集成
### `POST /api/discord/oauth/start`
需认证(Clerk JWT + PRO)。与 Slack 的 start 路由形态一致 — 返回 `{ oauthUrl }` 供弹窗使用,错误码集合也相同,包括上文描述的计费校验 503/403 代码。
### `GET /api/discord/oauth/callback`
无需认证。用 `code` 换取信息,存储 guild webhook,并通过 `postMessage` 通知 opener。
|