RoomScope

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 aturan peringatan

GET/v1/alerts/rules

Setiap aturan milik workspace beserta kanalnya. Signing secret tidak pernah dikembalikan lagi.

Scopewebhook:manageKreditGratis

Permintaan

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

Respons

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

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.

Buat aturan peringatan

POST/v1/alerts/rules

Sebuah aturan memantau satu kreator (atau seluruh wilayah) untuk jenis event tertentu dan mengirim ke kanal-kanalnya. Signing secret kanal webhook dikembalikan sekali, di webhookSecrets.

Scopewebhook:manageKreditGratis

Body permintaan

Body permintaan · POST /v1/alerts/rules
NameTypeDescription
nameRequired
stringDitampilkan di notifikasi.
creatorUniqueIdOptional
string | nullPantau satu kreator; kosongkan untuk seluruh wilayah.
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "*")[]
minDiamondCountOptional
integer | nullAbaikan event yang bernilai lebih sedikit berlian.
enabledOptional
boolean
Default: true
channelsOptional
object[]

Permintaan

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

Respons

201 Dibuat
{  "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": []}

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.

Perbarui aturan peringatan

PATCH/v1/alerts/rules/{rule_id}

Kirim hanya field yang ingin diubah; channels menggantikan seluruh daftar.

Scopewebhook:manageKreditGratis

Parameter path

Parameter path · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringId aturan peringatan (UUID).

Body permintaan

Body permintaan · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
nameOptional
stringDitampilkan di notifikasi.
creatorUniqueIdOptional
string | nullPantau satu kreator; kosongkan untuk seluruh wilayah.
regionOptional
string | null
eventTypesOptional
("gift" | "envelope" | "goodyBag" | "*")[]
minDiamondCountOptional
integer | nullAbaikan event yang bernilai lebih sedikit berlian.
enabledOptional
boolean
Default: true
channelsOptional
object[]

Permintaan

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

Respons

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

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.

Hapus aturan peringatan

DELETE/v1/alerts/rules/{rule_id}

Menghapus aturan beserta kanalnya. Tidak mengembalikan body.

Scopewebhook:manageKreditGratis

Parameter path

Parameter path · DELETE /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringId aturan peringatan (UUID).

Permintaan

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

Respons

204 tanpa body.

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.

Kirim notifikasi uji

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

Mengirim event sintetis ke setiap kanal aktif pada aturan tersebut.

Scopewebhook:manageKreditGratis

Parameter path

Parameter path · POST /v1/alerts/rules/{rule_id}/test
NameTypeDescription
rule_idRequired
stringId aturan peringatan (UUID).

Permintaan

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

Respons

200 OK
{  "enqueued": 1}

Error

  • 400 Parameter atau body tidak valid; code menyebutkan masalahnya.
  • 401 API key tidak ada atau tidak dikenal.
  • 403 Key tidak memiliki scope tersebut, atau paket tidak mencakup fitur ini.
  • 429 Laju permintaan terlampaui; patuhi Retry-After.
Apakah halaman ini membantu?