ข้อมูลอ้างอิง · ไฟล์

แสดงรายการไฟล์

แสดงรายการไฟล์ขององค์กรที่ผู้ใช้มีสิทธิ์ดูไฟล์ เรียงจากใหม่สุดไปเก่าสุด

การตอบกลับแบบแบ่งหน้า: รายการจะอยู่ใน data และข้อมูลหน้าจะอยู่ใน meta การแบ่งหน้าและตัวกรอง

พารามิเตอร์

ฟิลด์ของแต่ละรายการ

uid string

ตัวระบุไฟล์

name string

ชื่อไฟล์ในแผงควบคุม

type string

ประเภทไฟล์ เช่น image หรือ video

duration integer

ระยะเวลา หน่วยเป็นวินาที

archived boolean

true หากไฟล์ถูกเก็บถาวร

organization object

องค์กรของไฟล์: uid และ name

ข้อผิดพลาดที่อาจเกิดขึ้น

• 400 invalid_parameter พารามิเตอร์มีค่าไม่ถูกต้อง เช่น per_page เกินค่าสูงสุด
• 404 organization_not_found organization ที่ระบุไม่ใช่องค์กรที่ผู้ใช้มีสิทธิ์ดูรายการประเภทนี้
• ข้อผิดพลาดเกี่ยวกับคีย์และขีดจำกัดคำขอใช้กับทุกเอนด์พอยต์ ดูข้อผิดพลาดทั้งหมด

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

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