Arayış · TV-lər

TV-yə baxış

GET /v1/tvs/{uid}

TV-ni uid üzrə qaytarır.

Yol parametri

Ad	Növ	Təsvir
`uid`	`string`	TV-nin uid identifikatoru.

Cavab sahələri

uid string: TV identifikatoru, idarəetmə panelində istifadə olunanla eynidir.
name string: TV-nin adı.
description string: TV-nin təsviri (boş ola bilər).
organization object: TV-nin şirkəti: uid və name.
playlist object | null: TV-nin pleylisti (uid və name) və ya pleylist yoxdursa, null.
status string: Aşağıda izah edildiyi kimi online, alert və ya offline.
last_seen_at string | null: TV-nin platforma ilə son əlaqəsi və ya TV heç vaxt qoşulmayıbsa, null.
activated_at string | null: TV-nin aktivləşdirildiyi vaxt.
app_version string: TV-də quraşdırılmış tətbiqin versiyası.
os string: TV-nin əməliyyat sistemi, məsələn, android.
device object: TV bu məlumatı ötürürsə, cihazın markası (brand) və modeli (model).
timezone string | null: TV-nin saat qurşağı, məsələn, America/Sao_Paulo, və ya null.

Status necə hesablanır

online son əlaqə 3 dəqiqədən az əvvəl olub, yayım gedir
alert son əlaqə 3–9 dəqiqə əvvəl olub və ya TV hələ işə düşür
offline 10 dəqiqə və ya daha çoxdur ki, əlaqə yoxdur, ya da TV heç vaxt qoşulmayıb

Bu, idarəetmə panelindəki status rənglərinin qaydası ilə eynidir.

Mümkün xətalar

404 not_found Endpoint mövcud deyil, ya da element mövcud deyil və ya istifadəçinin görə bilmədiyi şirkətə aiddir.
Açar və limit xətaları bütün endpointlərə aiddir. Bütün xətalara bax

SorğucURLPHPJavaScript

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

Cavab200

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

Mövcud olmayan və ya girişi olmayan element404

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