參考資料 · 電視

查看電視

GET /v1/tvs/{uid}

按 uid 傳回一部電視。

路徑參數

名稱類型說明
uidstring電視的 uid。

回應欄位

uid string
電視識別碼,與控制台使用的相同。
name string
電視名稱。
description string
電視描述(可能留空)。
organization object
電視所屬的公司:uid 及 name。
playlist object | null
電視的播放清單(uid 及 name);如沒有,則為 null。
status string
online、alert 或 offline,詳見下文說明。
last_seen_at string | null
電視最近一次與平台通訊的時間;如從未連線,則為 null。
activated_at string | null
電視的啟用時間。
app_version string
電視上安裝的應用程式版本。
os string
電視的作業系統,例如 android。
device object
裝置品牌(brand)及型號(model),只在電視有提供時顯示。
timezone string | null
電視的時區,例如 America/Sao_Paulo,或 null。

狀態的計算方式

  • online 最近 3 分鐘內有通訊,正在播放
  • alert 最近一次通訊在 3 至 9 分鐘前,或電視仍在啟動中
  • offline 10 分鐘或以上沒有通訊,或從未連線

規則與控制台的狀態顏色相同。

可能出現的錯誤

  • 404 not_found 端點不存在,或項目不存在,或項目屬於該用戶無權查看的公司。
  • 金鑰錯誤及次數限制錯誤適用於所有端點。 查看所有錯誤
請求
curl "https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c" \
  -H "X-API-Key: $API_KEY"
<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);
const res = await fetch('https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();
回應200
{
  "data": {
    "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
    "name": "Recepção",
    "description": "TV da entrada",
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "playlist": {
      "uid": "e4da3b7fbbce2345d7772b0674a318d5",
      "name": "Lista principal"
    },
    "status": "online",
    "last_seen_at": "2026-11-03T14:32:10-03:00",
    "activated_at": "2025-03-12T09:41:05-03:00",
    "app_version": "3.12.84",
    "os": "android",
    "device": {
      "brand": "TCL",
      "model": "43P635"
    },
    "timezone": "America/Sao_Paulo"
  }
}
項目不存在或沒有存取權限404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}