Tham chiếu · Tệp

Liệt kê tệp

GET /v1/files

Liệt kê các tệp của những tổ chức mà người dùng được xem tệp, từ mới nhất đến cũ nhất.

Phản hồi được phân trang: các mục nằm trong data và thông tin trang nằm trong meta. Phân trang và bộ lọc

Tham số

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`.
`archived`	`integer`	`1` để chỉ lấy tệp đã lưu trữ hoặc `0` để chỉ lấy tệp chưa lưu trữ. Nếu không có tham số này, tất cả tệp đều được trả về.
`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 mỗi mục

uid string: Mã định danh của tệp.
name string: Tên tệp trong bảng điều khiển.
type string: Loại tệp, ví dụ image hoặc video.
duration integer: Thời lượng, tính bằng giây.
archived boolean: true nếu tệp đã được lưu trữ.
organization object: Tổ chức của tệp: uid và name.

Các lỗi có thể gặp

400 invalid_parameter Một tham số có giá trị không hợp lệ, ví dụ per_page vượt quá mức tối đa.
404 organization_not_found Giá trị organization được truyền không phải là tổ chức mà người dùng được xem loại mục này.
Lỗi về khóa và giới hạn yêu cầu áp dụng cho mọi endpoint. Xem tất cả lỗi

Yêu cầucURLPHPJavaScript

curl "https://api.on-cloud.live/v1/files?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/files?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/files?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Phản hồi200

{
  "data": [
    {
      "uid": "c20ad4d76fe97759aa27a0c99bff6710",
      "name": "Horário de funcionamento",
      "type": "image",
      "duration": 8,
      "archived": false,
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      }
    },
    {
      "uid": "6512bd43d9caa6e02c990b0a82652dca",
      "name": "Cardápio do dia",
      "type": "image",
      "duration": 10,
      "archived": false,
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}