Referencia · TVs

Ver una TV

GET /v1/tvs/{uid}

Devuelve una TV a partir de su uid.

Parámetro de ruta

Nombre	Tipo	Descripción
`uid`	`string`	uid de la TV.

Campos de la respuesta

uid string: Identificador de la TV, el mismo que se usa en el panel.
name string: Nombre de la TV.
description string: Descripción de la TV (puede estar vacía).
organization object: Organización de la TV: uid y name.
playlist object | null: Lista de reproducción de la TV (uid y name), o null si no tiene ninguna.
status string: online, alert u offline, como se explica más abajo.
last_seen_at string | null: Último contacto de la TV con la plataforma, o null si nunca se conectó.
activated_at string | null: Cuándo se activó la TV.
app_version string: Versión de la aplicación instalada en la TV.
os string: Sistema operativo de la TV, como android.
device object: Marca (brand) y modelo (model) del dispositivo, cuando la TV los informa.
timezone string | null: Zona horaria de la TV, como America/Sao_Paulo, o null.

Cómo se calcula el estado

online último contacto hace menos de 3 minutos, reproduciendo
alert último contacto hace entre 3 y 9 minutos, o la TV todavía se está iniciando
offline sin contacto desde hace 10 minutos o más, o nunca se conectó

Es la misma regla que usan los colores de estado del panel.

Errores posibles

404 not_found El endpoint no existe, o bien el elemento no existe o pertenece a una organización que el usuario no puede ver.
Los errores de clave y de límite valen para todos los endpoints. Ver todos los errores

SolicitudcURLPHPJavaScript

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();

Respuesta200

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

Elemento inexistente o sin acceso404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}