Reference · TV

Seznam TV

GET /v1/tvs

Vypíše v abecedním pořadí aktivované TV z organizací, ve kterých uživatel může vidět TV.

Stránkovaná odpověď: položky přicházejí v data a informace o stránce v meta. Stránkování a filtry

Parametry

Název	Typ	Popis
`organization`	`string`	uid organizace, pokud chcete jen její položky (viz `/organizations`).
`q`	`string`	Část názvu, nejvýše 100 znaků.
`page`	`integer`	Stránka, počínaje 1. Výchozí hodnota: 1.
`per_page`	`integer`	Počet položek na stránku, od 1 do 100. Výchozí hodnota: 50.

Pole každé položky

uid string: Identifikátor TV, stejný jako v ovládacím panelu.
name string: Název TV.
description string: Popis TV (může být prázdný).
organization object: Organizace TV: uid a name.
playlist object | null: Playlist TV (uid a name), nebo null, pokud žádný nemá.
status string: online, alert nebo offline, jak je vysvětleno níže.
last_seen_at string | null: Poslední spojení TV s platformou, nebo null, pokud se TV nikdy nepřipojila.
activated_at string | null: Kdy byla TV aktivována.
app_version string: Verze aplikace nainstalované v TV.
os string: Operační systém TV, například android.
device object: Značka (brand) a model (model) zařízení, pokud je TV hlásí.
timezone string | null: Časové pásmo TV, například America/Sao_Paulo, nebo null.

Jak se počítá stav

online spojení před méně než 3 minutami, přehrává
alert spojení před 3 až 9 minutami, nebo se TV teprve spouští
offline bez spojení 10 minut nebo déle, nebo se nikdy nepřipojila

Jde o stejné pravidlo jako u barev stavu v ovládacím panelu.

Možné chyby

400 invalid_parameter Parametr má neplatnou hodnotu, například per_page nad povoleným maximem.
404 organization_not_found Zadaný parametr organization neodpovídá organizaci, ve které uživatel může vidět tento typ položek.
Chyby klíče a limitu platí pro všechny endpointy. Zobrazit všechny chyby

PožadavekcURLPHPJavaScript

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

Odpověď200

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