레퍼런스 · TV
TV 상세 조회
GET
/v1/tvs/{uid}
uid로 TV 한 대를 조회합니다.
경로 매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
uid | string | TV의 uid. |
응답 필드
uidstring- TV 식별자로, 관리 패널에서 사용하는 것과 같습니다.
namestring- TV 이름.
descriptionstring- TV 설명(비어 있을 수 있음).
organizationobject- TV가 속한 회사:
uid및name. playlistobject | null- TV의 재생목록(
uid및name). 없으면null. statusstringonline,alert또는offline. 자세한 내용은 아래 설명을 참고하세요.last_seen_atstring | null- TV가 플랫폼과 마지막으로 통신한 시각. 한 번도 연결된 적이 없으면
null. activated_atstring | null- TV가 활성화된 시각.
app_versionstring- TV에 설치된 앱 버전.
osstring- TV 운영체제(예:
android). deviceobject- 기기 브랜드(
brand)와 모델(model). TV가 정보를 보고한 경우에만 제공됩니다. timezonestring | null- TV 시간대(예:
America/Sao_Paulo) 또는null.
상태 계산 방식
online3분 이내에 통신했으며 재생 중alert마지막 통신이 3~9분 전이거나 TV가 아직 시작 중offline10분 이상 통신이 없거나 한 번도 연결된 적 없음
관리 패널의 상태 색상과 같은 규칙입니다.
발생 가능한 오류
- 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."
}
}