Справочник · Телевизори
Списък с телевизори
GET
/v1/tvs
Връща по азбучен ред активираните телевизори от организациите, в които потребителят може да вижда телевизори.
Отговор със страниране: обектите идват в data, а информацията за страницата — в meta. Страниране и филтри
Параметри
| Име | Тип | Описание |
|---|---|---|
organization | string | uid на организация, за да получите само нейните обекти (вижте /organizations). |
q | string | Част от името, до 100 знака. |
page | integer | Страница, започвайки от 1. По подразбиране: 1. |
per_page | integer | Обекти на страница, от 1 до 100. По подразбиране: 50. |
Полета на всеки обект
uidstring- Идентификатор на телевизора — същият, който се използва в контролния панел.
namestring- Име на телевизора.
descriptionstring- Описание на телевизора (може да е празно).
organizationobject- Организация на телевизора:
uidиname. playlistobject | null- Плейлистът на телевизора (
uidиname) илиnull, ако няма такъв. statusstringonline,alertилиoffline, както е обяснено по-долу.last_seen_atstring | null- Последна връзка на телевизора с платформата или
null, ако никога не се е свързвал. activated_atstring | null- Кога е активиран телевизорът.
app_versionstring- Версия на приложението, инсталирано на телевизора.
osstring- Операционна система на телевизора, например
android. deviceobject- Марка (
brand) и модел (model) на устройството, ако телевизорът ги подава. timezonestring | null- Часова зона на телевизора, например
America/Sao_Paulo, илиnull.
Как се определя състоянието
onlineвръзка преди по-малко от 3 минути, възпроизвеждаalertвръзка преди 3 до 9 минути или телевизорът все още се стартираofflineняма връзка от 10 минути или повече, или никога не се е свързвал
Това е същото правило като при цветовете за състояние в контролния панел.
Възможни грешки
- 400
invalid_parameterПараметър има невалидна стойност, напримерper_pageнад максимума. - 404
organization_not_foundПосочениятorganizationне е организация, в която потребителят може да вижда този тип обекти. - Грешките за ключа и лимита важат за всички ендпойнти. Всички грешки
Заявка
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
}
}