Довідник · Телевізори

Список телевізорів

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