อัปเดตล่าสุด
การแจ้งเตือน
กฎการแจ้งเตือนที่ทำงานเมื่อเกิดอีเวนต์ LIVE (webhook, อีเมล, ในแอป, Telegram)
ทุกการดำเนินการยืนยันตัวตนด้วย API key (Authorization: Bearer <key>) และข้อผิดพลาดใช้โครงสร้างร่วมที่อธิบายไว้ใน ข้อผิดพลาด. สร้างจากเอกสาร OpenAPI ของ API
แสดงรายการการส่งการแจ้งเตือน
/v1/alerts/deliveriesหนึ่งแถวต่อกฎ ช่องทาง และเหตุการณ์: delivered, failed (พร้อม detail และจำนวน attempts) หรือ capped (ถูกตัดตามขีดจำกัดของแพ็กเกจ เช่น ขีดจำกัด webhook รายเดือน) เรียงจากใหม่ไปเก่า
พารามิเตอร์ query
| Name | Type | Description |
|---|---|---|
ruleIdOptional | string | เฉพาะกฎนี้ (UUID) |
statusOptional | "delivered" | "failed" | "capped" | เฉพาะผลลัพธ์นี้ |
sinceOptional | string | เวลา ISO 8601; เฉพาะแถวที่ใหม่กว่า |
limitOptional | integer | จำนวนแถวที่จะส่งกลับ ช่วง 1–200. Default: 50 |
คำขอ
curl "https://api.next.toktokdata.live/v1/alerts/deliveries" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"ผลลัพธ์
{ "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 }}ข้อผิดพลาด
400พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
แสดงรายการการแจ้งเตือนที่ทำงาน
/v1/alerts/firesทุกครั้งที่กฎตรงกับเหตุการณ์ เรียงจากใหม่ไปเก่า ไม่ว่าช่องทางจะส่งได้หรือไม่ (เปรียบเทียบกับการส่ง)
พารามิเตอร์ query
| Name | Type | Description |
|---|---|---|
ruleIdOptional | string | เฉพาะกฎนี้ (UUID) |
sinceOptional | string | เวลา ISO 8601; เฉพาะแถวที่ใหม่กว่า |
limitOptional | integer | จำนวนแถวที่จะส่งกลับ ช่วง 1–200. Default: 50 |
คำขอ
curl "https://api.next.toktokdata.live/v1/alerts/fires" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"ผลลัพธ์
{ "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 }}ข้อผิดพลาด
400พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
แสดงรายการกฎการแจ้งเตือน
/v1/alerts/rulesกฎทั้งหมดของเวิร์กสเปซพร้อมช่องทาง คีย์ลับสำหรับลงลายเซ็นจะไม่ถูกส่งกลับมาอีก
คำขอ
curl "https://api.next.toktokdata.live/v1/alerts/rules" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"ผลลัพธ์
{ "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 }}ข้อผิดพลาด
400พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
สร้างกฎการแจ้งเตือน
/v1/alerts/rulesกฎหนึ่งติดตามครีเอเตอร์หนึ่งคน (หรือทั้งภูมิภาค) สำหรับประเภทอีเวนต์ที่กำหนด และส่งไปยังช่องทางของกฎ คีย์ลับสำหรับลงลายเซ็นของช่องทาง webhook จะถูกส่งกลับเพียงครั้งเดียวใน webhookSecrets
Body ของคำขอ
| Name | Type | Description |
|---|---|---|
nameRequired | string | แสดงในการแจ้งเตือน |
creatorUniqueIdOptional | string | null | ติดตามครีเอเตอร์หนึ่งคน เว้นไว้เพื่อติดตามทั้งภูมิภาค |
scopeOptional | "creator" | "any" | "watchlist" | "gifter_watchlist" | สิ่งที่กฎเฝ้าดู: ครีเอเตอร์ที่กำหนด ทุกห้อง (เลือกหนึ่งภูมิภาคได้) ครีเอเตอร์ใน watchlist ของเวิร์กสเปซ หรือ gifter watchlist (หนึ่งกฎต่อเวิร์กสเปซ) ค่าเริ่มต้นคือ creator เมื่อมี creatorUniqueId มิฉะนั้นเป็น any |
regionOptional | string | null | |
eventTypesOptional | ("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[] | เหตุการณ์ LIVE (gift, envelope, goodyBag, live_start, live_end) และการตรวจสอบโฮสต์ทุกชั่วโมงสำหรับครีเอเตอร์หรือ watchlist ของกฎ: host_quiet (ไม่ LIVE 3 วัน), league_change, diamond_target (วันหนึ่งของบอร์ดถึง minDiamondCount) และ follower_milestone (เกินผลคูณของ minFollowerMilestone) |
minDiamondCountOptional | integer | null | ข้ามอีเวนต์ที่มีมูลค่าเพชรน้อยกว่านี้ |
minFollowerMilestoneOptional | integer | null | ขั้นของผู้ติดตามสำหรับ follower_milestone (เช่น 10000) |
enabledOptional | boolean | Default: true |
channelsOptional | object[] |
คำขอ
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"}]}'ผลลัพธ์
{ "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": []}ข้อผิดพลาด
400พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
อัปเดตกฎการแจ้งเตือน
/v1/alerts/rules/{rule_id}ส่งเฉพาะฟิลด์ที่ต้องการเปลี่ยน channels จะแทนที่รายการทั้งหมด
พารามิเตอร์ใน path
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | id ของกฎการแจ้งเตือน (UUID) |
Body ของคำขอ
| Name | Type | Description |
|---|---|---|
nameOptional | string | แสดงในการแจ้งเตือน |
creatorUniqueIdOptional | string | null | ติดตามครีเอเตอร์หนึ่งคน เว้นไว้เพื่อติดตามทั้งภูมิภาค |
scopeOptional | "creator" | "any" | "watchlist" | "gifter_watchlist" | สิ่งที่กฎเฝ้าดู: ครีเอเตอร์ที่กำหนด ทุกห้อง (เลือกหนึ่งภูมิภาคได้) ครีเอเตอร์ใน watchlist ของเวิร์กสเปซ หรือ gifter watchlist (หนึ่งกฎต่อเวิร์กสเปซ) ค่าเริ่มต้นคือ creator เมื่อมี creatorUniqueId มิฉะนั้นเป็น any |
regionOptional | string | null | |
eventTypesOptional | ("gift" | "envelope" | "goodyBag" | "live_start" | "live_end" | "host_quiet" | "league_change" | "diamond_target" | "follower_milestone" | "*")[] | เหตุการณ์ LIVE (gift, envelope, goodyBag, live_start, live_end) และการตรวจสอบโฮสต์ทุกชั่วโมงสำหรับครีเอเตอร์หรือ watchlist ของกฎ: host_quiet (ไม่ LIVE 3 วัน), league_change, diamond_target (วันหนึ่งของบอร์ดถึง minDiamondCount) และ follower_milestone (เกินผลคูณของ minFollowerMilestone) |
minDiamondCountOptional | integer | null | ข้ามอีเวนต์ที่มีมูลค่าเพชรน้อยกว่านี้ |
minFollowerMilestoneOptional | integer | null | ขั้นของผู้ติดตามสำหรับ follower_milestone (เช่น 10000) |
enabledOptional | boolean | Default: true |
channelsOptional | object[] |
คำขอ
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}'ผลลัพธ์
{ "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 } ]}ข้อผิดพลาด
400พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
ลบกฎการแจ้งเตือน
/v1/alerts/rules/{rule_id}ลบกฎและช่องทางของกฎ ไม่ส่ง body กลับ
พารามิเตอร์ใน path
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | id ของกฎการแจ้งเตือน (UUID) |
คำขอ
curl -X DELETE "https://api.next.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 key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
ส่งการแจ้งเตือนทดสอบ
/v1/alerts/rules/{rule_id}/testส่งเหตุการณ์ตัวอย่างไปยังทุกช่องทางที่เปิดของกฎทันที และส่งผลของแต่ละช่องทางกลับใน results (delivered, failed หรือ capped พร้อม detail) การทำงานและการส่งทดสอบถูกบันทึกด้วย isTest: true
พารามิเตอร์ใน path
| Name | Type | Description |
|---|---|---|
rule_idRequired | string | id ของกฎการแจ้งเตือน (UUID) |
คำขอ
curl -X POST "https://api.next.toktokdata.live/v1/alerts/rules/7d01133d-6ecb-5101-a9c0-e23e4755bad9/test" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"ผลลัพธ์
{ "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" } ]}ข้อผิดพลาด
400พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After
กิจกรรมการแจ้งเตือนใน 24 ชั่วโมงที่ผ่านมา
/v1/alerts/statsจำนวนกฎที่เปิด การทำงาน และการส่งตามผลลัพธ์ใน 24 ชั่วโมงที่ผ่านมา (ไม่รวมการทดสอบ)
คำขอ
curl "https://api.next.toktokdata.live/v1/alerts/stats" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"ผลลัพธ์
{ "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" } }}ข้อผิดพลาด
400พารามิเตอร์หรือ body ไม่ถูกต้องcodeจะระบุปัญหา401ไม่มี API key หรือไม่รู้จัก API key403คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้429เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตามRetry-After