RoomScope

Son güncelleme

LIVE

Kaydedilen LIVE oturumları, içerik üreticisi bazında performans ve LIVE video kaynağı.

Her işlemde kimlik doğrulama bir API anahtarıyla yapılır (Authorization: Bearer <key>) ve hatalar şu sayfada açıklanan ortak zarfı kullanır: Hatalar. API’nin OpenAPI belgesinden üretilmiştir.

Bir içerik üreticisinin LIVE performansını alma

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

Kaydedilen her oturum için bir satır: süre, en yüksek izleyici, hediyeler, elmaslar ve farklı hediye gönderenler.

Kapsamlive:readKredilerÖnbellekten okuma

Yol parametreleri

Yol parametreleri · GET /v1/live/creators/{uid}/performance
NameTypeDescription
uidRequired
string@ olmadan içerik üreticisi kullanıcı adı (linh.live) veya sayısal TikTok kullanıcı kimliği.

Sorgu parametreleri

Sorgu parametreleri · GET /v1/live/creators/{uid}/performance
NameTypeDescription
cursorOptional
stringÖnceki sayfanın nextCursor değerinden alınan opak cursor.
limitOptional
integerSayfa başına satır sayısı. Aralık 1–100.
Default: 50

İstek

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

Yanıt

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  },  "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  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 402 Çalışma alanının kredi cüzdanı çağrıyı karşılayamıyor; kredilerin ne zaman sıfırlanacağını resetAt belirtir.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.

Bir içerik üreticisinin LIVE video kaynağını alma

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

İçerik üreticisinin mevcut LIVE odasının imzalı ve süresi dolan video URL’si. Oynatıcınız onu doğrudan TikTok’un CDN’inden yükler (source: tiktok-cdn); RoomScope videoyu asla proxy üzerinden aktarmaz. hlsUrl tercih edilir; flvUrl, yalnızca FLV sunan odaların kaynağıdır (mpegts.js gibi bir MSE motoruyla oynatın); status: live durumunda en az biri doludur ve expiresAt, o URL’nin çalışmayı bıraktığı zamandır. renditions çoğu zaman boştur. avatarUrl, followerCount ve region bilinmediğinde null olur. Diğer yanıtlar: status: offline (yayında değil), status: no_playback (yayında, ancak TikTok oynatılabilir bir kaynak sunmuyor), 202 status: resolving (Retry-After sonrasında aynı URL’yi yeniden yoklayın), 503 collection_saturated veya live_playback_upstream_unavailable (yeniden deneyin) ve özellik bu kurulumda kapalıyken 503 live_playback_not_configured (yeniden denemeyin). live:read değil, live:stream kapsamı gerekir.

Kapsamlive:streamKredilerÖnbellekten okuma

Yol parametreleri

Yol parametreleri · GET /v1/live/creators/{uid}/playback
NameTypeDescription
uidRequired
stringİçerik üreticisinin kullanıcı adı (linh.live); baştaki @ yok sayılır.

İstek

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

Yanıt

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}

Hatalar

  • 401 Eksik veya bilinmeyen API anahtarı.
  • 402 Çalışma alanının kredi cüzdanı çağrıyı karşılayamıyor; kredilerin ne zaman sıfırlanacağını resetAt belirtir.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.
  • 503 Geçici olarak kullanılamıyor; retryable true olduğunda Retry-After sonrasında yeniden deneyin.

Canlı durum yenilemesini kuyruğa alma

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

Worker’lardan içerik üreticisinin yayında olup olmadığını hemen kontrol etmelerini ister. Yenileme ücretiyle faturalandırılır.

Kapsamlive:readKredilerCanlı yenileme

Yol parametreleri

Yol parametreleri · POST /v1/live/creators/{uid}/refresh
NameTypeDescription
uidRequired
string@ olmadan içerik üreticisi kullanıcı adı (linh.live) veya sayısal TikTok kullanıcı kimliği.

İstek

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

Yanıt

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

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 402 Çalışma alanının kredi cüzdanı çağrıyı karşılayamıyor; kredilerin ne zaman sıfırlanacağını resetAt belirtir.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.

Kaydedilen LIVE oturumlarını listeleme

GET/v1/live/sessions

RoomScope’un çalışma alanının içerik üreticileri için kaydettiği oturumlar, en yeniden eskiye. Hâlâ süren bir oturumda endedAt: null olur.

Kapsamlive:readKredilerÖnbellekten okuma

Sorgu parametreleri

Sorgu parametreleri · GET /v1/live/sessions
NameTypeDescription
creatorUniqueIdOptional
stringYalnızca bu içerik üreticisinin oturumları (@ olmadan kullanıcı adı).
cursorOptional
stringÖnceki sayfanın nextCursor değerinden alınan opak cursor.
limitOptional
integerSayfa başına oturum sayısı. Aralık 1–100.
Default: 50

İstek

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

Yanıt

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  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 402 Çalışma alanının kredi cüzdanı çağrıyı karşılayamıyor; kredilerin ne zaman sıfırlanacağını resetAt belirtir.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.

Bir LIVE oturumunu alma

GET/v1/live/sessions/{session_id}

Hediye ve hediye gönderen özetleriyle tek bir oturum.

Kapsamlive:readKredilerÖnbellekten okuma

Yol parametreleri

Yol parametreleri · GET /v1/live/sessions/{session_id}
NameTypeDescription
session_idRequired
stringListedeki oturum kimliği.

İstek

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

Yanıt

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  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 402 Çalışma alanının kredi cüzdanı çağrıyı karşılayamıyor; kredilerin ne zaman sıfırlanacağını resetAt belirtir.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.
Bu sayfa işinize yaradı mı?