Sanggunian · Mga TV

Ilista ang mga TV

GET /v1/tvs

Inililista ang mga na-activate na TV ng mga organisasyon kung saan nakikita ng user ang mga TV, ayon sa alpabeto.

Response na may pagination: nasa data ang mga item at nasa meta ang impormasyon ng pahina. Pagination at mga filter

Mga parameter

Pangalan	Uri	Paglalarawan
`organization`	`string`	uid ng isang organisasyon, para ang mga item lang nito ang makuha (tingnan ang `/organizations`).
`q`	`string`	Bahagi ng pangalan, hanggang 100 character.
`page`	`integer`	Pahina, simula sa 1. Default: 1.
`per_page`	`integer`	Mga item bawat pahina, mula 1 hanggang 100. Default: 50.

Mga field ng bawat item

uid string: Identifier ng TV, ang parehong ginagamit sa control panel.
name string: Pangalan ng TV.
description string: Paglalarawan ng TV (puwedeng walang laman).
organization object: Organisasyon ng TV: uid at name.
playlist object | null: Playlist ng TV (uid at name), o null kung wala.
status string: online, alert o offline, gaya ng ipinaliwanag sa ibaba.
last_seen_at string | null: Huling contact ng TV sa platform, o null kung hindi pa ito kailanman nakakonekta.
activated_at string | null: Kailan na-activate ang TV.
app_version string: Bersyon ng app na naka-install sa TV.
os string: Operating system ng TV, gaya ng android.
device object: Brand (brand) at modelo (model) ng device, kapag iniuulat ito ng TV.
timezone string | null: Time zone ng TV, gaya ng America/Sao_Paulo, o null.

Paano kinakalkula ang status

online may contact sa nakalipas na wala pang 3 minuto, nagpe-play
alert huling contact 3 hanggang 9 minuto na ang nakalipas, o nagsisimula pa ang TV
offline walang 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

400 invalid_parameter May invalid na value ang isang parameter, gaya ng per_page na lampas sa maximum.
404 organization_not_found Ang ibinigay na organization ay hindi isang organisasyon kung saan nakikita ng user ang ganitong uri ng item.
Umiiral sa lahat ng endpoint ang mga error sa key at sa limitasyon. Tingnan ang lahat ng error

RequestcURLPHPJavaScript

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();

Response200

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