RoomScope

آخر تحديث

الحساب

الباقة والحدود واستخدام الرصيد لمساحة العمل التي يتبع لها المفتاح.

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

جلب الباقة والحدود

GET/v1/entitlements

باقة مساحة العمل ووحداتها وحدود المعدّل ومحفظة الرصيد لدورة فوترة: limits.watchlistMax، وcredits.resetAt (موعد إعادة ضبط رصيد الفترة)، وexports (عمليات التصدير داخل التطبيق حاليًا؛ وتكون perDay بقيمة null ما دام لا يُطبَّق حد يومي)، وmoney (قيمة الماسة الواحدة بالدولار الأمريكي الإجمالي التقديري، وحصة صانع المحتوى، وسعر صرف VND الشهري: تقديرات للعرض، وليست أبدًا ما تدفعه TikTok فعليًا).

النطاقkeys:manageوحدات الرصيدمجاني

معاملات الاستعلام

معاملات الاستعلام · 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 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدّل الطلبات؛ التزم بقيمة Retry-After.

جلب استخدام الرصيد

GET/v1/usage

وحدات الرصيد المستهلكة لكل عملية في دورة فوترة.

النطاقkeys:manageوحدات الرصيدمجاني

معاملات الاستعلام

معاملات الاستعلام · 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 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدّل الطلبات؛ التزم بقيمة Retry-After.
هل كانت هذه الصفحة مفيدة؟