Referencia · TV-k

TV-k listázása

GET /v1/tvs

Ábécérendben listázza azoknak a szervezeteknek az aktivált TV-it, amelyekben a felhasználó láthatja a TV-ket.

Lapozott válasz: az elemek a data, a lap adatai a meta mezőben érkeznek. Lapozás és szűrők

Paraméterek

Név	Típus	Leírás
`organization`	`string`	Egy szervezet uid azonosítója, ha csak annak elemeit szeretné lekérni (lásd: `/organizations`).
`q`	`string`	A név egy része, legfeljebb 100 karakter.
`page`	`integer`	Oldalszám, 1-től kezdve. Alapértelmezés: 1.
`per_page`	`integer`	Elemek száma oldalanként, 1 és 100 között. Alapértelmezés: 50.

Az egyes elemek mezői

uid string: A TV azonosítója, ugyanaz, mint a vezérlőpulton.
name string: A TV neve.
description string: A TV leírása (lehet üres).
organization object: A TV szervezete: uid és name.
playlist object | null: A TV lejátszási listája (uid és name), vagy null, ha nincs.
status string: online, alert vagy offline, lásd lent.
last_seen_at string | null: A TV utolsó kapcsolata a platformmal, vagy null, ha még soha nem csatlakozott.
activated_at string | null: A TV aktiválásának időpontja.
app_version string: A TV-re telepített alkalmazás verziója.
os string: A TV operációs rendszere, például android.
device object: A készülék márkája (brand) és típusa (model), ha a TV megadja.
timezone string | null: A TV időzónája, például America/Sao_Paulo, vagy null.

Hogyan számítjuk az állapotot

online kevesebb mint 3 perce volt kapcsolat, lejátszás folyamatban
alert 3–9 perce volt az utolsó kapcsolat, vagy a TV még indul
offline legalább 10 perce nincs kapcsolat, vagy soha nem csatlakozott

Ugyanaz a szabály, mint a vezérlőpult állapotszíneinél.

Lehetséges hibák

400 invalid_parameter Egy paraméter értéke érvénytelen, például a per_page meghaladja a maximumot.
404 organization_not_found A megadott organization nem olyan szervezet, amelyben a felhasználó láthatja az ilyen típusú elemeket.
A kulccsal és a kéréskorláttal kapcsolatos hibák minden végpontra vonatkoznak. Az összes hiba megtekintése

KéréscURLPHPJavaScript

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

Válasz200

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