المرجع · أجهزة التلفزيون

عرض قائمة أجهزة التلفزيون

GET /v1/tvs

تعرض أجهزة التلفزيون المفعّلة في المؤسسات التي يمكن للمستخدم فيها رؤية أجهزة التلفزيون، بالترتيب الأبجدي.

استجابة مقسّمة إلى صفحات: تأتي العناصر في data ومعلومات الصفحة في meta. ترقيم الصفحات والتصفية

المعاملات

الاسم	النوع	الوصف
`organization`	`string`	uid مؤسسة ما، لجلب عناصرها فقط (راجع `/organizations`).
`q`	`string`	جزء من الاسم، حتى 100 حرف.
`page`	`integer`	رقم الصفحة، بدءًا من 1. القيمة الافتراضية: 1.
`per_page`	`integer`	عدد العناصر في كل صفحة، من 1 إلى 100. القيمة الافتراضية: 50.

حقول كل عنصر

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 دقائق أو أكثر، أو لم يتصل قط

إنها القاعدة نفسها المتبعة في ألوان الحالة في لوحة التحكم.

الأخطاء المحتملة

400 invalid_parameter أحد المعاملات له قيمة غير صالحة، مثل per_page بقيمة أكبر من الحد الأقصى.
404 organization_not_found قيمة organization المحددة لا تخص مؤسسة يمكن للمستخدم فيها رؤية هذا النوع من العناصر.
تنطبق أخطاء المفتاح وحد الطلبات على جميع نقاط النهاية. عرض جميع الأخطاء

الطلبcURLPHPJavaScript

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

الاستجابة200

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