RoomScope

Son güncelleme

Uyarılar

LIVE olaylarında tetiklenen uyarı kuralları (webhook, e-posta, uygulama içi, Telegram).

Her işlemde kimlik doğrulama bir API anahtarıyla yapılır (Authorization: Bearer <key>) ve hatalar şu sayfada açıklanan ortak zarfı kullanır: Hatalar. API’nin OpenAPI belgesinden üretilmiştir.

Uyarı teslimatlarını listele

GET/v1/alerts/deliveries

Kural, kanal ve olay başına bir satır: delivered, failed (detail ve yapılan attempts ile) veya capped (aylık webhook sınırı gibi bir plan sınırı onu düşürdü), en yeni önce.

Kapsamwebhook:manageKredilerÜcretsiz

Sorgu parametreleri

Sorgu parametreleri · GET /v1/alerts/deliveries
NameTypeDescription
ruleIdOptional
stringYalnızca bu kural (UUID).
statusOptional
"delivered" | "failed" | "capped"Yalnızca bu sonuç.
sinceOptional
stringISO 8601 zamanı; yalnızca daha yeni satırlar.
limitOptional
integerDöndürülecek satır sayısı. Aralık 1–200.
Default: 50

İstek

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

Yanıt

200 OK
{  "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  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı (saniye, dakika veya gün başına); Retry-After değerine uyun.

Tetiklenen uyarıları listele

GET/v1/alerts/fires

Bir kuralın bir olayla her eşleştiği an, en yeni önce, bir kanal teslim etmiş olsun ya da olmasın (teslimatlarla karşılaştırın).

Kapsamwebhook:manageKredilerÜcretsiz

Sorgu parametreleri

Sorgu parametreleri · GET /v1/alerts/fires
NameTypeDescription
ruleIdOptional
stringYalnızca bu kural (UUID).
sinceOptional
stringISO 8601 zamanı; yalnızca daha yeni satırlar.
limitOptional
integerDöndürülecek satır sayısı. Aralık 1–200.
Default: 50

İstek

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

Yanıt

200 OK
{  "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  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı (saniye, dakika veya gün başına); Retry-After değerine uyun.

Uyarı kurallarını listeleme

GET/v1/alerts/rules

Çalışma alanının tüm kuralları, kanallarıyla birlikte. İmzalama gizli anahtarları bir daha asla döndürülmez.

Kapsamwebhook:manageKredilerÜcretsiz

İstek

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

Yanıt

200 OK
{  "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  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı (saniye, dakika veya gün başına); Retry-After değerine uyun.

Uyarı kuralı oluşturma

POST/v1/alerts/rules

Bir kural, tek bir içerik üreticisini (veya bütün bir bölgeyi) belirli olay türleri için izler ve kanallarına teslim eder. Bir webhook kanalının imzalama gizli anahtarı webhookSecrets içinde yalnızca bir kez döndürülür.

Kapsamwebhook:manageKredilerÜcretsiz

İstek gövdesi

İstek gövdesi · POST /v1/alerts/rules
NameTypeDescription
nameRequired
stringBildirimlerde gösterilir.
creatorUniqueIdOptional
string | nullTek bir içerik üreticisini izleyin; bölgenin tamamı için boş bırakın.
scopeOptional
"creator" | "any" | "watchlist" | "gifter_watchlist"Kuralın izlediği şey: sabitlenen içerik üreticisi, tüm odalar (isteğe bağlı olarak tek bölge), çalışma alanı watchlist'indeki içerik üreticileri veya gifter watchlist'i (çalışma alanı başına bir kural). creatorUniqueId varsa varsayılan creator, yoksa any.
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[]LIVE olayları (gift, envelope, goodyBag, live_start, live_end) ve kuralın içerik üreticisi veya watchlist'i için saatte bir çalışan host kontrolleri: host_quiet (3 gündür LIVE değil), league_change, diamond_target (bir sıralama günü minDiamondCount değerine ulaştı) ve follower_milestone (minFollowerMilestone katını geçti).
minDiamondCountOptional
integer | nullDaha az elmas değerindeki olayları yok sayar.
minFollowerMilestoneOptional
integer | nullfollower_milestone için takipçi adımı (ör. 10000).
enabledOptional
boolean
Default: true
channelsOptional
object[]

İstek

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"}]}'

Yanıt

201 Oluşturuldu
{  "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": []}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı (saniye, dakika veya gün başına); Retry-After değerine uyun.

Uyarı kuralını güncelleme

PATCH/v1/alerts/rules/{rule_id}

Yalnızca değiştirilecek alanları gönderin; channels listenin tamamını değiştirir.

Kapsamwebhook:manageKredilerÜcretsiz

Yol parametreleri

Yol parametreleri · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringUyarı kuralı kimliği (UUID).

İstek gövdesi

İstek gövdesi · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
nameOptional
stringBildirimlerde gösterilir.
creatorUniqueIdOptional
string | nullTek bir içerik üreticisini izleyin; bölgenin tamamı için boş bırakın.
scopeOptional
"creator" | "any" | "watchlist" | "gifter_watchlist"Kuralın izlediği şey: sabitlenen içerik üreticisi, tüm odalar (isteğe bağlı olarak tek bölge), çalışma alanı watchlist'indeki içerik üreticileri veya gifter watchlist'i (çalışma alanı başına bir kural). creatorUniqueId varsa varsayılan creator, yoksa any.
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[]LIVE olayları (gift, envelope, goodyBag, live_start, live_end) ve kuralın içerik üreticisi veya watchlist'i için saatte bir çalışan host kontrolleri: host_quiet (3 gündür LIVE değil), league_change, diamond_target (bir sıralama günü minDiamondCount değerine ulaştı) ve follower_milestone (minFollowerMilestone katını geçti).
minDiamondCountOptional
integer | nullDaha az elmas değerindeki olayları yok sayar.
minFollowerMilestoneOptional
integer | nullfollower_milestone için takipçi adımı (ör. 10000).
enabledOptional
boolean
Default: true
channelsOptional
object[]

İstek

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}'

Yanıt

200 OK
{  "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    }  ]}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı (saniye, dakika veya gün başına); Retry-After değerine uyun.

Uyarı kuralını silme

DELETE/v1/alerts/rules/{rule_id}

Kuralı ve kanallarını siler. Gövde döndürmez.

Kapsamwebhook:manageKredilerÜcretsiz

Yol parametreleri

Yol parametreleri · DELETE /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringUyarı kuralı kimliği (UUID).

İstek

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

Yanıt

204 gövdesiz döner.

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı (saniye, dakika veya gün başına); Retry-After değerine uyun.

Test bildirimi gönderme

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

Kuralın etkin her kanalına şimdi örnek bir olay gönderir ve her birinin sonucunu results içinde döndürür (delivered, failed veya capped, detail ile). Test tetiklemeleri ve teslimatları isTest: true ile kaydedilir.

Kapsamwebhook:manageKredilerÜcretsiz

Yol parametreleri

Yol parametreleri · POST /v1/alerts/rules/{rule_id}/test
NameTypeDescription
rule_idRequired
stringUyarı kuralı kimliği (UUID).

İstek

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

Yanıt

200 OK
{  "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"    }  ]}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı (saniye, dakika veya gün başına); Retry-After değerine uyun.

Son 24 saatteki uyarı etkinliği

GET/v1/alerts/stats

Son 24 saatte etkin kurallar, tetiklemeler ve sonuca göre teslimatlar (testler hariç).

Kapsamwebhook:manageKredilerÜcretsiz

İstek

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

Yanıt

200 OK
{  "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"    }  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı (saniye, dakika veya gün başına); Retry-After değerine uyun.
Bu sayfa işinize yaradı mı?