最終更新
アラート
LIVE イベントで発動するアラートルール(Webhook、メール、アプリ内、Telegram)。
すべての操作は API キーで認証します (Authorization: Bearer <key>) 。エラーには共通のエンベロープを使用します。詳しくは次のページを参照してください: エラー. このページは API の OpenAPI ドキュメントから生成しています。
アラートの配信を一覧表示
/v1/alerts/deliveriesルール・チャネル・イベントごとに 1 行: delivered、failed(detail と試行回数 attempts 付き)、または capped(月間 webhook 上限などプランの上限で破棄)。新しい順。
クエリパラメーター
| Name | Type | Description |
|---|---|---|
ruleIdOptional | string | このルールのみ(UUID)。 |
statusOptional | "delivered" | "failed" | "capped" | この結果のみ。 |
sinceOptional | string | ISO 8601 の時刻。これより新しい行のみ。 |
limitOptional | integer | 返す行数。 範囲 1–200. Default: 50 |
リクエスト
curl "https://api.next.toktokdata.live/v1/alerts/deliveries" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
{ "items": [ { "id": "5a7e0b0c-2d55-5f11-8b0e-0d0a3c5e6f70", "source": "alert", "ruleId": "7d01133d-6ecb-5101-a9c0-e23e4755bad9", "ruleName": "Envelopes from Linh", "channelType": "webhook", "eventType": "envelope", "status": "failed", "attempts": 4, "detail": "retry exhausted: webhook HTTP 503", "isTest": false, "createdAt": "2026-11-06T09:58:13.410Z" }, { "id": "a3d9c6e1-4b2f-5c8e-9a71-2e5b8d0f4c13", "source": "alert", "ruleId": "7d01133d-6ecb-5101-a9c0-e23e4755bad9", "ruleName": "Envelopes from Linh", "channelType": "in_app", "eventType": "envelope", "status": "delivered", "attempts": 1, "detail": null, "isTest": false, "createdAt": "2026-11-06T09:58:12.512Z" } ], "observedAt": "2026-11-06T09:58:13.410Z", "provenance": { "observedAt": "2026-11-06T10:00:00.000Z", "freshness": "near_realtime", "source": "workspace_alert_history", "sourceKind": "derived", "coverageStatus": "observed", "methodologyVersion": "alert-history-v1", "window": null }}エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
アラートの発火を一覧表示
/v1/alerts/firesルールがイベントに一致したすべての記録(新しい順)。チャネルが配信したかどうかは問いません(配信と比較してください)。
クエリパラメーター
| Name | Type | Description |
|---|---|---|
ruleIdOptional | string | このルールのみ(UUID)。 |
sinceOptional | string | ISO 8601 の時刻。これより新しい行のみ。 |
limitOptional | integer | 返す行数。 範囲 1–200. Default: 50 |
リクエスト
curl "https://api.next.toktokdata.live/v1/alerts/fires" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
{ "items": [ { "id": "1c3b5e86-0f43-5a3e-9d3c-5f6a1f0e7b21", "ruleId": "7d01133d-6ecb-5101-a9c0-e23e4755bad9", "ruleName": "Envelopes from Linh", "eventType": "envelope", "roomId": "7568123456789012345", "creatorUniqueId": "linh.live", "channelCount": 2, "isTest": false, "firedAt": "2026-11-06T09:58:12.104Z" } ], "observedAt": "2026-11-06T09:58:12.104Z", "provenance": { "observedAt": "2026-11-06T10:00:00.000Z", "freshness": "near_realtime", "source": "workspace_alert_history", "sourceKind": "derived", "coverageStatus": "observed", "methodologyVersion": "alert-history-v1", "window": null }}エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
アラートルールを一覧表示
/v1/alerts/rulesワークスペースのすべてのルールを、そのチャネルとともに返します。署名シークレットが再び返されることはありません。
リクエスト
curl "https://api.next.toktokdata.live/v1/alerts/rules" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
{ "rules": [ { "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9", "name": "Envelopes from Linh", "creatorUniqueId": "linh.live", "scope": "creator", "gifterKey": null, "region": null, "eventTypes": [ "envelope" ], "minScore": null, "minRate": null, "minDiamondCount": 100, "minFollowerMilestone": null, "goodyBagAllowAllViewers": null, "goodyBagMaxRequiredLevel": null, "enabled": true, "createdAt": "2026-11-01T10:51:45.582Z", "updatedAt": "2026-11-01T10:51:45.582Z", "channels": [ { "id": "3d0d4dc5-6993-55ab-a1cd-ffbe7db95507", "channelType": "in_app", "target": null, "enabled": true, "hasSigningSecret": false } ] } ], "provenance": { "observedAt": "2026-11-01T10:00:00.000Z", "freshness": "near_realtime", "source": "workspace_alert_rules", "sourceKind": "derived", "coverageStatus": "observed", "methodologyVersion": "alert-rules-v1", "window": null }}エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
アラートルールを作成
/v1/alerts/rulesルールは 1 人のクリエイター(または地域全体)のイベントを種類ごとに監視し、そのチャネルに配信します。Webhook チャネルの署名シークレットは webhookSecrets で一度だけ返されます。
リクエストボディ
| Name | Type | Description |
|---|---|---|
nameRequired | string | 通知に表示されます。 |
creatorUniqueIdOptional | string | null | 監視するクリエイター。省略すると地域全体が対象になります。 |
scopeOptional | "creator" | "any" | "watchlist" | "gifter_watchlist" | ルールの監視対象: 指定したクリエイター、すべてのルーム(任意で 1 地域)、ワークスペースのウォッチリストのクリエイター、またはギフターのウォッチリスト(ワークスペースごとに 1 ルール)。creatorUniqueId があれば既定は creator、なければ any。 |
regionOptional | string | null | |
eventTypesOptional | ("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[] | LIVE イベント(gift、envelope、goodyBag、live_start、live_end)と、ルールのクリエイターまたはウォッチリストに対して毎時実行されるホストチェック: host_quiet(3 日間 LIVE なし)、league_change、diamond_target(ランキングの 1 日が minDiamondCount に到達)、follower_milestone(minFollowerMilestone の倍数を超えた)。 |
minDiamondCountOptional | integer | null | これより少ないダイヤモンドのイベントは無視します。 |
minFollowerMilestoneOptional | integer | null | follower_milestone のフォロワー刻み(例: 10000)。 |
enabledOptional | boolean | Default: true |
channelsOptional | object[] |
リクエスト
curl -X POST "https://api.next.toktokdata.live/v1/alerts/rules" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"Envelopes from Linh","creatorUniqueId":"linh.live","eventTypes":["envelope"],"minDiamondCount":100,"channels":[{"channelType":"webhook","target":"https://example.com/hooks/roomscope"}]}'レスポンス
{ "rule": { "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9", "name": "Envelopes from Linh", "creatorUniqueId": "linh.live", "scope": "creator", "gifterKey": null, "region": null, "eventTypes": [ "envelope" ], "minScore": null, "minRate": null, "minDiamondCount": 100, "minFollowerMilestone": null, "goodyBagAllowAllViewers": null, "goodyBagMaxRequiredLevel": null, "enabled": true, "createdAt": "2026-11-01T10:51:45.582Z", "updatedAt": "2026-11-01T10:51:45.582Z", "channels": [ { "id": "3d0d4dc5-6993-55ab-a1cd-ffbe7db95507", "channelType": "in_app", "target": null, "enabled": true, "hasSigningSecret": false } ] }, "webhookSecrets": []}エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
アラートルールを更新
/v1/alerts/rules/{rule_id}変更するフィールドだけを送信します。channels は一覧全体を置き換えます。
パスパラメーター
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | アラートルールの ID(UUID)。 |
リクエストボディ
| Name | Type | Description |
|---|---|---|
nameOptional | string | 通知に表示されます。 |
creatorUniqueIdOptional | string | null | 監視するクリエイター。省略すると地域全体が対象になります。 |
scopeOptional | "creator" | "any" | "watchlist" | "gifter_watchlist" | ルールの監視対象: 指定したクリエイター、すべてのルーム(任意で 1 地域)、ワークスペースのウォッチリストのクリエイター、またはギフターのウォッチリスト(ワークスペースごとに 1 ルール)。creatorUniqueId があれば既定は creator、なければ any。 |
regionOptional | string | null | |
eventTypesOptional | ("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[] | LIVE イベント(gift、envelope、goodyBag、live_start、live_end)と、ルールのクリエイターまたはウォッチリストに対して毎時実行されるホストチェック: host_quiet(3 日間 LIVE なし)、league_change、diamond_target(ランキングの 1 日が minDiamondCount に到達)、follower_milestone(minFollowerMilestone の倍数を超えた)。 |
minDiamondCountOptional | integer | null | これより少ないダイヤモンドのイベントは無視します。 |
minFollowerMilestoneOptional | integer | null | follower_milestone のフォロワー刻み(例: 10000)。 |
enabledOptional | boolean | Default: true |
channelsOptional | object[] |
リクエスト
curl -X PATCH "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \ -H "Content-Type: application/json" \ -d '{"enabled":false}'レスポンス
{ "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9", "name": "Envelopes from Linh", "creatorUniqueId": "linh.live", "scope": "creator", "gifterKey": null, "region": null, "eventTypes": [ "envelope" ], "minScore": null, "minRate": null, "minDiamondCount": 100, "minFollowerMilestone": null, "goodyBagAllowAllViewers": null, "goodyBagMaxRequiredLevel": null, "enabled": true, "createdAt": "2026-11-01T10:51:45.582Z", "updatedAt": "2026-11-01T10:51:45.582Z", "channels": [ { "id": "3d0d4dc5-6993-55ab-a1cd-ffbe7db95507", "channelType": "in_app", "target": null, "enabled": true, "hasSigningSecret": false } ]}エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
アラートルールを削除
/v1/alerts/rules/{rule_id}ルールとそのチャネルを削除します。ボディは返しません。
パスパラメーター
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | アラートルールの ID(UUID)。 |
リクエスト
curl -X DELETE "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
204 を返し、ボディはありません。
エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
テスト通知を送信
/v1/alerts/rules/{rule_id}/testルールの有効な全チャネルにサンプルイベントを今すぐ配信し、各チャネルの結果を results(delivered、failed、capped と detail)で返します。テストの発火と配信は isTest: true で記録されます。
パスパラメーター
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | アラートルールの ID(UUID)。 |
リクエスト
curl -X POST "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9/test" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
{ "enqueued": 2, "results": [ { "channelId": "3d0d4dc5-6993-55ab-a1cd-ffbe7db95507", "channelType": "in_app", "status": "delivered", "detail": null }, { "channelId": "9e1f2a3b-4c5d-5e6f-8a7b-0c1d2e3f4a5b", "channelType": "discord", "status": "failed", "detail": "discord HTTP 404" } ]}エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。
過去 24 時間のアラート活動
/v1/alerts/stats過去 24 時間の有効なルール数、発火数、結果別の配信数(テストを除く)。
リクエスト
curl "https://api.next.toktokdata.live/v1/alerts/stats" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"レスポンス
{ "rulesActive": 3, "fired24h": 41, "delivered24h": 78, "failed24h": 2, "capped24h": 0, "provenance": { "observedAt": "2026-11-06T10:00:00.000Z", "freshness": "near_realtime", "source": "workspace_alert_history", "sourceKind": "derived", "coverageStatus": "observed", "methodologyVersion": "alert-history-v1", "window": { "from": "2026-11-05T10:00:00.000Z", "to": "2026-11-06T10:00:00.000Z", "label": "24h" } }}エラー
400パラメーターまたはボディが不正です。問題の内容はcodeで示されます。401API キーがないか、不明なキーです。403キーに必要なスコープがないか、プランにその機能が含まれていません。429リクエストのレートを超えました(毎秒・毎分・毎日のいずれか)。Retry-Afterに従ってください。