Referans · TV'ler

TV'leri listele

GET /v1/tvs

Kullanıcının TV'leri görebildiği kuruluşlardaki etkinleştirilmiş TV'leri alfabetik sırayla listeler.

Sayfalanmış yanıt: öğeler data içinde, sayfa bilgileri ise meta içinde gelir. Sayfalama ve filtreler

Parametreler

Ad	Tür	Açıklama
`organization`	`string`	Yalnızca o kuruluşun öğelerini getirmek için bir kuruluşun uid değeri (bkz. `/organizations`).
`q`	`string`	Adın bir kısmı, en fazla 100 karakter.
`page`	`integer`	Sayfa numarası, 1'den başlar. Varsayılan: 1.
`per_page`	`integer`	Sayfa başına öğe sayısı, 1 ile 100 arasında. Varsayılan: 50.

Her öğenin 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

400 invalid_parameter Bir parametrenin değeri geçersiz, ör. per_page izin verilen en yüksek değerin üzerinde.
404 organization_not_found Belirtilen organization, kullanıcının bu tür öğeleri görebildiği bir kuruluşa ait değil.
Anahtar ve limit hataları tüm uç noktalar için geçerlidir. Tüm hataları görün

İstekcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/tvs?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs?per_page=2');
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?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Yanıt200

{
  "data": [
    {
      "uid": "d3d9446802a44259755d38e6d163e820",
      "name": "Caixa 2",
      "description": "",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "playlist": null,
      "status": "offline",
      "last_seen_at": "2026-11-01T18:04:51-03:00",
      "activated_at": "2025-03-12T09:41:05-03:00",
      "app_version": "3.12.83",
      "os": "android",
      "device": {
        "brand": "Philco",
        "model": "PTV32G70"
      },
      "timezone": "America/Sao_Paulo"
    },
    {
      "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"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}