RoomScope

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

LIVE

เซสชัน LIVE ที่บันทึกไว้ ผลงานรายครีเอเตอร์ แหล่งวิดีโอ LIVE และแชต LIVE ล่าสุด

ทุกการดำเนินการยืนยันตัวตนด้วย API key (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เครดิตอ่านข้อมูลแคช

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

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

แสดงรายการของขวัญ

GET/v1/gifts

ของขวัญ TikTok ที่พบในห้อง LIVE ที่ RoomScope บันทึกไว้ พร้อมจำนวนเหรียญของของขวัญหนึ่งชิ้น ภูมิภาคที่มีการส่ง และเวลาที่พบครั้งแรกและครั้งล่าสุด isGlobal เป็น true เมื่อพบของขวัญนั้นในอย่างน้อย 3 ภูมิภาค ไม่รวมรูปภาพและของขวัญที่ยังไม่มีใครส่ง ความครอบคลุมจึงเป็น partial ซิงก์ทุกวัน

สโคปlive:readเครดิตอ่านข้อมูลแคช

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

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

ดึงแชต LIVE ล่าสุดของครีเอเตอร์

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

ความคิดเห็นแชตล่าสุดในห้อง LIVE ของครีเอเตอร์ เรียงจากเก่าไปใหม่ สำหรับแผงแชตข้างเครื่องเล่น เรียกทุกไม่กี่วินาทีและส่ง cursor ของคำตอบก่อนหน้าเป็น after เพื่อรับเฉพาะความคิดเห็นที่ใหม่กว่า (สูงสุด 100 รายการต่อคำตอบ หากมีมากกว่านั้นจะได้ 100 รายการล่าสุด) มีความคิดเห็นเฉพาะห้องที่ RoomScope ติดตามและเวิร์กสเปซของคุณติดตาม (watchlist หรือการสมัครห้อง): status: tracked พร้อม roomId มิฉะนั้นเป็น status: not_tracked โดยไม่มีรายการ (followed บอกว่าเวิร์กสเปซติดตามครีเอเตอร์หรือไม่) RoomScope เก็บความคิดเห็น 200 รายการล่าสุดของห้องไว้ 10 นาทีหลังความคิดเห็นสุดท้าย ฟรี (ไม่ใช้เครดิต) จำกัด 60 คำขอต่อนาทีต่อผู้ใช้ (เกินจะได้ 429 พร้อม Retry-After)

สโคปlive:readเครดิตฟรี

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

พารามิเตอร์ใน path · GET /v1/live/creators/{uid}/comments
NameTypeDescription
uidRequired
stringแฮนเดิลของครีเอเตอร์ (linh.live) ระบบจะไม่สนใจ @ ที่นำหน้า

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

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

ดึงประสิทธิภาพ LIVE ของครีเอเตอร์

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

หนึ่งแถวต่อหนึ่งเซสชันที่บันทึกไว้: ระยะเวลา ผู้ชมสูงสุด ของขวัญ เพชร และจำนวนผู้ส่งของขวัญที่ไม่ซ้ำ เฉพาะครีเอเตอร์ในรายการติดตามของ workspace หรือห้องที่สมาชิกติดตาม มิฉะนั้น items จะว่างและ followed เป็น false

สโคปlive:readเครดิตอ่านข้อมูลแคช

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

พารามิเตอร์ใน path · GET /v1/live/creators/{uid}/performance
NameTypeDescription
uidRequired
stringแฮนเดิลของครีเอเตอร์โดยไม่มี @ (linh.live) หรือ user id ของ TikTok ที่เป็นตัวเลข

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

พารามิเตอร์ query · GET /v1/live/creators/{uid}/performance
NameTypeDescription
cursorOptional
stringcursor แบบทึบจาก 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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 402 กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้ resetAt บอกเวลาที่เครดิตจะรีเซ็ต
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตาม Retry-After

ดึงแหล่งวิดีโอ LIVE ของครีเอเตอร์

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

URL วิดีโอที่มีลายเซ็นและมีวันหมดอายุของห้อง LIVE ปัจจุบันของครีเอเตอร์ เพลเยอร์ของคุณโหลดวิดีโอโดยตรงจาก CDN ของ TikTok (source: tiktok-cdn) โดย RoomScope ไม่เคยเป็นตัวกลางส่งต่อวิดีโอ แนะนำให้ใช้ hlsUrl เป็นหลัก ส่วน flvUrl เป็นแหล่งของห้องที่มีเฉพาะ FLV (เล่นด้วยเอนจิน MSE เช่น mpegts.js) เมื่อ status: live จะมีค่าอย่างน้อยหนึ่งรายการ และ expiresAt คือเวลาที่ URL นั้นหยุดทำงาน renditions มักว่างเปล่า avatarUrl, followerCount และ region เป็น null เมื่อไม่ทราบค่า ผลลัพธ์อื่น ๆ: status: offline (ไม่ได้ไลฟ์), status: no_playback (กำลังไลฟ์ แต่ TikTok ไม่เปิดเผยแหล่งที่เล่นได้), 202 status: resolving (เรียก URL เดิมอีกครั้งหลัง Retry-After), 503 collection_saturated หรือ live_playback_upstream_unavailable (ลองใหม่) และ 503 live_playback_not_configured ขณะที่ฟีเจอร์นี้ปิดอยู่ในระบบนี้ (ไม่ต้องลองใหม่) ต้องใช้สโคป live:stream ไม่ใช่ live:read

สโคปlive:streamเครดิตอ่านข้อมูลแคช

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

พารามิเตอร์ใน path · 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 key หรือไม่รู้จัก API key
  • 402 กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้ resetAt บอกเวลาที่เครดิตจะรีเซ็ต
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตาม Retry-After
  • 503 ไม่พร้อมใช้งานชั่วคราว ลองใหม่หลัง Retry-After เมื่อ retryable เป็น true

เข้าคิวรีเฟรชสถานะไลฟ์

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

ขอให้ worker ตรวจสอบทันทีว่าครีเอเตอร์กำลังไลฟ์อยู่หรือไม่ คิดเครดิตตามอัตราการรีเฟรช

สโคปlive:readเครดิตรีเฟรชสถานะไลฟ์

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

พารามิเตอร์ใน path · POST /v1/live/creators/{uid}/refresh
NameTypeDescription
uidRequired
stringแฮนเดิลของครีเอเตอร์โดยไม่มี @ (linh.live) หรือ user id ของ TikTok ที่เป็นตัวเลข

คำขอ

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

ผลลัพธ์

202 รับคำขอแล้ว
{  "queued": true,  "jobId": "1761994604935-0"}

ข้อผิดพลาด

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

แสดงรายการเซสชัน LIVE ที่บันทึกไว้

GET/v1/live/sessions

เซสชันที่ RoomScope บันทึกไว้สำหรับครีเอเตอร์ในรายการติดตามของ workspace และห้องที่สมาชิกติดตาม เรียงจากใหม่ไปเก่า เซสชันของ workspace อื่นจะไม่ปรากฏ เซสชันที่ยังดำเนินอยู่มี endedAt: null

สโคปlive:readเครดิตอ่านข้อมูลแคช

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

พารามิเตอร์ query · GET /v1/live/sessions
NameTypeDescription
creatorUniqueIdOptional
stringเฉพาะเซสชันของครีเอเตอร์คนนี้ (แฮนเดิลโดยไม่มี @)
cursorOptional
stringcursor แบบทึบจาก 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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 402 กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้ resetAt บอกเวลาที่เครดิตจะรีเซ็ต
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตาม Retry-After

ดึงเซสชัน LIVE

GET/v1/live/sessions/{session_id}

หนึ่งเซสชันพร้อมสรุปของขวัญและผู้ส่งของขวัญ เซสชันของครีเอเตอร์หรือห้องที่ workspace ไม่ได้ติดตามจะตอบ 404

สโคปlive:readเครดิตอ่านข้อมูลแคช

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

พารามิเตอร์ใน path · GET /v1/live/sessions/{session_id}
NameTypeDescription
session_idRequired
stringsession id จากรายการ

คำขอ

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

ดึงเซสชัน LIVE ทีละนาที

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

ข้อมูลรายนาทีของเซสชันตั้งแต่เริ่ม: ผู้ชมสูงสุด เหตุการณ์ แชต ถูกใจ ของขวัญ เพชร ผู้ให้ของขวัญรายใหม่ และกล่องสมบัติต่อนาที พร้อม offsetMinutes นับจากเริ่ม เฉพาะห้องที่บันทึกไว้ เซสชันที่บันทึกก่อนมีข้อมูลรายนาทีจะไม่มีนาที (coverageStatus: not-covered) การมองเห็นเหมือนกับตัวเซสชัน

สโคปlive:readเครดิตอ่านข้อมูลแคช

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

พารามิเตอร์ใน path · GET /v1/live/sessions/{session_id}/timeline
NameTypeDescription
session_idRequired
stringsession id จากรายการ

คำขอ

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

เปรียบเทียบเซสชัน LIVE

GET/v1/live/sessions/compare

สองถึงสี่เซสชันเทียบกัน แต่ละเซสชันมียอดรวมและข้อมูลรายนาทีที่จัดเรียงตาม offsetMinutes นับจากจุดเริ่มของตัวเอง เซสชันที่เวิร์กสเปซไม่ได้ติดตามจะได้ 404

สโคปlive:readเครดิตอ่านข้อมูลแคช

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

พารามิเตอร์ query · GET /v1/live/sessions/compare
NameTypeDescription
idsRequired
stringid เซสชันคั่นด้วยจุลภาค 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 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 402 กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้ resetAt บอกเวลาที่เครดิตจะรีเซ็ต
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ (ต่อวินาที ต่อนาที หรือต่อวัน) โปรดทำตาม Retry-After
หน้านี้มีประโยชน์หรือไม่