Référence · TVs

Consulter une TV

GET /v1/tvs/{uid}

Renvoie une TV à partir de son uid.

Paramètre de chemin

Nom	Type	Description
`uid`	`string`	uid de la TV.

Champs de la réponse

uid string: Identifiant de la TV, le même que dans le panneau de contrôle.
name string: Nom de la TV.
description string: Description de la TV (peut être vide).
organization object: Organisation de la TV : uid et name.
playlist object | null: Playlist de la TV (uid et name), ou null s'il n'y en a pas.
status string: online, alert ou offline, comme expliqué ci-dessous.
last_seen_at string | null: Dernier contact de la TV avec la plateforme, ou null si elle ne s'est jamais connectée.
activated_at string | null: Date d'activation de la TV.
app_version string: Version de l'app installée sur la TV.
os string: Système d'exploitation de la TV, par exemple android.
device object: Marque (brand) et modèle (model) de l'appareil, lorsque la TV les communique.
timezone string | null: Fuseau horaire de la TV, par exemple America/Sao_Paulo, ou null.

Calcul du statut

online contact il y a moins de 3 minutes, lecture en cours
alert dernier contact il y a 3 à 9 minutes, ou TV en cours de démarrage
offline aucun contact depuis 10 minutes ou plus, ou jamais connectée

C'est la même règle que pour les couleurs de statut du panneau de contrôle.

Erreurs possibles

404 not_found L'endpoint n'existe pas, ou l'élément n'existe pas ou appartient à une organisation que l'utilisateur ne peut pas voir.
Les erreurs de clé et de limite s'appliquent à tous les endpoints. Voir toutes les erreurs

RequêtecURLPHPJavaScript

curl "https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c');
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/c98cb8f9cc62887d1f6cf5693df9219c', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Réponse200

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

Élément inexistant ou inaccessible404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}