חומר עזר · טלוויזיות

פרטי טלוויזיה

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