Žinynas · Televizoriai
Televizorių sąrašas
GET
/v1/tvs
Abėcėlės tvarka pateikia suaktyvintus televizorius iš organizacijų, kuriose naudotojas gali matyti televizorius.
Atsakymas skaidomas puslapiais: elementai pateikiami lauke data, o puslapio informacija – lauke meta. Puslapiavimas ir filtrai
Parametrai
| Pavadinimas | Tipas | Aprašymas |
|---|---|---|
organization | string | Organizacijos uid, jei norite gauti tik jos elementus (žr. /organizations). |
q | string | Pavadinimo dalis, iki 100 simbolių. |
page | integer | Puslapis, pradedant nuo 1. Numatytoji reikšmė: 1. |
per_page | integer | Elementų skaičius puslapyje, nuo 1 iki 100. Numatytoji reikšmė: 50. |
Kiekvieno elemento laukai
uidstring- Televizoriaus identifikatorius – tas pats, kuris naudojamas valdymo skydelyje.
namestring- Televizoriaus pavadinimas.
descriptionstring- Televizoriaus aprašymas (gali būti tuščias).
organizationobject- Televizoriaus organizacija:
uidirname. playlistobject | null- Televizoriaus grojaraštis (
uidirname) arbanull, jei jo nėra. statusstringonline,alertarbaoffline, kaip paaiškinta toliau.last_seen_atstring | null- Paskutinis televizoriaus ryšys su platforma arba
null, jei jis niekada nebuvo prisijungęs. activated_atstring | null- Kada televizorius buvo suaktyvintas.
app_versionstring- Televizoriuje įdiegtos programėlės versija.
osstring- Televizoriaus operacinė sistema, pavyzdžiui,
android. deviceobject- Įrenginio prekės ženklas (
brand) ir modelis (model), jei televizorius juos praneša. timezonestring | null- Televizoriaus laiko juosta, pavyzdžiui,
America/Sao_Paulo, arbanull.
Kaip apskaičiuojama būsena
onlinepaskutinis ryšys mažiau nei prieš 3 minutes, turinys rodomasalertpaskutinis ryšys prieš 3–9 minutes arba televizorius dar paleidžiamasofflinenėra ryšio 10 minučių ar ilgiau arba televizorius niekada nebuvo prisijungęs
Tai ta pati taisyklė, pagal kurią valdymo skydelyje parenkamos būsenos spalvos.
Galimos klaidos
- 400
invalid_parameterParametras turi netinkamą reikšmę, pavyzdžiui,per_pageviršija didžiausią leistiną. - 404
organization_not_foundNurodytasorganizationnėra organizacija, kurioje naudotojas gali matyti šio tipo elementus. - Rakto ir apribojimų klaidos galioja visiems galiniams taškams. Žiūrėti visas klaidas
Užklausa
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();Atsakymas200
{
"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
}
}