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ı 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.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",      "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  }}

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ı; 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.
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "*")[]
minDiamondCountOptional
integer | nullDaha az elmas değerindeki olayları yok sayar.
enabledOptional
boolean
Default: true
channelsOptional
object[]

İstek

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

Yanıt

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

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ı; 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.
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "*")[]
minDiamondCountOptional
integer | nullDaha az elmas değerindeki olayları yok sayar.
enabledOptional
boolean
Default: true
channelsOptional
object[]

İstek

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

Yanıt

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

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ı; 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.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ı; Retry-After değerine uyun.

Test bildirimi gönderme

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

Kuralın etkin her kanalına sentetik bir olay teslim eder.

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.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9/test" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Yanıt

200 OK
{  "enqueued": 1}

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ı; Retry-After değerine uyun.
Bu sayfa işinize yaradı mı?