Referans · TV'ler

Bir TV'yi görüntüle

GET /v1/tvs/{uid}

Bir TV'yi uid değerine göre döndürür.

Yol parametresi

AdTürAçıklama
uidstringTV'nin uid değeri.

Yanıt alanları

uid string
TV tanımlayıcısı; kontrol panelinde kullanılanla aynıdır.
name string
TV'nin adı.
description string
TV'nin açıklaması (boş olabilir).
organization object
TV'nin kuruluşu: uid ve name.
playlist object | null
TV'nin oynatma listesi (uid ve name) veya liste yoksa null.
status string
Aşağıda açıklandığı gibi online, alert veya offline.
last_seen_at string | null
TV'nin platformla son iletişimi veya TV hiç bağlanmadıysa null.
activated_at string | null
TV'nin etkinleştirildiği zaman.
app_version string
TV'de yüklü uygulamanın sürümü.
os string
TV'nin işletim sistemi, ör. android.
device object
TV bu bilgiyi bildiriyorsa cihazın markası (brand) ve modeli (model).
timezone string | null
TV'nin saat dilimi, ör. America/Sao_Paulo, veya null.

Durum nasıl hesaplanır

  • online son iletişim 3 dakikadan kısa süre önce, oynatma devam ediyor
  • alert son iletişim 3 ile 9 dakika önce ya da TV hâlâ başlatılıyor
  • offline 10 dakika veya daha uzun süredir iletişim yok ya da TV hiç bağlanmadı

Kontrol panelindeki durum renkleriyle aynı kural kullanılır.

Olası hatalar

  • 404 not_found Uç nokta mevcut değil ya da öğe mevcut değil veya kullanıcının göremediği bir kuruluşa ait.
  • Anahtar ve limit hataları tüm uç noktalar için geçerlidir. Tüm hataları görün
İstek
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();
Yanıt200
{
  "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"
  }
}
Mevcut olmayan veya erişim izni olmayan öğe404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}