Referensi · Playlist

Lihat playlist

GET /v1/playlists/{uid}

Menampilkan satu playlist berdasarkan uid, beserta item-itemnya dalam urutan tayang dan TV yang menggunakan playlist tersebut.

Parameter path

Nama	Jenis	Deskripsi
`uid`	`string`	uid playlist.

Field respons

uid string: ID playlist.
name string: Nama playlist.
organization object: Organisasi playlist: uid dan name.
total_time integer: Total waktu playlist, dalam detik.
total_time_is_approximate boolean: true jika total waktu merupakan perkiraan.
items array: Item playlist, dalam urutan tayang.
items[].position integer: Posisi item dalam playlist.
items[].type string: file untuk file atau entertainment untuk konten hiburan. Jenis lain dapat muncul.
items[].uid string: ID file atau konten hiburan.
items[].display_time integer | null: Waktu tayang yang diatur pada item, dalam detik, atau null jika tidak diatur.
items[].file object | null: Data file, dengan field yang sama seperti di “Daftar file”, atau null jika item bukan file atau pengguna tidak dapat melihat file dari organisasinya.
tvs array: TV yang menggunakan playlist ini (uid, name, dan organization). Hanya TV yang dapat dilihat pengguna yang ditampilkan.

Kemungkinan error

404 not_found Endpoint tidak ada, atau item tidak ada atau milik organisasi yang tidak dapat dilihat pengguna.
Error kunci dan batas permintaan berlaku untuk semua endpoint. Lihat semua error

PermintaancURLPHPJavaScript

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

Respons200

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

Item tidak ada atau tanpa akses404

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