NovaCloud-EN
  1. Obtaining Player Status
NovaCloud-EN
  • API Access Guide
  • Common HTTP Status Codes
  • VNNOX
    • Player
      • Player Management
        • Obtain player list
      • Obtaining Player Status
        • Obtaining Basic Player Information
          POST
        • Obtaining Player Configuration Status
          POST
    • 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. Obtaining Player Status

Obtaining Player Configuration Status

US
https://open-us.vnnox.com
US
https://open-us.vnnox.com
POST
/v2/player/current/running-status
TIP
1.
This interface is used for asynchronously obtaining the current volume, brightness, video source, time zone and time of a player.
2.
Sub-accounts can only manage data within their specific workgroup and its sub-workgroups.
3.
Advanced interface.

Request

Body Params application/json
playerIds
array[string]
required
A collection of player IDs to be handled. At most 100 player IDs can be handled simultaneously.
commands
array[string]
required
A collection of commands to be obtained volumeValue -Current volume brightnessValue - Current brightness videoSourceValue - Current video source timeValue - Current time zone and time screenPowerStatus - Current screen status syncPlayStatus - Current status of synchronous playback powerStatus - Current multifunction card power status
noticeUrl
string 
required
Result notification interface. The customer interface must return the “ok” string, otherwise the system will try again.
Example
{
    "playerIds": [
        "8208967d40e9980bab6d12367dc88e0b"
    ],
    "commands": [
        "volumeValue",
        "brightnessValue",
        "videoSourceValue",
        "timeValue"
    ],
    "noticeUrl": "http://www.abc.com/notice"
}

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 POST 'https://open-us.vnnox.com/v2/player/current/running-status' \
--header 'Content-Type: application/json' \
--data-raw '{
    "playerIds": [
        "8208967d40e9980bab6d12367dc88e0b"
    ],
    "commands": [
        "volumeValue",
        "brightnessValue",
        "videoSourceValue",
        "timeValue"
    ],
    "noticeUrl": "http://www.abc.com/notice"
}'

Responses

🟢200OK
application/json
Body
success
array[string]
required
A collection of player IDs that are successfully sent
fail
array[string]
required
A collection of player IDs that are not sent successfully
Example
{
    "success": [
        "553cbfe2ff4ad2e0d6bd89bb2c4e85e2"
    ],
    "fail": []
}
🟢200Obtaining Current Time Zone and Time Call-back Arguments
🟢200Obtaining Current Video Source Call-back Arguments
🟢200Obtaining Current Volume Call-back Arguments
🟢200Obtaining Current Brightness Call-back Arguments
🟢200Obtaining Current Screen Status Call-back Arguments
🟢200Obtaining Current Synchronous Playback Status Call-back Arguments
🟢200Obtaining Current Multifunction Card Power Status Call-back Arguments
Modified at 2024-08-07 01:35:37
Previous
Obtaining Basic Player Information
Next
Single-Page Emergency Insertion Solutions
Built with