Bắt đầu

Phân trang và bộ lọc

Các endpoint liệt kê (/tvs, /files và /playlists) được phân trang. Các mục nằm trong data và thông tin trang nằm trong meta.

Tên	Loại	Mô tả
`page`	`integer`	Trang, bắt đầu từ 1. Mặc định: 1.
`per_page`	`integer`	Số mục mỗi trang, từ 1 đến 100. Mặc định: 50.

Các trường của `meta`

page integer: Trang hiện tại.
per_page integer: Số mục mỗi trang.
total integer: Tổng số mục tìm thấy, tính trên tất cả các trang.
total_pages integer: Tổng số trang.

Để lấy toàn bộ, hãy bắt đầu từ page=1 và tăng dần cho đến total_pages. Trang nằm sau trang cuối cùng sẽ trả về data rỗng.

Bộ lọc

Có thể kết hợp các bộ lọc với nhau và với phân trang. Giá trị total trong meta đã tính đến các bộ lọc.

Tên	Loại	Mô tả
`organization`	`string`	uid của một tổ chức, để chỉ lấy các mục của tổ chức đó (xem `/organizations`).
`q`	`string`	Một phần của tên, tối đa 100 ký tự.
`type`	`string`	Loại tệp, ví dụ `image` hoặc `video`. Chỉ có ở `/files`.
`archived`	`integer`	`1` để chỉ lấy tệp đã lưu trữ hoặc `0` để chỉ lấy tệp chưa lưu trữ. Chỉ có ở `/files`.

Thứ tự

TV và danh sách phát được sắp xếp theo thứ tự bảng chữ cái; tệp được sắp xếp từ mới nhất đến cũ nhất.

Yêu cầucURLPHPJavaScript

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();

Phản hồi200

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

Tham số không hợp lệ400

GET /v1/tvs?per_page=500

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

Phân trang và bộ lọc

Các trường của meta

Bộ lọc

Thứ tự

Các trường của `meta`