RoomScope

آخر تحديث

التنبيهات

قواعد التنبيه التي تنطلق عند أحداث LIVE (webhook، والبريد الإلكتروني، وداخل التطبيق، وTelegram).

تُصادَق كل عملية بمفتاح API (Authorization: Bearer <key>) وتستخدم الأخطاء الغلاف المشترك الموضّح في الأخطاء. مولَّد من مستند OpenAPI الخاص بواجهة API.

عرض قواعد التنبيه

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

تراقب القاعدة صانع محتوى واحدًا (أو منطقة كاملة) بحثًا عن أنواع أحداث معينة وترسل إلى قنواتها. ويُرجَع سر التوقيع لقناة 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معرّف قاعدة التنبيه (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معرّف قاعدة التنبيه (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معرّف قاعدة التنبيه (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.
هل كانت هذه الصفحة مفيدة؟