RoomScope

อัปเดตล่าสุด

การแจ้งเตือน

กฎการแจ้งเตือนที่ทำงานเมื่อเกิดอีเวนต์ LIVE (webhook, อีเมล, ในแอป, Telegram)

ทุกการดำเนินการยืนยันตัวตนด้วย API key (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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

สร้างกฎการแจ้งเตือน

POST/v1/alerts/rules

กฎหนึ่งติดตามครีเอเตอร์หนึ่งคน (หรือทั้งภูมิภาค) สำหรับประเภทอีเวนต์ที่กำหนด และส่งไปยังช่องทางของกฎ คีย์ลับสำหรับลงลายเซ็นของช่องทาง webhook จะถูกส่งกลับเพียงครั้งเดียวใน webhookSecrets

สโคปwebhook:manageเครดิตฟรี

Body ของคำขอ

Body ของคำขอ · 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 สร้างแล้ว
{  "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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

อัปเดตกฎการแจ้งเตือน

PATCH/v1/alerts/rules/{rule_id}

ส่งเฉพาะฟิลด์ที่ต้องการเปลี่ยน channels จะแทนที่รายการทั้งหมด

สโคปwebhook:manageเครดิตฟรี

พารามิเตอร์ใน path

พารามิเตอร์ใน path · PATCH /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringid ของกฎการแจ้งเตือน (UUID)

Body ของคำขอ

Body ของคำขอ · 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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

ลบกฎการแจ้งเตือน

DELETE/v1/alerts/rules/{rule_id}

ลบกฎและช่องทางของกฎ ไม่ส่ง body กลับ

สโคปwebhook:manageเครดิตฟรี

พารามิเตอร์ใน path

พารามิเตอร์ใน path · DELETE /v1/alerts/rules/{rule_id}
NameTypeDescription
rule_idRequired
stringid ของกฎการแจ้งเตือน (UUID)

คำขอ

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

ผลลัพธ์

204 โดยไม่มี body

ข้อผิดพลาด

  • 400 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

ส่งการแจ้งเตือนทดสอบ

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

ส่งอีเวนต์จำลองไปยังทุกช่องทางที่เปิดใช้งานของกฎ

สโคปwebhook:manageเครดิตฟรี

พารามิเตอร์ใน path

พารามิเตอร์ใน path · POST /v1/alerts/rules/{rule_id}/test
NameTypeDescription
rule_idRequired
stringid ของกฎการแจ้งเตือน (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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After
หน้านี้มีประโยชน์หรือไม่