Referanse · TV-er

Hent TV-er

GET /v1/tvs

Viser de aktiverte TV-ene i organisasjonene der brukeren kan se TV-er, i alfabetisk rekkefølge.

Svar delt inn i sider: Elementene kommer i data og sideinformasjonen i meta. Sideinndeling og filtre

Parametere

Navn	Type	Beskrivelse
`organization`	`string`	uid for en organisasjon, slik at bare elementene i den returneres (se `/organizations`).
`q`	`string`	Del av navnet, opptil 100 tegn.
`page`	`integer`	Side, fra og med 1. Standard: 1.
`per_page`	`integer`	Elementer per side, fra 1 til 100. Standard: 50.

Felter for hvert element

uid string: TV-ens ID, den samme som brukes i kontrollpanelet.
name string: TV-ens navn.
description string: TV-ens beskrivelse (kan være tom).
organization object: TV-ens organisasjon: uid og name.
playlist object | null: TV-ens spilleliste (uid og name), eller null hvis den ikke har noen.
status string: online, alert eller offline, som forklart nedenfor.
last_seen_at string | null: TV-ens siste kontakt med plattformen, eller null hvis den aldri har koblet til.
activated_at string | null: Når TV-en ble aktivert.
app_version string: Versjonen av appen som er installert på TV-en.
os string: TV-ens operativsystem, for eksempel android.
device object: Enhetens merke (brand) og modell (model), når TV-en oppgir dem.
timezone string | null: TV-ens tidssone, for eksempel America/Sao_Paulo, eller null.

Slik beregnes statusen

online kontakt for under 3 minutter siden, spiller av
alert kontakt for mellom 3 og 9 minutter siden, eller TV-en starter fortsatt opp
offline ingen kontakt på 10 minutter eller mer, eller aldri tilkoblet

Det er den samme regelen som for statusfargene i kontrollpanelet.

Mulige feil

400 invalid_parameter En parameter har en ugyldig verdi, for eksempel per_page over maksimum.
404 organization_not_found Den oppgitte organization er ikke en organisasjon der brukeren kan se denne typen elementer.
Feil knyttet til nøkkel og grenser gjelder for alle endepunkter. Se alle feil

ForespørselcURLPHPJavaScript

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