Reference · TV'er

Hent TV'er

GET /v1/tvs

Viser de aktiverede TV'er i de organisationer, hvor brugeren kan se TV'er, i alfabetisk rækkefølge.

Svar opdelt i sider: Elementerne ligger i data og sideoplysningerne i meta. Sideinddeling og filtre

Parametre

Navn	Type	Beskrivelse
`organization`	`string`	uid for en organisation, så kun dens elementer returneres (se `/organizations`).
`q`	`string`	Del af navnet, op til 100 tegn.
`page`	`integer`	Side, startende ved 1. Standard: 1.
`per_page`	`integer`	Elementer pr. side, fra 1 til 100. Standard: 50.

Felter for hvert element

uid string: TV'ets id, det samme som bruges i kontrolpanelet.
name string: TV'ets navn.
description string: TV'ets beskrivelse (kan være tom).
organization object: TV'ets organisation: uid og name.
playlist object | null: TV'ets playliste (uid og name) eller null, hvis der ikke er nogen.
status string: online, alert eller offline som forklaret nedenfor.
last_seen_at string | null: TV'ets seneste kontakt med platformen eller null, hvis det aldrig har været forbundet.
activated_at string | null: Hvornår TV'et blev aktiveret.
app_version string: Version af den app, der er installeret på TV'et.
os string: TV'ets operativsystem, f.eks. android.
device object: Enhedens mærke (brand) og model (model), når TV'et oplyser dem.
timezone string | null: TV'ets tidszone, f.eks. America/Sao_Paulo, eller null.

Sådan beregnes status

online kontakt for under 3 minutter siden, afspiller
alert kontakt for mellem 3 og 9 minutter siden, eller TV'et er stadig ved at starte op
offline ingen kontakt i 10 minutter eller mere, eller aldrig forbundet

Det er den samme regel som for statusfarverne i kontrolpanelet.

Mulige fejl

400 invalid_parameter En parameter har en ugyldig værdi, f.eks. per_page over maksimum.
404 organization_not_found Den angivne organization er ikke en organisation, hvor brugeren kan se denne type elementer.
Fejl vedrørende nøgle og grænser gælder for alle endpoints. Se alle fejl

ForespørgselcURLPHPJavaScript

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

Svar200

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