參考資料 · 播放清單

列出播放清單

GET /v1/playlists

按字母順序列出用戶可查看播放清單的公司中的播放清單。

分頁回應：項目放在 data 內，分頁資料則放在 meta 內。分頁及篩選

參數

名稱	類型	說明
`organization`	`string`	公司的 uid，用於只傳回該公司的項目（請參閱 `/organizations`）。
`q`	`string`	名稱的部分文字，最多 100 個字元。
`page`	`integer`	頁數，由 1 開始。預設值：1。
`per_page`	`integer`	每頁項目數目，由 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 並非該用戶可查看此類項目的公司。
金鑰錯誤及次數限制錯誤適用於所有端點。查看所有錯誤

請求cURLPHPJavaScript

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