Referencia · TV

Zoznam TV

GET /v1/tvs

Vypíše v abecednom poradí aktivované TV z organizácií, v ktorých môže používateľ vidieť TV.

Stránkovaná odpoveď: položky prichádzajú v data a informácie o stránke v meta. Stránkovanie a filtre

Parametre

Názov	Typ	Popis
`organization`	`string`	uid organizácie, ak chcete iba jej položky (pozri `/organizations`).
`q`	`string`	Časť názvu, najviac 100 znakov.
`page`	`integer`	Stránka, od 1. Predvolená hodnota: 1.
`per_page`	`integer`	Počet položiek na stránku, od 1 do 100. Predvolená hodnota: 50.

Polia každej položky

uid string: Identifikátor TV, rovnaký ako v ovládacom paneli.
name string: Názov TV.
description string: Popis TV (môže byť prázdny).
organization object: Organizácia TV: uid a name.
playlist object | null: Playlist TV (uid a name), alebo null, ak žiadny nemá.
status string: online, alert alebo offline, ako je vysvetlené nižšie.
last_seen_at string | null: Posledné spojenie TV s platformou, alebo null, ak sa TV nikdy nepripojila.
activated_at string | null: Kedy bola TV aktivovaná.
app_version string: Verzia aplikácie nainštalovanej v TV.
os string: Operačný systém TV, napríklad android.
device object: Značka (brand) a model (model) zariadenia, ak ich TV hlási.
timezone string | null: Časové pásmo TV, napríklad America/Sao_Paulo, alebo null.

Ako sa počíta stav

online spojenie pred menej ako 3 minútami, prehráva
alert spojenie pred 3 až 9 minútami, alebo sa TV ešte spúšťa
offline bez spojenia 10 minút alebo dlhšie, alebo sa nikdy nepripojila

Ide o rovnaké pravidlo ako pri farbách stavu v ovládacom paneli.

Možné chyby

400 invalid_parameter Parameter má neplatnú hodnotu, napríklad per_page nad povoleným maximom.
404 organization_not_found Zadaný parameter organization nezodpovedá organizácii, v ktorej môže používateľ vidieť tento typ položiek.
Chyby kľúča a limitu platia pre všetky endpointy. Zobraziť všetky chyby

PožiadavkacURLPHPJavaScript

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

Odpoveď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
  }
}