リファレンス · TV

TVを取得

GET /v1/tvs/{uid}

uidを指定して、TVを1台取得します。

パスパラメーター

名前	型	説明
`uid`	`string`	TVのuid。

レスポンスのフィールド

uid string: TVの識別子で、コントロールパネルで使われているものと同じです。
name string: TVの名前。
description string: TVの説明（空の場合もあります）。
organization object: TVが属する組織：uidとname。
playlist object | null: TVのプレイリスト（uidとname）。ない場合はnull。
status string: online、alert、offlineのいずれか。詳しくは下記をご覧ください。
last_seen_at string | null: TVがプラットフォームと最後に通信した日時。一度も接続したことがない場合はnull。
activated_at string | null: TVが有効化された日時。
app_version string: TVにインストールされているアプリのバージョン。
os string: TVのOS（androidなど）。
device object: デバイスのブランド（brand）とモデル（model）。TVから報告された場合のみ。
timezone string | null: TVのタイムゾーン（America/Sao_Pauloなど）、またはnull。

ステータスの判定方法

online 3分以内に通信があり、再生中
alert 最後の通信が3～9分前、またはTVが起動中
offline 10分以上通信がない、または一度も接続していない

コントロールパネルのステータスの色と同じルールです。

発生しうるエラー

404 not_found エンドポイントが存在しないか、項目が存在しないか、ユーザーが参照できない組織の項目です。
キーとレート制限に関するエラーは、すべてのエンドポイントに共通です。すべてのエラーを見る

リクエストcURLPHPJavaScript

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