Reference · TV'er

Hent ét TV

GET /v1/tvs/{uid}

Viser et TV ud fra dets uid.

Stiparameter

Navn	Type	Beskrivelse
`uid`	`string`	uid for TV'et.

Felter i svaret

uid string: TV'ets id, det samme som bruges i kontrolpanelet.
name string: TV'ets navn.
description string: TV'ets beskrivelse (kan være tom).
organization object: TV'ets organisation: uid og name.
playlist object | null: TV'ets playliste (uid og name) eller null, hvis der ikke er nogen.
status string: online, alert eller offline som forklaret nedenfor.
last_seen_at string | null: TV'ets seneste kontakt med platformen eller null, hvis det aldrig har været forbundet.
activated_at string | null: Hvornår TV'et blev aktiveret.
app_version string: Version af den app, der er installeret på TV'et.
os string: TV'ets operativsystem, f.eks. android.
device object: Enhedens mærke (brand) og model (model), når TV'et oplyser dem.
timezone string | null: TV'ets tidszone, f.eks. America/Sao_Paulo, eller null.

Sådan beregnes status

online kontakt for under 3 minutter siden, afspiller
alert kontakt for mellem 3 og 9 minutter siden, eller TV'et er stadig ved at starte op
offline ingen kontakt i 10 minutter eller mere, eller aldrig forbundet

Det er den samme regel som for statusfarverne i kontrolpanelet.

Mulige fejl

404 not_found Endpointet findes ikke, eller elementet findes ikke eller tilhører en organisation, som brugeren ikke kan se.
Fejl vedrørende nøgle og grænser gælder for alle endpoints. Se alle fejl

ForespørgselcURLPHPJavaScript

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

Svar200

{
  "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, der ikke findes eller ikke er adgang til404

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