ข้อมูลอ้างอิง · เพลย์ลิสต์

แสดงรายการเพลย์ลิสต์

GET /v1/playlists

แสดงรายการเพลย์ลิสต์ขององค์กรที่ผู้ใช้มีสิทธิ์ดูเพลย์ลิสต์ เรียงตามตัวอักษร

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
organizationstringuid ขององค์กร เพื่อแสดงเฉพาะรายการขององค์กรนั้น (ดู /organizations)
qstringส่วนหนึ่งของชื่อ ไม่เกิน 100 อักขระ
pageintegerหน้า เริ่มจาก 1 ค่าเริ่มต้น: 1
per_pageintegerจำนวนรายการต่อหน้า ตั้งแต่ 1 ถึง 100 ค่าเริ่มต้น: 50

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

uid string
ตัวระบุเพลย์ลิสต์
name string
ชื่อเพลย์ลิสต์
organization object
องค์กรของเพลย์ลิสต์: uid และ name
total_time integer
เวลารวมของเพลย์ลิสต์ หน่วยเป็นวินาที
total_time_is_approximate boolean
true หากเวลารวมเป็นค่าประมาณ

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

  • 400 invalid_parameter พารามิเตอร์มีค่าไม่ถูกต้อง เช่น per_page เกินค่าสูงสุด
  • 404 organization_not_found organization ที่ระบุไม่ใช่องค์กรที่ผู้ใช้มีสิทธิ์ดูรายการประเภทนี้
  • ข้อผิดพลาดเกี่ยวกับคีย์และขีดจำกัดคำขอใช้กับทุกเอนด์พอยต์ ดูข้อผิดพลาดทั้งหมด
คำขอ
curl "https://api.on-cloud.live/v1/playlists?per_page=2" \
  -H "X-API-Key: $API_KEY"
<?php
$ch = curl_init('https://api.on-cloud.live/v1/playlists?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/playlists?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();
การตอบกลับ200
{
  "data": [
    {
      "uid": "1f0e3dad99908345f7439f8ffabdffc4",
      "name": "Lista do caixa",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "total_time": 40,
      "total_time_is_approximate": false
    },
    {
      "uid": "e4da3b7fbbce2345d7772b0674a318d5",
      "name": "Lista principal",
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      },
      "total_time": 85,
      "total_time_is_approximate": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 2,
    "total_pages": 1
  }
}