Referenco · Televidiloj

Listigi televidilojn

GET /v1/tvs

Listigas la aktivigitajn televidilojn de la organizaĵoj, en kiuj la uzanto povas vidi televidilojn, laŭ alfabeta ordo.

Paĝigita respondo: la eroj venas en data kaj la informoj pri la paĝo en meta. Paĝigo kaj filtriloj

Parametroj

Nomo	Tipo	Priskribo
`organization`	`string`	uid de organizaĵo, por ricevi nur ĝiajn erojn (vidu `/organizations`).
`q`	`string`	Parto de la nomo, ĝis 100 signoj.
`page`	`integer`	Paĝo, ekde 1. Defaŭlte: 1.
`per_page`	`integer`	Eroj por paĝo, de 1 ĝis 100. Defaŭlte: 50.

Kampoj de ĉiu ero

uid string: Identigilo de la televidilo, la sama uzata en la kontrolpanelo.
name string: Nomo de la televidilo.
description string: Priskribo de la televidilo (povas esti malplena).
organization object: Organizaĵo de la televidilo: uid kaj name.
playlist object | null: Ludlisto de la televidilo (uid kaj name), aŭ null se ĝi ne havas.
status string: online, alert aŭ offline, kiel klarigite sube.
last_seen_at string | null: Lasta kontakto de la televidilo kun la platformo, aŭ null se ĝi neniam konektiĝis.
activated_at string | null: Kiam la televidilo estis aktivigita.
app_version string: Versio de la aplikaĵo instalita en la televidilo.
os string: Operaciumo de la televidilo, ekzemple android.
device object: Marko (brand) kaj modelo (model) de la aparato, kiam la televidilo raportas ilin.
timezone string | null: Horzono de la televidilo, ekzemple America/Sao_Paulo, aŭ null.

Kiel la stato estas kalkulata

online kontakto antaŭ malpli ol 3 minutoj, ludado aktiva
alert kontakto antaŭ 3 ĝis 9 minutoj, aŭ televidilo ankoraŭ startanta
offline sen kontakto dum 10 minutoj aŭ pli, aŭ neniam konektiĝis

Ĝi estas la sama regulo kiel tiu de la statokoloroj en la kontrolpanelo.

Eblaj eraroj

400 invalid_parameter Parametro havas nevalidan valoron, ekzemple per_page super la maksimumo.
404 organization_not_found La indikita organization ne estas organizaĵo, en kiu la uzanto povas vidi ĉi tiun tipon de eroj.
La eraroj pri ŝlosilo kaj limo validas por ĉiuj finpunktoj. Vidi ĉiujn erarojn

PetocURLPHPJavaScript

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

Respondo200

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