शुरुआत करें

पेजिनेशन और फ़िल्टर

सूचियाँ (/tvs, /files और /playlists) पेजों में बँटी होती हैं। आइटम data में आते हैं और पेज की जानकारी meta में।

नाम	प्रकार	विवरण
`page`	`integer`	पेज, 1 से शुरू। डिफ़ॉल्ट: 1।
`per_page`	`integer`	प्रति पेज आइटम, 1 से 100 तक। डिफ़ॉल्ट: 50।

`meta` के फ़ील्ड

page integer: मौजूदा पेज।
per_page integer: प्रति पेज आइटम।
total integer: सभी पेजों को मिलाकर मिले कुल आइटम।
total_pages integer: कुल पेज।

सब कुछ पाने के लिए page=1 से शुरू करें और total_pages तक आगे बढ़ें। आख़िरी पेज के बाद वाले पेज पर data खाली आता है।

फ़िल्टर

फ़िल्टर को आपस में और पेजिनेशन के साथ मिलाकर इस्तेमाल किया जा सकता है। meta का total फ़िल्टर को पहले से ध्यान में रखता है।

नाम	प्रकार	विवरण
`organization`	`string`	किसी संगठन का uid, ताकि केवल उसी के आइटम आएँ (देखें `/organizations`)।
`q`	`string`	नाम का कोई हिस्सा, अधिकतम 100 कैरेक्टर।
`type`	`string`	फ़ाइल का प्रकार, जैसे `image` या `video`। केवल `/files` में।
`archived`	`integer`	सिर्फ़ संग्रहीत फ़ाइलों के लिए `1` या सिर्फ़ गैर-संग्रहीत फ़ाइलों के लिए `0`। केवल `/files` में।

क्रम

टीवी और प्लेलिस्ट वर्णानुक्रम में आते हैं; फ़ाइलें, सबसे नई से सबसे पुरानी के क्रम में।

अनुरोध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
  }
}

अमान्य पैरामीटर400

GET /v1/tvs?per_page=500

{
  "error": {
    "code": "invalid_parameter",
    "message": "per_page must be a number between 1 and 100."
  }
}

पेजिनेशन और फ़िल्टर

meta के फ़ील्ड

फ़िल्टर

क्रम

`meta` के फ़ील्ड