Obtaining Player Configuration Status

POST

/v2/player/current/running-status

TIP

This interface is used for asynchronously obtaining the current volume, brightness, video source, time zone and time of a player.

Sub-accounts can only manage data within their specific workgroup and its sub-workgroups.

Advanced interface.

Request

Header Params

AppKey

string

required

Access key

Default:

Nonce

string

required

Random string (8-64 characters, only numbers or letters)

CurTime

string

required

The current UTC timestamp

CheckSum

string

required

Request signature

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-us.vnnox.com/v2/player/current/running-status' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--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

Obtaining Basic Player Information

Single-Page Emergency Insertion Solutions