Riferimento · TV

Visualizza una TV

GET /v1/tvs/{uid}

Restituisce una TV tramite il suo uid.

Parametro nel percorso

Nome	Tipo	Descrizione
`uid`	`string`	uid della TV.

Campi della risposta

uid string: Identificativo della TV, lo stesso usato nel pannello di controllo.
name string: Nome della TV.
description string: Descrizione della TV (può essere vuota).
organization object: Organizzazione della TV: uid e name.
playlist object | null: Playlist della TV (uid e name), oppure null se non ce n'è una.
status string: online, alert o offline, come spiegato di seguito.
last_seen_at string | null: Ultimo contatto della TV con la piattaforma, oppure null se non si è mai connessa.
activated_at string | null: Quando è stata attivata la TV.
app_version string: Versione dell'app installata sulla TV.
os string: Sistema operativo della TV, ad esempio android.
device object: Marca (brand) e modello (model) del dispositivo, quando la TV li comunica.
timezone string | null: Fuso orario della TV, ad esempio America/Sao_Paulo, oppure null.

Come viene calcolato lo stato

online contatto meno di 3 minuti fa, in riproduzione
alert contatto tra 3 e 9 minuti fa, oppure TV ancora in fase di avvio
offline nessun contatto da 10 minuti o più, oppure mai connessa

È la stessa regola dei colori di stato del pannello di controllo.

Errori possibili

404 not_found L'endpoint non esiste, oppure l'elemento non esiste o appartiene a un'organizzazione che l'utente non può vedere.
Gli errori relativi alla chiave e al limite valgono per tutti gli endpoint. Vedi tutti gli errori

RichiestacURLPHPJavaScript

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

Risposta200

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

Elemento inesistente o senza accesso404

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