RoomScope

最終更新

アラート

LIVE イベントで発動するアラートルール（Webhook、メール、アプリ内、Telegram）。

すべての操作は API キーで認証します (Authorization: Bearer <key>) 。エラーには共通のエンベロープを使用します。詳しくは次のページを参照してください： エラー. このページは API の OpenAPI ドキュメントから生成しています。

アラートルールを一覧表示

GET/v1/alerts/rules

ワークスペースのすべてのルールを、そのチャネルとともに返します。署名シークレットが再び返されることはありません。

スコープwebhook:manageクレジット無料

リクエスト

curl "https://api.toktokdata.live/v1/alerts/rules" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

レスポンス

200 OK
{  "rules": [    {      "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",      "name": "Envelopes from Linh",      "creatorUniqueId": "linh.live",      "region": null,      "eventTypes": [        "envelope"      ],      "minScore": null,      "minRate": null,      "minDiamondCount": 100,      "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 で示されます。
  • 401 API キーがないか、不明なキーです。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

アラートルールを作成

POST/v1/alerts/rules

ルールは 1 人のクリエイター（または地域全体）のイベントを種類ごとに監視し、そのチャネルに配信します。Webhook チャネルの署名シークレットは webhookSecrets で一度だけ返されます。

スコープwebhook:manageクレジット無料

リクエストボディ

リクエストボディ · POST /v1/alerts/rules
NameTypeDescription
nameRequired
string通知に表示されます。
creatorUniqueIdOptional
string | null監視するクリエイター。省略すると地域全体が対象になります。
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "*")[]
minDiamondCountOptional
integer | nullこれより少ないダイヤモンドのイベントは無視します。
enabledOptional
boolean
Default: true
channelsOptional
object[]

リクエスト

curl -X POST "https://api.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"}]}'

レスポンス

201 Created
{  "rule": {    "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",    "name": "Envelopes from Linh",    "creatorUniqueId": "linh.live",    "region": null,    "eventTypes": [      "envelope"    ],    "minScore": null,    "minRate": null,    "minDiamondCount": 100,    "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 で示されます。
  • 401 API キーがないか、不明なキーです。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

アラートルールを更新

PATCH/v1/alerts/rules/{rule_id}

変更するフィールドだけを送信します。channels は一覧全体を置き換えます。

スコープwebhook:manageクレジット無料

パスパラメーター

パスパラメーター · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringアラートルールの ID（UUID）。

リクエストボディ

リクエストボディ · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
nameOptional
string通知に表示されます。
creatorUniqueIdOptional
string | null監視するクリエイター。省略すると地域全体が対象になります。
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "*")[]
minDiamondCountOptional
integer | nullこれより少ないダイヤモンドのイベントは無視します。
enabledOptional
boolean
Default: true
channelsOptional
object[]

リクエスト

curl -X PATCH "https://api.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \  -H "Content-Type: application/json" \  -d '{"enabled":false}'

レスポンス

200 OK
{  "id": "7d01133d-6ecb-5101-a9c0-e23e4755bad9",  "name": "Envelopes from Linh",  "creatorUniqueId": "linh.live",  "region": null,  "eventTypes": [    "envelope"  ],  "minScore": null,  "minRate": null,  "minDiamondCount": 100,  "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 で示されます。
  • 401 API キーがないか、不明なキーです。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

アラートルールを削除

DELETE/v1/alerts/rules/{rule_id}

ルールとそのチャネルを削除します。ボディは返しません。

スコープwebhook:manageクレジット無料

パスパラメーター

パスパラメーター · DELETE /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringアラートルールの ID（UUID）。

リクエスト

curl -X DELETE "https://api.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

レスポンス

204 を返し、ボディはありません。

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。

テスト通知を送信

POST/v1/alerts/rules/{rule_id}/test

ルールの有効なすべてのチャネルに、テスト用のイベントを配信します。

スコープwebhook:manageクレジット無料

パスパラメーター

パスパラメーター · POST /v1/alerts/rules/{rule_id}/test
NameTypeDescription
rule_idRequired
stringアラートルールの ID（UUID）。

リクエスト

curl -X POST "https://api.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9/test" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

レスポンス

200 OK
{  "enqueued": 1}

エラー

  • 400 パラメーターまたはボディが不正です。問題の内容は code で示されます。
  • 401 API キーがないか、不明なキーです。
  • 403 キーに必要なスコープがないか、プランにその機能が含まれていません。
  • 429 リクエストレートを超えました。Retry-After に従ってください。
このページは役に立ちましたか？