Referencja · Telewizory

Lista telewizorów

GET /v1/tvs

Zwraca w kolejności alfabetycznej listę aktywowanych telewizorów z organizacji, w których użytkownik może widzieć telewizory.

Odpowiedź z paginacją: elementy są zwracane w data, a informacje o stronie w meta. Paginacja i filtry

Parametry

Nazwa	Typ	Opis
`organization`	`string`	uid organizacji, aby zwrócić tylko jej elementy (zobacz `/organizations`).
`q`	`string`	Fragment nazwy, maksymalnie 100 znaków.
`page`	`integer`	Strona, od 1. Domyślnie: 1.
`per_page`	`integer`	Liczba elementów na stronie, od 1 do 100. Domyślnie: 50.

Pola każdego elementu

uid string: Identyfikator telewizora, taki sam jak w panelu sterowania.
name string: Nazwa telewizora.
description string: Opis telewizora (może być pusty).
organization object: Organizacja telewizora: uid i name.
playlist object | null: Playlista telewizora (uid i name) lub null, jeśli jej nie ma.
status string: online, alert lub offline, jak wyjaśniono poniżej.
last_seen_at string | null: Ostatni kontakt telewizora z platformą lub null, jeśli nigdy się nie połączył.
activated_at string | null: Kiedy telewizor został aktywowany.
app_version string: Wersja aplikacji zainstalowanej na telewizorze.
os string: System operacyjny telewizora, np. android.
device object: Marka (brand) i model (model) urządzenia, jeśli telewizor je przekazuje.
timezone string | null: Strefa czasowa telewizora, np. America/Sao_Paulo, lub null.

Jak obliczany jest status

online kontakt mniej niż 3 minuty temu, trwa odtwarzanie
alert kontakt od 3 do 9 minut temu lub telewizor wciąż się uruchamia
offline brak kontaktu od 10 minut lub dłużej albo telewizor nigdy się nie połączył

To ta sama reguła, co w przypadku kolorów statusu w panelu sterowania.

Możliwe błędy

400 invalid_parameter Parametr ma nieprawidłową wartość, np. per_page powyżej maksimum.
404 organization_not_found Podany parametr organization nie wskazuje organizacji, w której użytkownik może widzieć ten typ elementów.
Błędy klucza i limitu dotyczą wszystkich endpointów. Zobacz wszystkie błędy

ŻądaniecURLPHPJavaScript

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

Odpowiedź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
  }
}