Referência · TVs

Listar TVs

GET /v1/tvs

Lista as TVs ativadas das empresas em que o usuário pode ver TVs, em ordem alfabética.

Resposta paginada: os itens vêm em data e as informações da página, em meta. Paginação e filtros

Parâmetros

Nome	Tipo	Descrição
`organization`	`string`	uid de uma empresa, para trazer só os itens dela (veja `/organizations`).
`q`	`string`	Parte do nome, com até 100 caracteres.
`page`	`integer`	Página, a partir de 1. Padrão: 1.
`per_page`	`integer`	Itens por página, de 1 a 100. Padrão: 50.

Campos de cada item

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

400 invalid_parameter Um parâmetro tem valor inválido, como per_page acima do máximo.
404 organization_not_found O organization informado não é de uma empresa em que o usuário pode ver esse tipo de item.
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?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs?per_page=2');
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?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Resposta200

{
  "data": [
    {
      "uid": "d3d9446802a44259755d38e6d163e820",
      "name": "Caixa 2",
      "description": "",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "playlist": null,
      "status": "offline",
      "last_seen_at": "2026-11-01T18:04:51-03:00",
      "activated_at": "2025-03-12T09:41:05-03:00",
      "app_version": "3.12.83",
      "os": "android",
      "device": {
        "brand": "Philco",
        "model": "PTV32G70"
      },
      "timezone": "America/Sao_Paulo"
    },
    {
      "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"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}