NovaCloud-EN
  1. Player Management
NovaCloud-EN
  • API Access Guide
  • Common HTTP Status Codes
  • VNNOX
    • Player
      • Player Management
        • Obtain player list
          GET
      • Obtaining Player Status
        • Obtaining Basic Player Information
        • Obtaining Player Configuration Status
    • Solutions
      • Emergency Insertion
        • Single-Page Emergency Insertion Solutions
        • Canceling Emergency Insertion Solutions
      • Program widget examples
        • Hand-drawn clock widget
        • Weather widget
        • Environmental Monitoring widget
      • Common Solutions
      • Offline Export
      • Over-specification Detection Switching
      • Program Over-specification Detection
    • Real-Time Control
      • NTP Time Synchronization
      • Synchronous playback
      • Brightness Adjustment
      • Screenshots
      • Volume Adjustment
      • Video Source Switching
      • Screen Status
      • Restart Players
      • Screen Power
    • Scheduled Control
      • Scheduled Screen Status
      • Scheduled Restart Players
      • Scheduled Volume Adjustment
      • Scheduled Brightness Adjustment
      • Scheduled Video Source Switching
    • Logs
      • Play Logs
        • Batch Searching for Play Log Overviews
        • Batch Searching for Play Log Details
        • Searching for the Play Log Detail of a Single Player
        • Searching for the Play Log Overview of a Single Player
      • Obtaining Control Command Execution Logs
    • Notifications
      • Video Source Change Notifications
      • Solution Change Notifications
  • VNNOXCare
    • Notes
    • Device Status Monitoring
      • Receiving Card
        • Topology Information
        • Basic Information
        • Monitoring Information
        • Alarm Information
      • Screen
        • Screen list
        • Screen detail
        • Monitoring Information
      • Master Controller
        • Basic Information
        • Alarm Information
        • Operating Parameters Information
      • Smart Module
        • Monitoring Information
        • Alarm Infomation
      • Input Source
        • Monitor Infomation
      • Module/Cabinet
        • Monitoring Information
      • Monitoring Card
        • Monitoring Information
      • Camera
        • Camera configuration
        • The camera monitors the aggregated information
    • Brightness Log
      • Brightness History
  • Others
    • Third-Party System Authorization
      • Obtaining User List
      • Obtaining Login URL
  1. Player Management

Obtain player list

US
https://open-us.vnnox.com
US
https://open-us.vnnox.com
GET
/v2/player/list
TIP
1.
This interface is used for obtaining the player list information.
2.
Sub-accounts can only manage data within their specific workgroup and its sub-workgroups.
3.
Basic interface.

Request

Query Params
count
integer 
optional
The number of items to read each time, which defaults to 20 and ranges from 1 to 100.
Example:
20
start
integer 
optional
From which item to start reading, 0 by default.
Example:
0
name
string 
optional
Search by the key words of player names.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://open-us.vnnox.com/v2/player/list?count=20&start=0&name'

Responses

🟢200OK
application/json
Body
pageInfo
object 
required
Paging information
start
integer 
required
From which item to start reading.
count
integer 
required
The number of records to read each time.
total
integer 
required
Total records
rows
array [object {8}] 
required
playerId
string 
required
Player ID
playerType
integer 
required
Player type, 1-Synchronous player, 2-Asynchronous player.
name
string 
required
Player name
sn
string 
required
Unique ID of a player. Null denotes that the player is not bound.
version
string 
required
Current player version
ip
string 
required
Player IP address
lastOnlineTime
string 
required
Last heartbeat time of the player
onlineStatus
integer 
required
Player status, 0-Offline, 1-Online.
Example
{
    "pageInfo": {
        "start": 0,
        "count": 20
    },
    "total": 7,
    "rows": [
        {
            "playerId": "7fd6783109670b52103c5bab659701d5",
            "playerType": 2,
            "name": "Taurus-50000983-2",
            "sn": "BZSA07313J0350000983",
            "version": "V2.2.0.0101",
            "ip": "10.10.11.104",
            "lastOnlineTime": "2020-09-09 15:25:32",
            "onlineStatus": 1
        }
    ]
}
Previous
Common HTTP Status Codes
Next
Obtaining Basic Player Information
Built with