Referencia · TV

Ver unha TV

GET /v1/tvs/{uid}

Devolve unha TV a partir do seu uid.

Parámetro da ruta

Nome	Tipo	Descrición
`uid`	`string`	uid da TV.

Campos da resposta

uid string: Identificador da TV, o mesmo que se usa no panel.
name string: Nome da TV.
description string: Descrición da TV (pode estar baleira).
organization object: Organización da TV: uid e name.
playlist object | null: Lista de reprodución da TV (uid e name), ou null se non ten ningunha.
status string: online, alert ou offline, tal como se explica máis abaixo.
last_seen_at string | null: Último contacto da TV coa plataforma, ou null se nunca se conectou.
activated_at string | null: Cando se activou a TV.
app_version string: Versión da aplicación instalada na TV.
os string: Sistema operativo da TV, como android.
device object: Marca (brand) e modelo (model) do dispositivo, cando a TV os comunica.
timezone string | null: Fuso horario da TV, como America/Sao_Paulo, ou null.

Como se calcula o estado

online último contacto hai menos de 3 minutos e en reprodución
alert último contacto hai entre 3 e 9 minutos, ou a TV aínda se está a iniciar
offline sen contacto desde hai 10 minutos ou máis, ou nunca se conectou

É a mesma regra que seguen as cores de estado do panel.

Erros posibles

404 not_found O endpoint non existe, ou ben o elemento non existe ou pertence a unha organización que o usuario non pode ver.
Os erros de chave e de límite aplícanse a todos os endpoints. Ver todos os erros

SolicitudecURLPHPJavaScript

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

Resposta200

{
  "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 ou sen acceso404

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