Inkomba · Ama-TV

Bonisa ama-TV

GET /v1/tvs

Ibonisa ama-TV enziwe asebenza ezinhlanganweni lapho umsebenzisi angabona khona ama-TV, ngokulandelana kwezinhlamvu.

Impendulo ehlukaniswe ngamakhasi: izinto ziza ku-data kanti ulwazi lwekhasi luza ku-meta. Amakhasi nezihlungi

Amapharamitha

IgamaUhloboIncazelo
organizationstringI-uid yenhlangano, ukuze kulethwe izinto zayo kuphela (bona i-/organizations).
qstringIngxenye yegama, kufika ezinhlamvwini ezingu-100.
pageintegerIkhasi, kusukela ku-1. Okuzenzakalelayo: 1.
per_pageintegerIzinto ekhasini ngalinye, kusukela ku-1 kuya ku-100. Okuzenzakalelayo: 50.

Izinkambu zento ngayinye

uid string
Isihlonzi se-TV, esifanayo nesisetshenziswa ephanelini yokulawula.
name string
Igama le-TV.
description string
Incazelo ye-TV (ingaba ngenalutho).
organization object
Inhlangano ye-TV: uid ne-name.
playlist object | null
Uhlu lokudlala lwe-TV (uid ne-name), noma null uma lungekho.
status string
online, alert noma offline, njengoba kuchazwe ngezansi.
last_seen_at string | null
Ukuxhumana kokugcina kwe-TV nenkundla, noma null uma ingakaze ixhume.
activated_at string | null
Isikhathi i-TV eyenziwe yasebenza ngaso.
app_version string
Inguqulo ye-app efakwe ku-TV.
os string
Isistimu yokusebenza ye-TV, njenge-android.
device object
Uphawu (brand) nemodeli (model) yedivayisi, uma i-TV iyibika.
timezone string | null
Indawo yesikhathi ye-TV, njenge-America/Sao_Paulo, noma null.

Indlela isimo esibalwa ngayo

  • online ukuxhumana kungaphansi kwemizuzu emi-3 edlule, iyadlala
  • alert ukuxhumana phakathi kwemizuzu emi-3 nemi-9 edlule, noma i-TV isaqala
  • offline akukho kuxhumana imizuzu eyi-10 noma ngaphezulu, noma ayikaze ixhume

Kungumthetho ofanayo nowemibala yesimo ephanelini yokulawula.

Amaphutha angenzeka

  • 400 invalid_parameter Ipharamitha inenani elingavumelekile, njenge-per_page engaphezu komkhawulo ophezulu.
  • 404 organization_not_found I-organization enikeziwe akuyona inhlangano lapho umsebenzisi angabona khona lolu hlobo lwento.
  • Amaphutha okhiye nawomkhawulo asebenza kuwo wonke ama-endpoint. Bona wonke amaphutha
Isicelo
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();
Impendulo200
{
  "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
  }
}