Referens · TV-apparater

Lista TV-apparater

GET /v1/tvs

Listar de aktiverade TV-apparaterna i de organisationer där användaren kan se TV-apparater, i alfabetisk ordning.

Sidindelat svar: objekten kommer i data och sidinformationen i meta. Sidindelning och filter

Parametrar

Namn	Typ	Beskrivning
`organization`	`string`	uid för en organisation, för att bara få dess objekt (se `/organizations`).
`q`	`string`	Del av namnet, högst 100 tecken.
`page`	`integer`	Sida, från 1. Standard: 1.
`per_page`	`integer`	Objekt per sida, från 1 till 100. Standard: 50.

Fält för varje objekt

uid string: TV:ns id, samma som används i kontrollpanelen.
name string: TV:ns namn.
description string: TV:ns beskrivning (kan vara tom).
organization object: TV:ns organisation: uid och name.
playlist object | null: TV:ns spellista (uid och name), eller null om den inte har någon.
status string: online, alert eller offline, enligt förklaringen nedan.
last_seen_at string | null: TV:ns senaste kontakt med plattformen, eller null om den aldrig har anslutit.
activated_at string | null: När TV:n aktiverades.
app_version string: Version av appen som är installerad på TV:n.
os string: TV:ns operativsystem, till exempel android.
device object: Enhetens märke (brand) och modell (model), när TV:n rapporterar dem.
timezone string | null: TV:ns tidszon, till exempel America/Sao_Paulo, eller null.

Så beräknas statusen

online kontakt för mindre än 3 minuter sedan, spelar upp
alert kontakt för mellan 3 och 9 minuter sedan, eller TV:n håller fortfarande på att starta
offline ingen kontakt på 10 minuter eller mer, eller har aldrig anslutit

Det är samma regel som för statusfärgerna i kontrollpanelen.

Möjliga fel

400 invalid_parameter En parameter har ett ogiltigt värde, till exempel per_page över maxvärdet.
404 organization_not_found Angiven organization är inte en organisation där användaren kan se den här typen av objekt.
Fel som rör nyckeln och anropsgränsen gäller för alla endpoints. Visa alla fel

AnropcURLPHPJavaScript

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