RoomScope

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

บัญชี

แพ็กเกจ ขีดจำกัด และการใช้เครดิตของเวิร์กสเปซที่เป็นเจ้าของคีย์

ทุกการดำเนินการยืนยันตัวตนด้วย API key (Authorization: Bearer <key>) และข้อผิดพลาดใช้โครงสร้างร่วมที่อธิบายไว้ใน ข้อผิดพลาด. สร้างจากเอกสาร OpenAPI ของ API

ดึงแพ็กเกจและขีดจำกัด

GET/v1/entitlements

แพ็กเกจ โมดูล ขีดจำกัดอัตราการเรียก และกระเป๋าเครดิตของเวิร์กสเปซในรอบการเรียกเก็บเงินหนึ่ง: limits.watchlistMax, credits.resetAt (เวลาที่เครดิตของรอบจะรีเซ็ต) และ exports (การส่งออกในแอปของวันนี้ perDay เป็น null หากไม่มีเพดานรายวัน) และ money (มูลค่า 1 เพชรเป็น USD ขั้นต้นโดยประมาณ ส่วนแบ่งของครีเอเตอร์ และอัตรา VND รายเดือน: เป็นค่าประมาณเพื่อการแสดงผล ไม่ใช่ยอดที่ TikTok จ่ายจริง)

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

พารามิเตอร์ query

พารามิเตอร์ query · GET /v1/entitlements
NameTypeDescription
periodOptional
stringวันเริ่มต้นรอบการเรียกเก็บเงิน YYYY-MM-01 ค่าเริ่มต้นคือรอบปัจจุบัน

คำขอ

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

ผลลัพธ์

200 OK
{  "data": {    "workspaceId": "4388fdb0-ef68-5d01-ac84-b683b2b355e8",    "planCode": "agency",    "tier": "agency",    "modules": [      "live",      "lookup"    ],    "limits": {      "requestsPerWindow": 150,      "rateWindowMs": 1000,      "apiRequestsPerSecond": 150,      "requestsPerDay": 1200000,      "maxApiKeys": 0,      "wsConcurrencyCap": 200,      "maxRoomMinutesPerMonth": 800000,      "historyWindowDays": 365,      "maxSeats": 10,      "seatsUsed": 2,      "exportFormats": [        "csv",        "xlsx"      ],      "watchlistMax": 25    },    "credits": {      "period": "2026-11-01",      "monthlyAllotment": 36000000,      "hardCap": 36000000,      "spent": 0,      "remaining": 0,      "resetAt": "2026-12-01T00:00:00.000Z"    },    "money": {      "diamondUsdGross": 0.01,      "creatorShare": 0.5,      "vndPerUsd": 25500,      "rateLabel": "estimate · 2026-11"    },    "exports": {      "perDay": null,      "usedToday": 1    }  },  "provenance": {    "observedAt": "2026-11-01T11:19:24.411834Z",    "freshness": "near_realtime",    "source": "plan_entitlement",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "entitlements-v1",    "window": {      "from": "2026-11-01",      "to": "2026-12-01",      "label": "2026-11"    }  }}

ข้อผิดพลาด

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

ดึงการใช้เครดิต

GET/v1/usage

เครดิตที่ใช้ต่อการดำเนินการในรอบการเรียกเก็บเงินหนึ่ง

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

พารามิเตอร์ query

พารามิเตอร์ query · GET /v1/usage
NameTypeDescription
periodOptional
stringวันเริ่มต้นรอบการเรียกเก็บเงิน YYYY-MM-01 ค่าเริ่มต้นคือรอบปัจจุบัน
limitOptional
integerจำนวนแถวสูงสุด

คำขอ

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

ผลลัพธ์

200 OK
{  "period": "2026-11-01",  "balance": {    "remaining": 0,    "spent": 0  },  "items": [],  "provenance": {    "observedAt": "2026-11-01T10:00:00.000Z",    "freshness": "near_realtime",    "source": "credit_ledger",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "usage-v1",    "window": {      "from": "2026-11-01",      "to": "2026-12-01",      "label": "2026-11"    }  }}

ข้อผิดพลาด

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