संदर्भ · टीवी

टीवी की सूची

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