RoomScope

آخر تحديث

LIVE

جلسات LIVE المسجّلة، وأداء كل صانع محتوى، ومصدر فيديو LIVE، ودردشة LIVE الأخيرة.

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

عرض الداعمين

GET/v1/gifters

الداعمون الذين يرسلون الهدايا في غرف LIVE التي سجّلها RoomScope خلال آخر 7 أو 30 يومًا، مرتّبون حسب الماسات: عدد الهدايا، والجلسات، وصنّاع المحتوى الذين تلقّوا هداياهم، وصانع المحتوى صاحب آخر غرفة، وماسات الفترة السابقة. لكل داعم شريحة: whale (10,000 ماسة على الأقل في 7 أيام أو 30,000 في 30 يومًا)، أو rising (1,000 ماسة على الأقل وضعف الفترة السابقة)، أو regular (3 جلسات أو أكثر)، أو one_time (جلسة واحدة)، أو occasional. يُبقي region على الهدايا المرسلة إلى صنّاع المحتوى في تلك المنطقة فقط. التغطية دائمًا partial. يتطلب باقة Pro أو أعلى.

النطاقgifter:readوحدات الرصيدقراءة مخزنة مؤقتًا

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

معاملات الاستعلام · GET /v1/gifters
NameTypeDescription
windowOptional
"7d" | "30d"7d أو 30d.
Default: 7d
segmentOptional
"whale" | "rising" | "regular" | "one_time" | "occasional"شريحة واحدة فقط.
regionOptional
stringمنطقة صنّاع المحتوى الذين تلقّوا الهدايا (مثل VN).
limitOptional
integerالحد الأقصى لعدد الصفوف. المدى …–500.
Default: 50

الطلب

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

الاستجابة

200 OK
{  "data": {    "window": "7d",    "region": "VN",    "segment": null,    "counts": {      "whale": 1,      "rising": 0,      "regular": 0,      "one_time": 0,      "occasional": 0,      "total": 1    },    "gifters": [      {        "gifterUserId": "6987001122334455667",        "gifterUniqueId": "minh.fan",        "gifterNickname": "Minh",        "avatarUrl": null,        "diamondTotal": 18450,        "previousDiamondTotal": 9200,        "giftCount": 312,        "sessions": 4,        "creatorsGifted": 2,        "lastGiftAt": "2026-11-02T15:41:07.512Z",        "lastRoomCreator": "linh.live",        "segment": "whale"      }    ]  },  "provenance": {    "observedAt": "2026-11-02T15:41:07.512Z",    "freshness": "historical",    "source": "platform_observed_gifter_events",    "sourceKind": "derived",    "coverageStatus": "partial",    "methodologyVersion": "gifters-observed-v1",    "window": {      "from": "2026-10-27T04:00:00.000Z",      "to": "2026-11-03T04:00:00.000Z",      "label": "7d"    }  }}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.

عرض الهدايا

GET/v1/gifts

هدايا TikTok التي ظهرت في غرف LIVE التي سجّلها RoomScope، مع عدد عملات الهدية الواحدة، والمناطق التي أُرسلت فيها، ووقت ظهورها لأول مرة وآخر مرة. تكون قيمة isGlobal هي true عندما تظهر الهدية في 3 مناطق على الأقل. لا تُضمَّن الصور ولا الهدايا التي لم يرسلها أحد بعد، لذا تكون التغطية partial. تتم المزامنة يوميًا.

النطاقlive:readوحدات الرصيدقراءة مخزنة مؤقتًا

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

معاملات الاستعلام · GET /v1/gifts
NameTypeDescription
qOptional
stringجزء من اسم الهدية.
minCoinsOptional
integerالحد الأدنى لعملات الهدية الواحدة.
maxCoinsOptional
integerالحد الأقصى لعملات الهدية الواحدة.
regionOptional
stringالهدايا التي ظهرت في هذه المنطقة فقط (مثل VN).
sortOptional
"coins" | "name" | "recent"coins (الأكثر أولًا) أو name أو recent.
Default: coins
limitOptional
integerالحد الأقصى لعدد الصفوف. المدى …–500.
Default: 100

الطلب

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

الاستجابة

200 OK
{  "data": {    "gifts": [      {        "giftId": "5655",        "name": "Rose",        "coins": 1,        "imageUrl": null,        "isGlobal": false,        "regions": [          "VN"        ],        "firstSeenAt": "2026-11-01T02:14:09.000Z",        "lastSeenAt": "2026-11-07T08:41:52.000Z"      }    ],    "total": 1  },  "provenance": {    "observedAt": "2026-11-07T03:10:00.000Z",    "freshness": "near_realtime",    "source": "platform_observed_live_stream",    "sourceKind": "derived",    "coverageStatus": "partial",    "methodologyVersion": "gift-catalog-observed-v1",    "window": null  }}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.

الحصول على دردشة LIVE الأخيرة لصانع محتوى

GET/v1/live/creators/{uid}/comments

أحدث تعليقات الدردشة في غرفة LIVE الخاصة بصانع المحتوى، الأقدم أولًا، للوحة دردشة بجوار المشغّل. استدعِه كل بضع ثوانٍ ومرّر cursor من الإجابة السابقة في after لتحصل على التعليقات الأحدث فقط (100 تعليق كحد أقصى لكل إجابة؛ وإذا وصل أكثر فأحدث 100). لا توجد تعليقات إلا للغرف التي يتابعها RoomScope وتتابعها مساحة عملك (قائمة المتابعة أو اشتراك الغرفة): status: tracked مع roomId، وإلا status: not_tracked بلا عناصر (يوضح followed ما إذا كانت مساحة عملك تتابع صانع المحتوى). يحتفظ RoomScope بآخر 200 تعليق في الغرفة لمدة 10 دقائق بعد آخر تعليق. مجاني (بلا أرصدة)، ومحدود بـ 60 طلبًا في الدقيقة لكل مستخدم (429 مع Retry-After عند التجاوز).

النطاقlive:readوحدات الرصيدمجاني

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

معاملات المسار · GET /v1/live/creators/{uid}/comments
NameTypeDescription
uidRequired
stringاسم مستخدم صانع المحتوى (linh.live)؛ ويُتجاهل الرمز @ في البداية.

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

معاملات الاستعلام · GET /v1/live/creators/{uid}/comments
NameTypeDescription
afterOptional
stringcursor من الإجابة السابقة: التعليقات الأحدث فقط.

الطلب

curl "https://api.next.toktokdata.live/v1/live/creators/linh.live/comments" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

الاستجابة

200 OK
{  "status": "tracked",  "followed": true,  "roomId": "7665709659185105682",  "items": [    {      "id": "7568123456789012345",      "createdAt": "2026-11-06T13:05:41.512Z",      "comment": "hello from Hanoi!",      "user": {        "uniqueId": "minh.fan",        "nickname": "Minh",        "avatarUrl": "https://p16-sign-sg.tiktokcdn.com/avatar-minh.jpeg"      }    },    {      "id": "7568123456789012399",      "createdAt": "2026-11-06T13:05:43.208Z",      "comment": "sing the last song again please",      "user": {        "uniqueId": "an.nguyen",        "nickname": "An",        "avatarUrl": null      }    }  ],  "cursor": "1793970343251-0",  "provenance": {    "observedAt": "2026-11-06T13:05:43.251Z",    "freshness": "near_realtime",    "source": "platform_observed_live_stream",    "sourceKind": "derived",    "coverageStatus": "partial",    "methodologyVersion": "live-history-v1",    "window": null  }}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.
  • 503 غير متاح مؤقتًا؛ أعد المحاولة بعد Retry-After عندما تكون قيمة retryable هي true.

جلب أداء LIVE لصانع محتوى

GET/v1/live/creators/{uid}/performance

صف واحد لكل جلسة مسجّلة: المدة وذروة المشاهدين والهدايا والماس وعدد المُهدين المختلفين. فقط لصانع محتوى في قائمة متابعة مساحة العمل أو غرفة يتابعها أعضاؤها؛ وإلا تكون items فارغة وfollowed قيمتها false.

النطاقlive:readوحدات الرصيدقراءة مخزنة مؤقتًا

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

معاملات المسار · GET /v1/live/creators/{uid}/performance
NameTypeDescription
uidRequired
stringاسم مستخدم صانع المحتوى دون @ (linh.live) أو معرّف مستخدم TikTok الرقمي.

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

معاملات الاستعلام · GET /v1/live/creators/{uid}/performance
NameTypeDescription
cursorOptional
stringمؤشر معتم مأخوذ من nextCursor في الصفحة السابقة.
limitOptional
integerعدد الصفوف في كل صفحة. المدى 1–100.
Default: 50

الطلب

curl "https://api.next.toktokdata.live/v1/live/creators/linh.live/performance" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

الاستجابة

200 OK
{  "data": {    "items": [      {        "sessionId": "f18eaa3e-a762-543d-9ea5-178271dc43f9",        "sessionStartedAt": "2026-11-01T07:51:44.935Z",        "creatorUniqueId": "linh.live",        "roomKey": "room:linh.live",        "durationSeconds": 7200,        "peakViewerCount": 2000,        "eventCount": 1000,        "chatCount": 600,        "giftCount": 80,        "totalGiftDiamonds": 5000,        "distinctGifterCount": 2      },      {        "sessionId": "278f3a86-af07-5768-85d2-6dfff8efee7d",        "sessionStartedAt": "2026-10-31T07:51:44.935Z",        "creatorUniqueId": "linh.live",        "roomKey": "room:linh.live",        "durationSeconds": 7200,        "peakViewerCount": 1000,        "eventCount": 500,        "chatCount": 300,        "giftCount": 40,        "totalGiftDiamonds": 2500,        "distinctGifterCount": 2      }    ],    "nextCursor": null,    "historyWindowDays": 365,    "historyTruncated": false,    "followed": true  },  "provenance": {    "observedAt": "2026-11-01T07:51:44.935Z",    "freshness": "historical",    "source": "platform_observed_live_stream",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "live-history-v1",    "window": null  }}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.

جلب مصدر فيديو LIVE لصانع محتوى

GET/v1/live/creators/{uid}/playback

رابط الفيديو الموقّع والمحدود الصلاحية لغرفة LIVE الحالية لصانع المحتوى. يحمّله المشغّل لديك مباشرة من شبكة CDN التابعة لـ TikTok (source: tiktok-cdn)؛ ولا يمرّر RoomScope الفيديو عبر خوادمه أبدًا. يُفضَّل hlsUrl؛ أما flvUrl فهو مصدر الغرف التي لا تدعم إلا FLV (شغّله بمحرك MSE مثل mpegts.js)؛ ويُضبط واحد منهما على الأقل عندما تكون status: live، وتشير expiresAt إلى وقت توقف ذلك الرابط عن العمل. غالبًا ما تكون renditions فارغة. وتكون avatarUrl وfollowerCount وregion بقيمة null عندما تكون غير معروفة. الإجابات الأخرى: status: offline (لا يبث)، وstatus: no_playback (يبث، لكن TikTok لا توفر مصدرًا قابلًا للتشغيل)، و202 status: resolving (استطلع الرابط نفسه بعد Retry-After)، و503 collection_saturated أو live_playback_upstream_unavailable (أعد المحاولة)، و503 live_playback_not_configured ما دامت الميزة معطّلة في هذا النشر (لا تُعد المحاولة). يتطلب النطاق live:stream، لا live:read.

النطاقlive:streamوحدات الرصيدقراءة مخزنة مؤقتًا

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

معاملات المسار · GET /v1/live/creators/{uid}/playback
NameTypeDescription
uidRequired
stringاسم مستخدم صانع المحتوى (linh.live)؛ ويُتجاهل الرمز @ في البداية.

الطلب

curl "https://api.next.toktokdata.live/v1/live/creators/linh.live/playback" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

الاستجابة

200 OK
{  "status": "live",  "roomId": "7665709659185105682",  "title": "Friday night karaoke",  "nickname": "Linh",  "hlsUrl": "https://pull-hls-l1-sg01.tiktokcdn.com/stage/stream-7665709727191485202_hd/index.m3u8?expire=1786024940&sign=ea92cabbf90993d50a0e3d50ee9ed526",  "flvUrl": "https://pull-flv-l1-sg01.tiktokcdn.com/stage/stream-7665709727191485202_hd.flv?expire=1786024940&sign=ea92cabbf90993d50a0e3d50ee9ed526",  "expiresAt": "2026-08-06T14:02:20.000Z",  "startedAt": "2026-07-23T09:46:40.000Z",  "renditions": [],  "avatarUrl": "https://p16-sign-sg.tiktokcdn.com/avatar.jpeg",  "verified": true,  "followerCount": 894314,  "region": "VN",  "source": "tiktok-cdn",  "cached": false}

الأخطاء

  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.
  • 503 غير متاح مؤقتًا؛ أعد المحاولة بعد Retry-After عندما تكون قيمة retryable هي true.

جدولة تحديث لحالة البث

POST/v1/live/creators/{uid}/refresh

يطلب من العمّال التحقق الآن مما إذا كان صانع المحتوى يبث مباشرة. يُحتسب بتعرفة التحديث.

النطاقlive:readوحدات الرصيدتحديث حالة البث

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

معاملات المسار · POST /v1/live/creators/{uid}/refresh
NameTypeDescription
uidRequired
stringاسم مستخدم صانع المحتوى دون @ (linh.live) أو معرّف مستخدم TikTok الرقمي.

الطلب

curl -X POST "https://api.next.toktokdata.live/v1/live/creators/linh.live/refresh" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

الاستجابة

202 Accepted
{  "queued": true,  "jobId": "1761994604935-0"}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.

عرض جلسات LIVE المسجّلة

GET/v1/live/sessions

الجلسات التي سجّلها RoomScope لصنّاع المحتوى في قائمة متابعة مساحة العمل والغرف التي يتابعها أعضاؤها، الأحدث أولًا؛ ولا تظهر أبدًا جلسات مساحات العمل الأخرى. الجلسة التي ما زالت جارية تحمل endedAt: null.

النطاقlive:readوحدات الرصيدقراءة مخزنة مؤقتًا

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

معاملات الاستعلام · GET /v1/live/sessions
NameTypeDescription
creatorUniqueIdOptional
stringجلسات صانع المحتوى هذا فقط (اسم المستخدم دون @).
cursorOptional
stringمؤشر معتم مأخوذ من nextCursor في الصفحة السابقة.
limitOptional
integerعدد الجلسات في كل صفحة. المدى 1–100.
Default: 50

الطلب

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

الاستجابة

200 OK
{  "data": {    "items": [      {        "id": "f18eaa3e-a762-543d-9ea5-178271dc43f9",        "roomKey": "room:linh.live",        "roomId": "7990000000000000001",        "creatorUniqueId": "linh.live",        "creatorAvatarUrl": null,        "startedAt": "2026-11-01T07:51:44.935Z",        "endedAt": "2026-11-01T09:51:44.935Z",        "peakViewerCount": 2000,        "eventCount": 1000,        "chatCount": 600,        "giftCount": 80,        "totalGiftDiamonds": 5000,        "durationSeconds": 7200      },      {        "id": "278f3a86-af07-5768-85d2-6dfff8efee7d",        "roomKey": "room:linh.live",        "roomId": "7990000000000000001",        "creatorUniqueId": "linh.live",        "creatorAvatarUrl": null,        "startedAt": "2026-10-31T07:51:44.935Z",        "endedAt": "2026-10-31T09:51:44.935Z",        "peakViewerCount": 1000,        "eventCount": 500,        "chatCount": 300,        "giftCount": 40,        "totalGiftDiamonds": 2500,        "durationSeconds": 7200      }    ],    "nextCursor": null,    "historyWindowDays": 365,    "historyTruncated": false  },  "provenance": {    "observedAt": "2026-11-01T09:51:44.935Z",    "freshness": "historical",    "source": "platform_observed_live_stream",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "live-history-v1",    "window": null  }}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.

جلب جلسة LIVE

GET/v1/live/sessions/{session_id}

جلسة واحدة مع ملخصات الهدايا والمُهدين. جلسة صانع محتوى أو غرفة لا تتابعها مساحة العمل تُرجع 404.

النطاقlive:readوحدات الرصيدقراءة مخزنة مؤقتًا

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

معاملات المسار · GET /v1/live/sessions/{session_id}
NameTypeDescription
session_idRequired
stringمعرّف الجلسة من القائمة.

الطلب

curl "https://api.next.toktokdata.live/v1/live/sessions/f18eaa3e-a762-543d-9ea5-178271dc43f9" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

الاستجابة

200 OK
{  "data": {    "id": "278f3a86-af07-5768-85d2-6dfff8efee7d",    "roomKey": "room:linh.live",    "roomId": "7990000000000000001",    "creatorUniqueId": "linh.live",    "creatorAvatarUrl": null,    "startedAt": "2026-10-31T07:51:44.935Z",    "endedAt": "2026-10-31T09:51:44.935Z",    "peakViewerCount": 1000,    "eventCount": 500,    "chatCount": 300,    "giftCount": 40,    "totalGiftDiamonds": 2500,    "durationSeconds": 7200,    "giftRollups": [      {        "giftId": "5269",        "giftName": "TikTok",        "giftType": 1,        "giftCount": 10,        "diamondTotal": 2470,        "senderCount": 2      },      {        "giftId": "5655",        "giftName": "Rose",        "giftType": 1,        "giftCount": 30,        "diamondTotal": 30,        "senderCount": 2      }    ],    "gifterRollups": [      {        "gifterUserId": "991000000000000001",        "gifterUniqueId": "gifter.1",        "gifterNickname": "Gifter 1",        "giftCount": 20,        "diamondTotal": 1500      },      {        "gifterUserId": "991000000000000002",        "gifterUniqueId": "gifter.2",        "gifterNickname": "Gifter 2",        "giftCount": 20,        "diamondTotal": 1000      }    ]  },  "provenance": {    "observedAt": "2026-10-31T09:51:44.935Z",    "freshness": "stale",    "source": "platform_observed_live_stream",    "sourceKind": "derived",    "coverageStatus": "stale",    "methodologyVersion": "live-history-v1",    "window": null  }}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.

الحصول على جلسة LIVE دقيقة بدقيقة

GET/v1/live/sessions/{session_id}/timeline

السلسلة الدقيقية للجلسة منذ بدايتها: أعلى عدد مشاهدين والأحداث والدردشات والإعجابات والهدايا والماسات والداعمين الجدد والصناديق في كل دقيقة، مع offsetMinutes منذ البداية. للغرف المسجّلة فقط؛ والجلسة المسجّلة قبل وجود السلسلة بلا دقائق (coverageStatus: not-covered). الظهور مثل الجلسة نفسها.

النطاقlive:readوحدات الرصيدقراءة مخزنة مؤقتًا

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

معاملات المسار · GET /v1/live/sessions/{session_id}/timeline
NameTypeDescription
session_idRequired
stringمعرّف الجلسة من القائمة.

الطلب

curl "https://api.next.toktokdata.live/v1/live/sessions/f18eaa3e-a762-543d-9ea5-178271dc43f9/timeline" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

الاستجابة

200 OK
{  "data": {    "sessionId": "5b9f0c2e-7a51-5d3c-9b0e-1f2a3c4d5e6f",    "creatorUniqueId": "linh.live",    "startedAt": "2026-11-06T12:00:04.211Z",    "endedAt": "2026-11-06T14:00:12.903Z",    "durationSeconds": 7208,    "peakViewerCount": 1240,    "totalGiftDiamonds": 18450,    "minutes": [      {        "minuteAt": "2026-11-06T12:00:00.000Z",        "offsetMinutes": 0,        "viewersMax": 800,        "events": 120,        "chats": 60,        "likes": 300,        "gifts": 4,        "diamonds": 40,        "newGifters": 1,        "envelopes": 0      },      {        "minuteAt": "2026-11-06T12:01:00.000Z",        "offsetMinutes": 1,        "viewersMax": 840,        "events": 130,        "chats": 65,        "likes": 320,        "gifts": 5,        "diamonds": 55,        "newGifters": 2,        "envelopes": 0      },      {        "minuteAt": "2026-11-06T12:02:00.000Z",        "offsetMinutes": 2,        "viewersMax": 880,        "events": 140,        "chats": 70,        "likes": 340,        "gifts": 6,        "diamonds": 70,        "newGifters": 1,        "envelopes": 1      }    ]  },  "provenance": {    "observedAt": "2026-10-31T09:51:44.935Z",    "freshness": "stale",    "source": "platform_observed_live_stream",    "sourceKind": "derived",    "coverageStatus": "stale",    "methodologyVersion": "live-history-v1",    "window": null  }}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.

مقارنة جلسات LIVE

GET/v1/live/sessions/compare

من جلستين إلى أربع جنبًا إلى جنب، لكل منها مجاميعها ودقائقها المحاذاة على offsetMinutes منذ بدايتها. أي جلسة لا تتابعها مساحة العمل تُعيد 404.

النطاقlive:readوحدات الرصيدقراءة مخزنة مؤقتًا

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

معاملات الاستعلام · GET /v1/live/sessions/compare
NameTypeDescription
idsRequired
stringمعرّفات الجلسات مفصولة بفواصل، من 2 إلى 4.

الطلب

curl "https://api.next.toktokdata.live/v1/live/sessions/compare?ids=value" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

الاستجابة

200 OK
{  "data": {    "sessions": [      {        "sessionId": "5b9f0c2e-7a51-5d3c-9b0e-1f2a3c4d5e6f",        "creatorUniqueId": "linh.live",        "startedAt": "2026-11-06T12:00:04.211Z",        "endedAt": "2026-11-06T14:00:12.903Z",        "durationSeconds": 7208,        "peakViewerCount": 1240,        "totalGiftDiamonds": 18450,        "minutes": [          {            "minuteAt": "2026-11-06T12:00:00.000Z",            "offsetMinutes": 0,            "viewersMax": 800,            "events": 120,            "chats": 60,            "likes": 300,            "gifts": 4,            "diamonds": 40,            "newGifters": 1,            "envelopes": 0          },          {            "minuteAt": "2026-11-06T12:01:00.000Z",            "offsetMinutes": 1,            "viewersMax": 840,            "events": 130,            "chats": 65,            "likes": 320,            "gifts": 5,            "diamonds": 55,            "newGifters": 2,            "envelopes": 0          },          {            "minuteAt": "2026-11-06T12:02:00.000Z",            "offsetMinutes": 2,            "viewersMax": 880,            "events": 140,            "chats": 70,            "likes": 340,            "gifts": 6,            "diamonds": 70,            "newGifters": 1,            "envelopes": 1          }        ]      },      {        "sessionId": "8c1d2e3f-4a5b-5c6d-8e7f-9a0b1c2d3e4f",        "creatorUniqueId": "linh.live",        "startedAt": "2026-11-05T12:01:10.000Z",        "endedAt": "2026-11-05T13:30:40.000Z",        "durationSeconds": 5370,        "peakViewerCount": 980,        "totalGiftDiamonds": 9200,        "minutes": [          {            "minuteAt": "2026-11-06T12:00:00.000Z",            "offsetMinutes": 0,            "viewersMax": 800,            "events": 120,            "chats": 60,            "likes": 300,            "gifts": 4,            "diamonds": 80,            "newGifters": 1,            "envelopes": 0          },          {            "minuteAt": "2026-11-06T12:01:00.000Z",            "offsetMinutes": 1,            "viewersMax": 880,            "events": 130,            "chats": 65,            "likes": 320,            "gifts": 5,            "diamonds": 110,            "newGifters": 2,            "envelopes": 0          }        ]      }    ]  },  "provenance": {    "observedAt": "2026-10-31T09:51:44.935Z",    "freshness": "stale",    "source": "platform_observed_live_stream",    "sourceKind": "derived",    "coverageStatus": "stale",    "methodologyVersion": "live-history-v1",    "window": null  }}

الأخطاء

  • 400 معامل أو جسم طلب غير صالح؛ ويحدد code المشكلة.
  • 401 مفتاح API مفقود أو غير معروف.
  • 402 لا تكفي محفظة الرصيد في مساحة العمل لتغطية تكلفة الاستدعاء؛ ويوضح resetAt موعد إعادة ضبط الرصيد.
  • 403 المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.
  • 429 تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمة Retry-After.
هل كانت هذه الصفحة مفيدة؟