सन्दर्भ · टिभीहरू
टिभीहरूको सूची
GET
/v1/tvs
प्रयोगकर्ताले टिभी हेर्न पाउने संस्थाहरूका सक्रिय टिभीहरूको सूची वर्णानुक्रममा दिन्छ।
पृष्ठहरूमा विभाजित प्रतिक्रिया: आइटमहरू data मा र पृष्ठको जानकारी meta मा आउँछ। पृष्ठांकन र फिल्टर
प्यारामिटरहरू
| नाम | प्रकार | विवरण |
|---|---|---|
organization | string | कुनै संस्थाको uid, त्यस संस्थाका आइटमहरू मात्र ल्याउन (हेर्नुहोस् /organizations)। |
q | string | नामको कुनै भाग, बढीमा 100 क्यारेक्टर। |
page | integer | पृष्ठ, 1 बाट सुरु। पूर्वनिर्धारित: 1। |
per_page | integer | प्रति पृष्ठ आइटमहरू, 1 देखि 100 सम्म। पूर्वनिर्धारित: 50। |
प्रत्येक आइटमका फिल्डहरू
uidstring- टिभीको पहिचानकर्ता, नियन्त्रण प्यानलमा प्रयोग हुने उही।
namestring- टिभीको नाम।
descriptionstring- टिभीको विवरण (खाली हुन सक्छ)।
organizationobject- टिभीको संस्था:
uidरname। playlistobject | null- टिभीको प्लेलिस्ट (
uidरname), वा नभएnull। statusstringonline,alertवाoffline, तल व्याख्या गरिए अनुसार।last_seen_atstring | null- प्लेटफर्मसँग टिभीको पछिल्लो सम्पर्क, वा कहिल्यै जडान नभएको भए
null। activated_atstring | null- टिभी कहिले सक्रिय गरियो।
app_versionstring- टिभीमा इन्स्टल गरिएको एपको संस्करण।
osstring- टिभीको अपरेटिङ सिस्टम, जस्तै
android। deviceobject- उपकरणको ब्रान्ड (
brand) र मोडेल (model), टिभीले जानकारी दिएमा। timezonestring | null- टिभीको समय क्षेत्र, जस्तै
America/Sao_Paulo, वाnull।
स्थिति कसरी निर्धारण हुन्छ
online3 मिनेटभन्दा कम समयअघि सम्पर्क, प्ले भइरहेकोalert3 देखि 9 मिनेटअघि सम्पर्क, वा टिभी अझै सुरु हुँदैoffline10 मिनेट वा सोभन्दा बढी समयदेखि सम्पर्क छैन, वा कहिल्यै जडान भएको छैन
नियन्त्रण प्यानलमा स्थितिका रङहरूका लागि पनि यही नियम लागू हुन्छ।
सम्भावित त्रुटिहरू
- 400
invalid_parameterकुनै प्यारामिटरको मान अमान्य छ, जस्तै अधिकतमभन्दा बढीper_page। - 404
organization_not_foundदिइएकोorganizationत्यस्तो संस्था होइन जहाँ प्रयोगकर्ताले यस प्रकारका आइटमहरू हेर्न पाउँछ। - कुञ्जी र सीमासम्बन्धी त्रुटिहरू सबै एन्डप्वाइन्टमा लागू हुन्छन्। सबै त्रुटिहरू हेर्नुहोस्
अनुरोध
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
}
}