Referensi · TV

Daftar TV

GET /v1/tvs

Menampilkan daftar TV yang sudah diaktifkan dari organisasi tempat pengguna dapat melihat TV, diurutkan menurut abjad.

Respons dipaginasi: item dikirim dalam data dan informasi halaman dalam meta. Paginasi dan filter

Parameter

Nama	Jenis	Deskripsi
`organization`	`string`	uid organisasi, untuk menampilkan item dari organisasi itu saja (lihat `/organizations`).
`q`	`string`	Bagian dari nama, hingga 100 karakter.
`page`	`integer`	Halaman, mulai dari 1. Default: 1.
`per_page`	`integer`	Item per halaman, dari 1 hingga 100. Default: 50.

Field setiap item

uid string: ID TV, sama dengan yang digunakan di panel kontrol.
name string: Nama TV.
description string: Deskripsi TV (bisa kosong).
organization object: Organisasi TV: uid dan name.
playlist object | null: Playlist TV (uid dan name), atau null jika tidak ada.
status string: online, alert, atau offline, seperti dijelaskan di bawah.
last_seen_at string | null: Kontak terakhir TV dengan platform, atau null jika TV belum pernah terhubung.
activated_at string | null: Waktu TV diaktifkan.
app_version string: Versi aplikasi yang terpasang di TV.
os string: Sistem operasi TV, seperti android.
device object: Merek (brand) dan model (model) perangkat, jika dilaporkan oleh TV.
timezone string | null: Zona waktu TV, seperti America/Sao_Paulo, atau null.

Cara status dihitung

online kontak kurang dari 3 menit yang lalu, sedang memutar
alert kontak antara 3 dan 9 menit yang lalu, atau TV masih dalam proses memulai
offline tidak ada kontak selama 10 menit atau lebih, atau belum pernah terhubung

Aturannya sama dengan warna status di panel kontrol.

Kemungkinan error

400 invalid_parameter Sebuah parameter memiliki nilai yang tidak valid, misalnya per_page di atas batas maksimum.
404 organization_not_found organization yang diberikan bukan organisasi tempat pengguna dapat melihat jenis item ini.
Error kunci dan batas permintaan berlaku untuk semua endpoint. Lihat semua error

PermintaancURLPHPJavaScript

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

Respons200

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