Riferimento · TV

Elenca le TV

GET /v1/tvs

Elenca le TV attivate delle organizzazioni in cui l'utente può vedere le TV, in ordine alfabetico.

Risposta paginata: gli elementi arrivano in data e le informazioni sulla pagina in meta. Paginazione e filtri

Parametri

Nome	Tipo	Descrizione
`organization`	`string`	uid di un'organizzazione, per restituire solo i suoi elementi (vedi `/organizations`).
`q`	`string`	Parte del nome, fino a 100 caratteri.
`page`	`integer`	Pagina, a partire da 1. Predefinito: 1.
`per_page`	`integer`	Elementi per pagina, da 1 a 100. Predefinito: 50.

Campi di ogni elemento

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

400 invalid_parameter Un parametro ha un valore non valido, ad esempio per_page oltre il massimo.
404 organization_not_found Il valore di organization indicato non corrisponde a un'organizzazione in cui l'utente può vedere questo tipo di elemento.
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?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();

Risposta200

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