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

Данные телевизора

GET /v1/tvs/{uid}

Возвращает телевизор по uid.

Параметр пути

ИмяТипОписание
uidstringuid телевизора.

Поля ответа

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 минут и дольше или телевизор ни разу не подключался

Это то же правило, что и для цветов статуса в панели управления.

Возможные ошибки

  • 404 not_found Эндпоинт не существует, либо объект не существует или принадлежит организации, которую пользователь не может видеть.
  • Ошибки ключа и лимита запросов относятся ко всем эндпоинтам. Все ошибки
Запрос
curl "https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c" \
  -H "X-API-Key: $API_KEY"
<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c');
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/c98cb8f9cc62887d1f6cf5693df9219c', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();
Ответ200
{
  "data": {
    "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"
  }
}
Объект не существует или нет доступа404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}