Terakhir diperbarui
Peringatan
Aturan peringatan yang terpicu pada event LIVE (webhook, email, dalam aplikasi, Telegram).
Setiap operasi diautentikasi dengan API key (Authorization: Bearer <key>) dan error memakai amplop bersama yang dijelaskan di Error. Dibuat dari dokumen OpenAPI milik API.
Daftar pengiriman alert
/v1/alerts/deliveriesSatu baris per aturan, kanal, dan peristiwa: delivered, failed (dengan detail dan jumlah attempts) atau capped (batas paket, seperti batas webhook bulanan, membuangnya), terbaru lebih dulu.
Parameter query
| Name | Type | Description |
|---|---|---|
ruleIdOptional | string | Hanya aturan ini (UUID). |
statusOptional | "delivered" | "failed" | "capped" | Hanya hasil ini. |
sinceOptional | string | Waktu ISO 8601; hanya baris yang lebih baru. |
limitOptional | integer | Jumlah baris yang dikembalikan. Rentang 1–200. Default: 50 |
Permintaan
curl "https://api.next.toktokdata.live/v1/alerts/deliveries" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Respons
{ "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 }}Error
400Parameter atau body tidak valid;codemenyebutkan masalahnya.401API key tidak ada atau tidak dikenal.403Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.429Laju permintaan terlampaui (per detik, per menit, atau per hari); patuhiRetry-After.
Daftar alert yang terpicu
/v1/alerts/firesSetiap kali aturan cocok dengan sebuah peristiwa, terbaru lebih dulu, baik terkirim oleh kanal atau tidak (bandingkan dengan pengiriman).
Parameter query
| Name | Type | Description |
|---|---|---|
ruleIdOptional | string | Hanya aturan ini (UUID). |
sinceOptional | string | Waktu ISO 8601; hanya baris yang lebih baru. |
limitOptional | integer | Jumlah baris yang dikembalikan. Rentang 1–200. Default: 50 |
Permintaan
curl "https://api.next.toktokdata.live/v1/alerts/fires" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Respons
{ "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 }}Error
400Parameter atau body tidak valid;codemenyebutkan masalahnya.401API key tidak ada atau tidak dikenal.403Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.429Laju permintaan terlampaui (per detik, per menit, atau per hari); patuhiRetry-After.
Daftar aturan peringatan
/v1/alerts/rulesSetiap aturan milik workspace beserta kanalnya. Signing secret tidak pernah dikembalikan lagi.
Permintaan
curl "https://api.next.toktokdata.live/v1/alerts/rules" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Respons
{ "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 }}Error
400Parameter atau body tidak valid;codemenyebutkan masalahnya.401API key tidak ada atau tidak dikenal.403Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.429Laju permintaan terlampaui (per detik, per menit, atau per hari); patuhiRetry-After.
Buat aturan peringatan
/v1/alerts/rulesSebuah aturan memantau satu kreator (atau seluruh wilayah) untuk jenis event tertentu dan mengirim ke kanal-kanalnya. Signing secret kanal webhook dikembalikan sekali, di webhookSecrets.
Body permintaan
| Name | Type | Description |
|---|---|---|
nameRequired | string | Ditampilkan di notifikasi. |
creatorUniqueIdOptional | string | null | Pantau satu kreator; kosongkan untuk seluruh wilayah. |
scopeOptional | "creator" | "any" | "watchlist" | "gifter_watchlist" | Apa yang dipantau aturan: kreator yang ditetapkan, semua ruang (opsional satu wilayah), kreator di watchlist workspace, atau watchlist gifter (satu aturan per workspace). Bawaannya creator jika creatorUniqueId diisi, selain itu any. |
regionOptional | string | null | |
eventTypesOptional | ("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[] | Peristiwa LIVE (gift, envelope, goodyBag, live_start, live_end) dan pemeriksaan host setiap jam untuk kreator atau watchlist aturan: host_quiet (tidak LIVE selama 3 hari), league_change, diamond_target (satu hari papan mencapai minDiamondCount) dan follower_milestone (melewati kelipatan minFollowerMilestone). |
minDiamondCountOptional | integer | null | Abaikan event yang bernilai lebih sedikit berlian. |
minFollowerMilestoneOptional | integer | null | Langkah pengikut untuk follower_milestone (mis. 10000). |
enabledOptional | boolean | Default: true |
channelsOptional | object[] |
Permintaan
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"}]}'Respons
{ "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": []}Error
400Parameter atau body tidak valid;codemenyebutkan masalahnya.401API key tidak ada atau tidak dikenal.403Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.429Laju permintaan terlampaui (per detik, per menit, atau per hari); patuhiRetry-After.
Perbarui aturan peringatan
/v1/alerts/rules/{rule_id}Kirim hanya field yang ingin diubah; channels menggantikan seluruh daftar.
Parameter path
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | Id aturan peringatan (UUID). |
Body permintaan
| Name | Type | Description |
|---|---|---|
nameOptional | string | Ditampilkan di notifikasi. |
creatorUniqueIdOptional | string | null | Pantau satu kreator; kosongkan untuk seluruh wilayah. |
scopeOptional | "creator" | "any" | "watchlist" | "gifter_watchlist" | Apa yang dipantau aturan: kreator yang ditetapkan, semua ruang (opsional satu wilayah), kreator di watchlist workspace, atau watchlist gifter (satu aturan per workspace). Bawaannya creator jika creatorUniqueId diisi, selain itu any. |
regionOptional | string | null | |
eventTypesOptional | ("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[] | Peristiwa LIVE (gift, envelope, goodyBag, live_start, live_end) dan pemeriksaan host setiap jam untuk kreator atau watchlist aturan: host_quiet (tidak LIVE selama 3 hari), league_change, diamond_target (satu hari papan mencapai minDiamondCount) dan follower_milestone (melewati kelipatan minFollowerMilestone). |
minDiamondCountOptional | integer | null | Abaikan event yang bernilai lebih sedikit berlian. |
minFollowerMilestoneOptional | integer | null | Langkah pengikut untuk follower_milestone (mis. 10000). |
enabledOptional | boolean | Default: true |
channelsOptional | object[] |
Permintaan
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}'Respons
{ "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 } ]}Error
400Parameter atau body tidak valid;codemenyebutkan masalahnya.401API key tidak ada atau tidak dikenal.403Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.429Laju permintaan terlampaui (per detik, per menit, atau per hari); patuhiRetry-After.
Hapus aturan peringatan
/v1/alerts/rules/{rule_id}Menghapus aturan beserta kanalnya. Tidak mengembalikan body.
Parameter path
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | Id aturan peringatan (UUID). |
Permintaan
curl -X DELETE "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Respons
204 tanpa body.
Error
400Parameter atau body tidak valid;codemenyebutkan masalahnya.401API key tidak ada atau tidak dikenal.403Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.429Laju permintaan terlampaui (per detik, per menit, atau per hari); patuhiRetry-After.
Kirim notifikasi uji
/v1/alerts/rules/{rule_id}/testMengirim peristiwa uji ke setiap kanal aktif aturan sekarang dan mengembalikan hasil tiap kanal di results (delivered, failed atau capped, dengan detail). Pemicu dan pengiriman uji dicatat dengan isTest: true.
Parameter path
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | Id aturan peringatan (UUID). |
Permintaan
curl -X POST "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9/test" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Respons
{ "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" } ]}Error
400Parameter atau body tidak valid;codemenyebutkan masalahnya.401API key tidak ada atau tidak dikenal.403Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.429Laju permintaan terlampaui (per detik, per menit, atau per hari); patuhiRetry-After.
Aktivitas alert dalam 24 jam terakhir
/v1/alerts/statsAturan aktif, pemicu, dan pengiriman per hasil dalam 24 jam terakhir (tanpa uji).
Permintaan
curl "https://api.next.toktokdata.live/v1/alerts/stats" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"Respons
{ "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" } }}Error
400Parameter atau body tidak valid;codemenyebutkan masalahnya.401API key tidak ada atau tidak dikenal.403Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.429Laju permintaan terlampaui (per detik, per menit, atau per hari); patuhiRetry-After.