Referință · TV-uri

Detaliile unui TV

GET /v1/tvs/{uid}

Returnează un TV după uid.

Parametru în cale

Nume	Tip	Descriere
`uid`	`string`	uid-ul TV-ului.

Câmpurile răspunsului

uid string: Identificatorul TV-ului, același folosit în panoul de control.
name string: Numele TV-ului.
description string: Descrierea TV-ului (poate fi goală).
organization object: Organizația TV-ului: uid și name.
playlist object | null: Playlistul TV-ului (uid și name) sau null dacă nu există.
status string: online, alert sau offline, după cum se explică mai jos.
last_seen_at string | null: Ultimul contact al TV-ului cu platforma sau null dacă nu s-a conectat niciodată.
activated_at string | null: Când a fost activat TV-ul.
app_version string: Versiunea aplicației instalate pe TV.
os string: Sistemul de operare al TV-ului, de exemplu android.
device object: Marca (brand) și modelul (model) dispozitivului, când TV-ul le raportează.
timezone string | null: Fusul orar al TV-ului, de exemplu America/Sao_Paulo, sau null.

Cum se calculează starea

online contact acum mai puțin de 3 minute, în redare
alert ultimul contact acum 3–9 minute sau TV-ul încă pornește
offline fără contact de 10 minute sau mai mult ori nu s-a conectat niciodată

Este aceeași regulă ca pentru culorile de stare din panoul de control.

Erori posibile

404 not_found Endpointul nu există sau elementul nu există ori aparține unei organizații pe care utilizatorul nu o poate vedea.
Erorile de cheie și de limită se aplică tuturor endpointurilor. Vedeți toate erorile

CererecURLPHPJavaScript

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

Răspuns200

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

Element inexistent sau fără acces404

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