المرجع · قوائم التشغيل

عرض قائمة تشغيل

GET /v1/playlists/{uid}

تعرض قائمة تشغيل حسب uid الخاص بها، مع عناصرها بترتيب العرض وأجهزة التلفزيون التي تستخدمها.

معامل المسار

الاسم	النوع	الوصف
`uid`	`string`	uid قائمة التشغيل.

حقول الاستجابة

uid string: معرّف قائمة التشغيل.
name string: اسم قائمة التشغيل.
organization object: مؤسسة قائمة التشغيل: uid وname.
total_time integer: المدة الإجمالية لقائمة التشغيل بالثواني.
total_time_is_approximate boolean: true إذا كانت المدة الإجمالية تقديرية.
items array: عناصر قائمة التشغيل بترتيب العرض.
items[].position integer: موضع العنصر في قائمة التشغيل.
items[].type string: file للملف أو entertainment للمحتوى الترفيهي. وقد تظهر أنواع أخرى.
items[].uid string: معرّف الملف أو المحتوى الترفيهي.
items[].display_time integer | null: مدة العرض المحددة للعنصر بالثواني، أو null إذا لم تُحدَّد.
items[].file object | null: بيانات الملف، بالحقول نفسها الموجودة في «عرض قائمة الملفات»، أو null إذا لم يكن العنصر ملفًا أو إذا كان المستخدم لا يستطيع رؤية ملفات مؤسسته.
tvs array: أجهزة التلفزيون التي تستخدم قائمة التشغيل (uid وname وorganization). لا تظهر إلا أجهزة التلفزيون التي يمكن للمستخدم رؤيتها.

الأخطاء المحتملة

404 not_found نقطة النهاية غير موجودة، أو أن العنصر غير موجود أو يتبع مؤسسة لا يمكن للمستخدم رؤيتها.
تنطبق أخطاء المفتاح وحد الطلبات على جميع نقاط النهاية. عرض جميع الأخطاء

الطلبcURLPHPJavaScript

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

الاستجابة200

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

عنصر غير موجود أو بلا صلاحية وصول404

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