Referentie · TV's

TV's opvragen

GET /v1/tvs

Geeft de geactiveerde TV's van de organisaties waarin de gebruiker TV's kan zien, in alfabetische volgorde.

Gepagineerd antwoord: de items staan in data en de pagina-informatie in meta. Paginering en filters

Parameters

Naam	Type	Beschrijving
`organization`	`string`	uid van een organisatie, om alleen de items daarvan op te halen (zie `/organizations`).
`q`	`string`	Deel van de naam, maximaal 100 tekens.
`page`	`integer`	Pagina, vanaf 1. Standaard: 1.
`per_page`	`integer`	Items per pagina, van 1 tot 100. Standaard: 50.

Velden van elk item

uid string: ID van de TV, hetzelfde als in het beheerpaneel.
name string: Naam van de TV.
description string: Beschrijving van de TV (kan leeg zijn).
organization object: Organisatie van de TV: uid en name.
playlist object | null: Playlist van de TV (uid en name), of null als er geen is.
status string: online, alert of offline, zoals hieronder uitgelegd.
last_seen_at string | null: Laatste contact van de TV met het platform, of null als de TV nog nooit verbinding heeft gemaakt.
activated_at string | null: Wanneer de TV is geactiveerd.
app_version string: Versie van de app die op de TV is geïnstalleerd.
os string: Besturingssysteem van de TV, zoals android.
device object: Merk (brand) en model (model) van het apparaat, als de TV die doorgeeft.
timezone string | null: Tijdzone van de TV, zoals America/Sao_Paulo, of null.

Zo wordt de status berekend

online contact minder dan 3 minuten geleden, speelt af
alert contact tussen 3 en 9 minuten geleden, of de TV start nog op
offline al 10 minuten of langer geen contact, of nog nooit verbonden

Dit is dezelfde regel als voor de statuskleuren in het beheerpaneel.

Mogelijke fouten

400 invalid_parameter Een parameter heeft een ongeldige waarde, zoals per_page boven het maximum.
404 organization_not_found De opgegeven organization is geen organisatie waarin de gebruiker dit type item kan zien.
Fouten rond de sleutel en de verzoeklimiet gelden voor alle endpoints. Alle fouten bekijken

VerzoekcURLPHPJavaScript

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

Antwoord200

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