Tham chiếu · TV

Xem một TV

GET /v1/tvs/{uid}

Trả về một TV theo uid.

Tham số trong đường dẫn

TênLoạiMô tả
uidstringuid của TV.

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

uid string
Mã định danh của TV, giống mã dùng trong bảng điều khiển.
name string
Tên TV.
description string
Mô tả TV (có thể trống).
organization object
Tổ chức của TV: uid và name.
playlist object | null
Danh sách phát của TV (uid và name), hoặc null nếu không có.
status string
online, alert hoặc offline, như giải thích bên dưới.
last_seen_at string | null
Lần liên lạc gần nhất giữa TV và nền tảng, hoặc null nếu TV chưa từng kết nối.
activated_at string | null
Thời điểm TV được kích hoạt.
app_version string
Phiên bản ứng dụng cài trên TV.
os string
Hệ điều hành của TV, ví dụ android.
device object
Hãng (brand) và mẫu (model) của thiết bị, nếu TV cung cấp.
timezone string | null
Múi giờ của TV, ví dụ America/Sao_Paulo, hoặc null.

Cách tính trạng thái

  • online liên lạc cách đây chưa đến 3 phút, đang phát
  • alert liên lạc cách đây từ 3 đến 9 phút, hoặc TV vẫn đang khởi động
  • offline không liên lạc từ 10 phút trở lên, hoặc chưa từng kết nối

Đây cũng là quy tắc dùng cho màu trạng thái trong bảng điều khiển.

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ầu
curl "https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c" \
  -H "X-API-Key: $API_KEY"
<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c');
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/tvs/c98cb8f9cc62887d1f6cf5693df9219c', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();
Phản hồi200
{
  "data": {
    "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
    "name": "Recepção",
    "description": "TV da entrada",
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "playlist": {
      "uid": "e4da3b7fbbce2345d7772b0674a318d5",
      "name": "Lista principal"
    },
    "status": "online",
    "last_seen_at": "2026-11-03T14:32:10-03:00",
    "activated_at": "2025-03-12T09:41:05-03:00",
    "app_version": "3.12.84",
    "os": "android",
    "device": {
      "brand": "TCL",
      "model": "43P635"
    },
    "timezone": "America/Sao_Paulo"
  }
}
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."
  }
}