Marejeleo · TV

Orodhesha TV

GET /v1/tvs

Huorodhesha TV zilizowashwa za mashirika ambamo mtumiaji anaweza kuona TV, kwa mpangilio wa alfabeti.

Jibu lenye kurasa: vipengee huja ndani ya data na maelezo ya ukurasa ndani ya meta. Kurasa na vichujio

Vigezo

Jina	Aina	Maelezo
`organization`	`string`	uid ya shirika, ili kuleta vipengee vyake pekee (tazama `/organizations`).
`q`	`string`	Sehemu ya jina, hadi herufi 100.
`page`	`integer`	Ukurasa, kuanzia 1. Chaguomsingi: 1.
`per_page`	`integer`	Vipengee kwa kila ukurasa, kuanzia 1 hadi 100. Chaguomsingi: 50.

Sehemu za kila kipengee

uid string: Kitambulisho cha TV, kile kile kinachotumika kwenye paneli ya udhibiti.
name string: Jina la TV.
description string: Maelezo ya TV (yanaweza kuwa tupu).
organization object: Shirika la TV: uid na name.
playlist object | null: Orodha ya kucheza ya TV (uid na name), au null ikiwa haipo.
status string: online, alert au offline, kama ilivyoelezwa hapa chini.
last_seen_at string | null: Mawasiliano ya mwisho ya TV na jukwaa, au null ikiwa haijawahi kuunganishwa.
activated_at string | null: Wakati TV ilipowashwa.
app_version string: Toleo la programu iliyosakinishwa kwenye TV.
os string: Mfumo wa uendeshaji wa TV, kama android.
device object: Chapa (brand) na modeli (model) ya kifaa, TV inapoviripoti.
timezone string | null: Saa za eneo za TV, kama America/Sao_Paulo, au null.

Jinsi hali inavyokokotolewa

online mawasiliano chini ya dakika 3 zilizopita, inacheza
alert mawasiliano kati ya dakika 3 na 9 zilizopita, au TV bado inaanza
offline hakuna mawasiliano kwa dakika 10 au zaidi, au haijawahi kuunganishwa

Ni kanuni ile ile ya rangi za hali kwenye paneli ya udhibiti.

Hitilafu zinazowezekana

400 invalid_parameter Kigezo kina thamani batili, kama per_page inayozidi kiwango cha juu.
404 organization_not_found organization uliyotoa si shirika ambamo mtumiaji anaweza kuona aina hii ya kipengee.
Hitilafu za ufunguo na za kikomo zinahusu endpoint zote. Tazama hitilafu zote

OmbicURLPHPJavaScript

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

Jibu200

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