Tham chiếu · Danh sách phát

Xem một danh sách phát

GET /v1/playlists/{uid}

Trả về một danh sách phát theo uid, kèm các mục theo thứ tự phát và các TV đang dùng danh sách phát đó.

Tham số trong đường dẫn

Tên	Loại	Mô tả
`uid`	`string`	uid của danh sách phát.

Các trường của phản hồi

uid string: Mã định danh của danh sách phát.
name string: Tên danh sách phát.
organization object: Tổ chức của danh sách phát: uid và name.
total_time integer: Tổng thời gian của danh sách phát, tính bằng giây.
total_time_is_approximate boolean: true nếu tổng thời gian là giá trị ước tính.
items array: Các mục của danh sách phát, theo thứ tự phát.
items[].position integer: Vị trí của mục trong danh sách phát.
items[].type string: file cho tệp hoặc entertainment cho nội dung giải trí. Có thể xuất hiện các loại khác.
items[].uid string: Mã định danh của tệp hoặc nội dung giải trí.
items[].display_time integer | null: Thời gian hiển thị đặt cho mục, tính bằng giây, hoặc null nếu không đặt.
items[].file object | null: Thông tin tệp, với các trường giống như ở “Liệt kê tệp”, hoặc null nếu mục không phải là tệp hoặc người dùng không được xem tệp của tổ chức chứa tệp đó.
tvs array: Các TV đang dùng danh sách phát (uid, name và organization). Chỉ hiển thị các TV mà người dùng được xem.

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

404 not_found Endpoint không tồn tại, hoặc mục không tồn tại hay thuộc một tổ chức mà người dùng không được xem.
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/playlists/e4da3b7fbbce2345d7772b0674a318d5" \
  -H "X-API-Key: $API_KEY"

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

Phản hồi200

{
  "data": {
    "uid": "e4da3b7fbbce2345d7772b0674a318d5",
    "name": "Lista principal",
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "total_time": 85,
    "total_time_is_approximate": true,
    "items": [
      {
        "position": 1,
        "type": "file",
        "uid": "a87ff679a2f3e71d9181a67b7542122c",
        "display_time": null,
        "file": {
          "uid": "a87ff679a2f3e71d9181a67b7542122c",
          "name": "Promoção de verão",
          "type": "video",
          "duration": 30,
          "archived": false,
          "organization": {
            "uid": "8f14e45fceea167a5a36dedd4bea2543",
            "name": "Loja Centro"
          }
        }
      },
      {
        "position": 2,
        "type": "entertainment",
        "uid": "noticias",
        "display_time": 15,
        "file": null
      },
      {
        "position": 3,
        "type": "file",
        "uid": "6512bd43d9caa6e02c990b0a82652dca",
        "display_time": 10,
        "file": {
          "uid": "6512bd43d9caa6e02c990b0a82652dca",
          "name": "Cardápio do dia",
          "type": "image",
          "duration": 10,
          "archived": false,
          "organization": {
            "uid": "8f14e45fceea167a5a36dedd4bea2543",
            "name": "Loja Centro"
          }
        }
      }
    ],
    "tvs": [
      {
        "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
        "name": "Recepção",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      },
      {
        "uid": "45c48cce2e2d7fbdea1afc51c7c6ad26",
        "name": "Vitrine",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      }
    ]
  }
}

Mục không tồn tại hoặc không có quyền truy cập404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}