Single-Page Emergency Insertion Solutions

https://open-us.vnnox.com

POST

/v2/player/emergency-program/page

TIP

This interface is used for making emergency insertion solutions and publishing them to players.

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

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.

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-us.vnnox.com/v2/player/emergency-program/page' \
--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

Obtaining Player Configuration Status

Canceling Emergency Insertion Solutions