Referencia · TV-k

TV lekérése

GET /v1/tvs/{uid}

Visszaadja egy TV adatait uid alapján.

Útvonalparaméter

Név	Típus	Leírás
`uid`	`string`	A TV uid azonosítója.

A válasz 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

404 not_found A végpont nem létezik, vagy az elem nem létezik, illetve olyan szervezethez tartozik, amelyet a felhasználó nem láthat.
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/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();

Válasz200

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

Nem létező vagy nem elérhető elem404

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