Arayış · TV-lər

TV-lərin siyahısı

GET /v1/tvs

İstifadəçinin TV-ləri görə bildiyi şirkətlərin aktivləşdirilmiş TV-lərini əlifba sırası ilə siyahıya alır.

Səhifələrə bölünmüş cavab: elementlər data daxilində, səhifə məlumatları isə meta daxilində gəlir. Səhifələmə və filtrlər

Parametrlər

Ad	Növ	Təsvir
`organization`	`string`	Yalnız həmin şirkətin elementlərini qaytarmaq üçün şirkətin uid identifikatoru (bax: `/organizations`).
`q`	`string`	Adın bir hissəsi, ən çoxu 100 simvol.
`page`	`integer`	Səhifə nömrəsi, 1-dən başlayır. Standart: 1.
`per_page`	`integer`	Səhifədəki element sayı, 1 ilə 100 arasında. Standart: 50.

Hər elementin 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

400 invalid_parameter Parametrin dəyəri yanlışdır, məsələn, per_page maksimumdan böyükdür.
404 organization_not_found Göstərilən organization istifadəçinin bu növ elementləri görə bildiyi şirkətə aid deyil.
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?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();

Cavab200

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