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ên | Loại | Mô tả |
|---|---|---|
uid | string | uid của TV. |
Các trường của phản hồi
uidstring- Mã định danh của TV, giống mã dùng trong bảng điều khiển.
namestring- Tên TV.
descriptionstring- Mô tả TV (có thể trống).
organizationobject- Tổ chức của TV:
uidvàname. playlistobject | null- Danh sách phát của TV (
uidvàname), hoặcnullnếu không có. statusstringonline,alerthoặcoffline, như giải thích bên dưới.last_seen_atstring | null- Lần liên lạc gần nhất giữa TV và nền tảng, hoặc
nullnếu TV chưa từng kết nối. activated_atstring | null- Thời điểm TV được kích hoạt.
app_versionstring- Phiên bản ứng dụng cài trên TV.
osstring- Hệ điều hành của TV, ví dụ
android. deviceobject- Hãng (
brand) và mẫu (model) của thiết bị, nếu TV cung cấp. timezonestring | null- Múi giờ của TV, ví dụ
America/Sao_Paulo, hoặcnull.
Cách tính trạng thái
onlineliên lạc cách đây chưa đến 3 phút, đang phátalertliên lạc cách đây từ 3 đến 9 phút, hoặc TV vẫn đang khởi độngofflinekhô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_foundEndpoint 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."
}
}