Sanggunian · Mga TV
Tingnan ang isang TV
GET
/v1/tvs/{uid}
Ipinapakita ang isang TV ayon sa uid nito.
Parameter sa path
| Pangalan | Uri | Paglalarawan |
|---|---|---|
uid | string | uid ng TV. |
Mga field ng response
uidstring- Identifier ng TV, ang parehong ginagamit sa control panel.
namestring- Pangalan ng TV.
descriptionstring- Paglalarawan ng TV (puwedeng walang laman).
organizationobject- Organisasyon ng TV:
uidatname. playlistobject | null- Playlist ng TV (
uidatname), onullkung wala. statusstringonline,alertooffline, gaya ng ipinaliwanag sa ibaba.last_seen_atstring | null- Huling contact ng TV sa platform, o
nullkung hindi pa ito kailanman nakakonekta. activated_atstring | null- Kailan na-activate ang TV.
app_versionstring- Bersyon ng app na naka-install sa TV.
osstring- Operating system ng TV, gaya ng
android. deviceobject- Brand (
brand) at modelo (model) ng device, kapag iniuulat ito ng TV. timezonestring | null- Time zone ng TV, gaya ng
America/Sao_Paulo, onull.
Paano kinakalkula ang status
onlinemay contact sa nakalipas na wala pang 3 minuto, nagpe-playalerthuling contact 3 hanggang 9 minuto na ang nakalipas, o nagsisimula pa ang TVofflinewalang contact sa loob ng 10 minuto o higit pa, o hindi pa kailanman nakakonekta
Ito rin ang patakaran ng mga kulay ng status sa control panel.
Mga posibleng error
- 404
not_foundHindi umiiral ang endpoint, o hindi umiiral ang item o kabilang ito sa isang organisasyong hindi nakikita ng user. - Umiiral sa lahat ng endpoint ang mga error sa key at sa limitasyon. Tingnan ang lahat ng error
Request
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();Response200
{
"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"
}
}Item na hindi umiiral o walang access404
{
"error": {
"code": "not_found",
"message": "Item not found or you do not have access to it."
}
}