Referência · TVs

Ver uma TV

GET /v1/tvs/{uid}

Mostra uma TV pelo uid.

Parâmetro no endereço

Nome	Tipo	Descrição
`uid`	`string`	uid da TV.

Campos da resposta

uid string: Identificador da TV, o mesmo usado no painel.
name string: Nome da TV.
description string: Descrição da TV (pode ser vazia).
organization object: Empresa da TV: uid e name.
playlist object | null: Lista de reprodução da TV (uid e name), ou null se não houver.
status string: online, alert ou offline, como explicado abaixo.
last_seen_at string | null: Último contato da TV com a plataforma, ou null se ela nunca se conectou.
activated_at string | null: Quando a TV foi ativada.
app_version string: Versão do aplicativo instalado na TV.
os string: Sistema da TV, como android.
device object: Marca (brand) e modelo (model) do aparelho, quando a TV informa.
timezone string | null: Fuso horário da TV, como America/Sao_Paulo, ou null.

Como o status é calculado

online contato há menos de 3 minutos, reproduzindo
alert contato entre 3 e 9 minutos atrás, ou TV ainda iniciando
offline sem contato há 10 minutos ou mais, ou nunca se conectou

É a mesma regra das cores de status do painel.

Erros possíveis

404 not_found O endpoint não existe, ou o item não existe ou é de uma empresa que o usuário não pode ver.
Os erros de chave e de limite valem para todos os endpoints. Ver todos os erros

RequisiçãocURLPHPJavaScript

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

Item que não existe ou sem acesso404

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