Анықтамалық · Теледидарлар

Теледидарды көру

GET /v1/tvs/{uid}

Теледидарды uid бойынша қайтарады.

Жолдағы параметр

Атауы	Түрі	Сипаттамасы
`uid`	`string`	Теледидардың uid идентификаторы.

Жауап өрістері

uid string: Теледидар идентификаторы, басқару панеліндегімен бірдей.
name string: Теледидардың атауы.
description string: Теледидардың сипаттамасы (бос болуы мүмкін).
organization object: Теледидардың ұйымы: uid және name.
playlist object | null: Теледидардың ойнату тізімі (uid және name) немесе тізім болмаса, null.
status string: Төменде түсіндірілгендей online, alert немесе offline.
last_seen_at string | null: Теледидардың платформамен соңғы байланысы немесе ол ешқашан қосылмаған болса, null.
activated_at string | null: Теледидар белсендірілген уақыт.
app_version string: Теледидарға орнатылған қолданбаның нұсқасы.
os string: Теледидардың операциялық жүйесі, мысалы, android.
device object: Құрылғының маркасы (brand) мен моделі (model), егер теледидар оларды хабарласа.
timezone string | null: Теледидардың уақыт белдеуі, мысалы, America/Sao_Paulo, немесе null.

Күй қалай есептеледі

online соңғы байланыс 3 минуттан аз уақыт бұрын болған, ойнатып тұр
alert соңғы байланыс 3–9 минут бұрын болған немесе теледидар әлі іске қосылып жатыр
offline 10 минут немесе одан да ұзақ уақыт байланыс жоқ немесе теледидар ешқашан қосылмаған

Бұл басқару панеліндегі күй түстерімен бірдей ереже.

Болуы мүмкін қателер

404 not_found Эндпоинт жоқ, не элемент жоқ немесе ол пайдаланушы көре алмайтын ұйымға тиесілі.
Кілт пен шектеу қателері барлық эндпоинттерге қатысты. Барлық қателерді көру

СұранысcURLPHPJavaScript

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

Жауап200

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

Жоқ немесе қолжетімсіз элемент404

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