레퍼런스 · 재생목록

재생목록 조회

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