Referans · TV yo

Wè yon TV

GET /v1/tvs/{uid}

Montre yon TV dapre uid li.

Paramèt nan adrès la

NonTipDeskripsyon
uidstringuid TV a.

Chan repons lan

uid string
Idantifyan TV a, menm sa yo itilize nan panèl la.
name string
Non TV a.
description string
Deskripsyon TV a (li ka vid).
organization object
Òganizasyon TV a: uid ak name.
playlist object | null
Playlist TV a (uid ak name), oswa null si li pa genyen.
status string
online, alert oswa offline, jan sa eksplike pi ba a.
last_seen_at string | null
Dènye kontak TV a ak platfòm nan, oswa null si li pa janm konekte.
activated_at string | null
Ki lè yo te aktive TV a.
app_version string
Vèsyon aplikasyon ki enstale sou TV a.
os string
Sistèm operasyon TV a, tankou android.
device object
Mak (brand) ak modèl (model) aparèy la, lè TV a bay enfòmasyon sa yo.
timezone string | null
Zòn lè TV a, tankou America/Sao_Paulo, oswa null.

Kijan yo kalkile estati a

  • online dènye kontak gen mwens pase 3 minit, li ap jwe
  • alert dènye kontak ant 3 ak 9 minit de sa, oswa TV a toujou ap demare
  • offline pa gen kontak depi 10 minit oswa plis, oswa li pa janm konekte

Se menm règ ak koulè estati yo nan panèl la.

Erè ki posib

  • 404 not_found Endpoint la pa egziste, oswa eleman an pa egziste oswa li fè pati yon òganizasyon itilizatè a pa ka wè.
  • Erè kle ak erè limit yo aplike pou tout endpoint yo. Wè tout erè yo
Demann
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();
Repons200
{
  "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"
  }
}
Eleman ki pa egziste oswa san aksè404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}