入門指南

分頁及篩選

列表端點（/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` 欄位