Анықтамалық · Теледидарлар

Теледидарларды тізімдеу

GET /v1/tvs

Пайдаланушы теледидарларды көре алатын ұйымдардағы белсендірілген теледидарларды әліпби бойынша тізімдейді.

Беттерге бөлінген жауап: элементтер data ішінде, ал бет туралы мәліметтер meta ішінде келеді. Беттеу және сүзгілер

Параметрлер

Атауы	Түрі	Сипаттамасы
`organization`	`string`	Тек сол ұйымның элементтерін алу үшін ұйымның uid идентификаторы (`/organizations` қараңыз).
`q`	`string`	Атаудың бір бөлігі, ең көбі 100 таңба.
`page`	`integer`	Бет нөмірі, 1-ден басталады. Әдепкі: 1.
`per_page`	`integer`	Бір беттегі элементтер саны, 1–100 аралығында. Әдепкі: 50.

Әр элементтің өрістері

uid string: Теледидар идентификаторы, басқару панеліндегімен бірдей.
name string: Теледидардың атауы.
description string: Теледидардың сипаттамасы (бос болуы мүмкін).
organization object: Теледидардың ұйымы: uid және name.
playlist object | null: Теледидардың ойнату тізімі (uid және name) немесе тізім болмаса, null.
status string: Төменде түсіндірілгендей online, alert немесе offline.
last_seen_at string | null: Теледидардың платформамен соңғы байланысы немесе ол ешқашан қосылмаған болса, null.
activated_at string | null: Теледидар белсендірілген уақыт.
app_version string: Теледидарға орнатылған қолданбаның нұсқасы.
os string: Теледидардың операциялық жүйесі, мысалы, android.
device object: Құрылғының маркасы (brand) мен моделі (model), егер теледидар оларды хабарласа.
timezone string | null: Теледидардың уақыт белдеуі, мысалы, America/Sao_Paulo, немесе null.

Күй қалай есептеледі

online соңғы байланыс 3 минуттан аз уақыт бұрын болған, ойнатып тұр
alert соңғы байланыс 3–9 минут бұрын болған немесе теледидар әлі іске қосылып жатыр
offline 10 минут немесе одан да ұзақ уақыт байланыс жоқ немесе теледидар ешқашан қосылмаған

Бұл басқару панеліндегі күй түстерімен бірдей ереже.

Болуы мүмкін қателер

400 invalid_parameter Параметрдің мәні жарамсыз, мысалы, per_page ең жоғарғы мәннен асады.
404 organization_not_found Көрсетілген organization пайдаланушы осы түрдегі элементтерді көре алатын ұйымға жатпайды.
Кілт пен шектеу қателері барлық эндпоинттерге қатысты. Барлық қателерді көру

СұранысcURLPHPJavaScript

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

Жауап200

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