Справочник · Телевизоры

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

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