Atsauce · TV

Uzskaitīt TV

GET /v1/tvs

Alfabētiskā secībā uzskaita aktivizētos TV tajās organizācijās, kurās lietotājs var redzēt TV.

Lapās dalīta atbilde: vienumi tiek atgriezti laukā data, bet informācija par lapu — laukā meta. Lapošana un filtri

Parametri

Nosaukums	Tips	Apraksts
`organization`	`string`	Organizācijas uid, lai iegūtu tikai tās vienumus (skatiet `/organizations`).
`q`	`string`	Nosaukuma daļa, līdz 100 rakstzīmēm.
`page`	`integer`	Lapa, sākot no 1. Noklusējums: 1.
`per_page`	`integer`	Vienumu skaits lapā, no 1 līdz 100. Noklusējums: 50.

Katra vienuma lauki

uid string: TV identifikators — tas pats, ko izmanto vadības panelī.
name string: TV nosaukums.
description string: TV apraksts (var būt tukšs).
organization object: TV organizācija: uid un name.
playlist object | null: TV atskaņošanas saraksts (uid un name) vai null, ja tāda nav.
status string: online, alert vai offline, kā paskaidrots tālāk.
last_seen_at string | null: TV pēdējais kontakts ar platformu vai null, ja tas nekad nav pieslēdzies.
activated_at string | null: Kad TV tika aktivizēts.
app_version string: TV instalētās lietotnes versija.
os string: TV operētājsistēma, piemēram, android.
device object: Ierīces zīmols (brand) un modelis (model), ja TV tos paziņo.
timezone string | null: TV laika josla, piemēram, America/Sao_Paulo, vai null.

Kā tiek aprēķināts statuss

online pēdējais kontakts pirms mazāk nekā 3 minūtēm, notiek atskaņošana
alert pēdējais kontakts pirms 3–9 minūtēm vai TV vēl startē
offline nav kontakta 10 minūtes vai ilgāk, vai TV nekad nav pieslēdzies

Tas ir tas pats noteikums, pēc kura vadības panelī tiek noteiktas statusa krāsas.

Iespējamās kļūdas

400 invalid_parameter Parametram ir nederīga vērtība, piemēram, per_page pārsniedz maksimumu.
404 organization_not_found Norādītais organization nav organizācija, kurā lietotājs var redzēt šāda veida vienumus.
Atslēgas un ierobežojumu kļūdas attiecas uz visiem galapunktiem. Skatīt visas kļūdas

PieprasījumscURLPHPJavaScript

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

Atbilde200

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