NovaCloud-EN
  1. Emergency Insertion
NovaCloud-EN
  • API Access Guide
  • Common HTTP Status Codes
  • VNNOX
    • Player
      • Player Management
        • Obtain player list
      • Obtaining Player Status
        • Obtaining Basic Player Information
        • Obtaining Player Configuration Status
    • Solutions
      • Emergency Insertion
        • Single-Page Emergency Insertion Solutions
          POST
        • Canceling Emergency Insertion Solutions
          POST
      • Program widget examples
        • Hand-drawn clock widget
        • Weather widget
        • Environmental Monitoring widget
      • Common Solutions
        POST
      • Offline Export
        POST
      • Over-specification Detection Switching
        POST
      • Program Over-specification Detection
        POST
    • 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
    • Brightness Log
      • Brightness History
  • Others
    • Third-Party System Authorization
      • Obtaining User List
      • Obtaining Login URL
  1. Emergency Insertion

Single-Page Emergency Insertion Solutions

US
US
POST
/v2/player/emergency-program/page
TIP
1.
This interface is used for making emergency insertion solutions and publishing them to players.
2.
Sub-accounts can only manage data within their specific workgroup and its sub-workgroups.
3.
Advanced interface.

Request

Header Params
AppKey
string 
required
Access key
Default:
{{AppKey}}
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.
attribute
object 
required
Basic emergency insertion properties
spotsType
string 
required
Emergency insertion type, IMMEDIATELY: Immediate insertion, TIMING: Scheduled insertion.
normalProgramStatus
string 
required
Playback status of a common solution, NORMAL-Normal，PAUSE -Paused.
duration
number 
required
Insertion playback duration which is accurate to millisecond and cannot be longer than 24 hours.
timingTime
string 
optional
Scheduled insertion time, example: 12:00:00.
backgroundColor
string 
optional
Text page background color, 16-number color value, transparent by default, #00000000 denotes transparent color.
page
array [object {2}] 
required
Solution content to be played
name
string 
required
Page name
widgets
array [object {9}] 
required
Widgets on a page
Example
{
  "playerIds": [
    "52a66b84e5e241908a5dd317e82556d8"
  ],
  "attribute": {
    "duration": 20000,
    "normalProgramStatus": "PAUSE",
    "spotsType": "IMMEDIATELY"
  },
  "page": {
    "name": "a-immediately",
    "widgets": [
      {
        "duration": 10000,
        "inAnimation": {
          "duration": 1000,
          "type": "NONE"
        },
        "layout": {
          "height": "20%",
          "width": "100%",
          "x": "0%",
          "y": "60%"
        },
        "md5": "8330dcaa949ceeafa54a66e8ad623300",
        "size": 25943,
        "type": "PICTURE",
        "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/test.jpg",
        "zIndex": 1
      }
    ]
  }
}

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/emergency-program/page' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
 "playerIds": [
        "52a66b84e5e241908a5dd317e82556d8"
    ],
    "attribute": {
        "duration": 20000,
        "normalProgramStatus": "PAUSE",
        "spotsType": "IMMEDIATELY"
    },
    "page": {
        "name": "a-immediately",
        "widgets": [
            {
                "duration": 10000,
                "inAnimation": {
                    "duration": 1000,
                    "type": "NONE"
                },
                "layout": {
                    "height": "20%",
                    "width": "100%",
                    "x": "0%",
                    "y": "60%"
                },
                "md5": "8330dcaa949ceeafa54a66e8ad623300",
                "size": 25943,
                "type": "PICTURE",
                "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/test.jpg",
                "zIndex": 1
            }
        ]
    }
}'

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": [
    "6226495f8a030b075e2f6757236620e2"
  ],
  "fail": []
}
Modified at 2024-08-07 01:35:37
Previous
Obtaining Player Configuration Status
Next
Canceling Emergency Insertion Solutions
Built with