Referentie · TV's

Een TV opvragen

GET /v1/tvs/{uid}

Geeft een TV op basis van de uid.

Padparameter

Naam	Type	Beschrijving
`uid`	`string`	uid van de TV.

Velden van het antwoord

uid string: ID van de TV, hetzelfde als in het beheerpaneel.
name string: Naam van de TV.
description string: Beschrijving van de TV (kan leeg zijn).
organization object: Organisatie van de TV: uid en name.
playlist object | null: Playlist van de TV (uid en name), of null als er geen is.
status string: online, alert of offline, zoals hieronder uitgelegd.
last_seen_at string | null: Laatste contact van de TV met het platform, of null als de TV nog nooit verbinding heeft gemaakt.
activated_at string | null: Wanneer de TV is geactiveerd.
app_version string: Versie van de app die op de TV is geïnstalleerd.
os string: Besturingssysteem van de TV, zoals android.
device object: Merk (brand) en model (model) van het apparaat, als de TV die doorgeeft.
timezone string | null: Tijdzone van de TV, zoals America/Sao_Paulo, of null.

Zo wordt de status berekend

online contact minder dan 3 minuten geleden, speelt af
alert contact tussen 3 en 9 minuten geleden, of de TV start nog op
offline al 10 minuten of langer geen contact, of nog nooit verbonden

Dit is dezelfde regel als voor de statuskleuren in het beheerpaneel.

Mogelijke fouten

404 not_found Het endpoint bestaat niet, of het item bestaat niet of hoort bij een organisatie die de gebruiker niet kan zien.
Fouten rond de sleutel en de verzoeklimiet gelden voor alle endpoints. Alle fouten bekijken

VerzoekcURLPHPJavaScript

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

Antwoord200

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

Item bestaat niet of geen toegang404

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