Common Solutions

TIP

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

Taurus later than V2.0.0 are supported.

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

Advanced interface.

💡

The widgets field supports polymorphic structures - its schema varies depending on the type value. Standard widgets are already included, for extended types, see:

Hand-drawn clock widget

Weather widget

Environmental Monitoring widget

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.

schedule

object

optional

Playback schedule. If this is empty, the playback will be repeated 24 hours.

startDate

string

required

Playback start date, example: 2020-04-12.

endDate

string

required

Playback end date, example: 2020-12-22.

plans

array [object {3}]

required

Specific playback plan

pages

array [object {3}]

required

A collection of the contents to be played.

name

string

required

Page name

schedules

array [object {3}]

optional

It denotes the schedule list for this page. If it is empty, the page will be looped continuously for 24 hours. However, if both the program and page schedules are set, the page will play only during the times that overlap between the two schedules.

widgets

array [anyOf]

required

noticeUrl

string

optional

Solution download progress notification interface. This interface is used for notifying the customer of the solution download progress. The response time of the interface cannot exceed 3s.

Example

{
    "playerIds": [
        "553cbfe2ff4ad2e0d6bd89bb2c4e85e2"
    ],
    "schedule": {
        "startDate": "2020-04-11",
        "endDate": "2060-05-12",
        "plans": [
            {
                "weekDays": [
                    1,
                    2,
                    3,
                    4,
                    5
                ],
                "startTime": "00:00:00",
                "endTime": "22:00:00"
            },
            {
                "weekDays": [
                    0,
                    6
                ],
                "startTime": "00:33:00",
                "endTime": "22:00:00"
            }
        ]
    },
    "pages": [
        {
            "name": "a-page",
            "widgets": [
                {
                    "zIndex": 1,
                    "type": "PICTURE",
                    "size": 25943,
                    "md5": "8330dcaa949ceeafa54a66e8ad623300",
                    "duration": 10000,
                    "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/test.jpg",
                    "layout": {
                        "x": "0%",
                        "y": "0%",
                        "width": "100%",
                        "height": "100%"
                    },
                    "inAnimation": {
                        "type": "NONE",
                        "duration": 1000
                    }
                },
                {
                    "zIndex": 2,
                    "type": "VIDEO",
                    "size": 1227710,
                    "md5": "f5b0f315800cb4befb89b5dff42f1e34",
                    "duration": 0,
                    "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/nova2019.mp4",
                    "layout": {
                        "x": "0%",
                        "y": "20%",
                        "width": "20%",
                        "height": "20%"
                    }
                }
            ]
        }
    ]
}

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/program/normal' \
--header 'Content-Type: application/json' \
--data-raw '{
    "playerIds": [
        "553cbfe2ff4ad2e0d6bd89bb2c4e85e2"
    ],
    "schedule": {
        "startDate": "2020-04-11",
        "endDate": "2060-05-12",
        "plans": [
            {
                "weekDays": [
                    1,
                    2,
                    3,
                    4,
                    5
                ],
                "startTime": "00:00:00",
                "endTime": "22:00:00"
            },
            {
                "weekDays": [
                    0,
                    6
                ],
                "startTime": "00:33:00",
                "endTime": "22:00:00"
            }
        ]
    },
    "pages": [
        {
            "name": "a-page",
            "widgets": [
                {
                    "zIndex": 1,
                    "type": "PICTURE",
                    "size": 25943,
                    "md5": "8330dcaa949ceeafa54a66e8ad623300",
                    "duration": 10000,
                    "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/test.jpg",
                    "layout": {
                        "x": "0%",
                        "y": "0%",
                        "width": "100%",
                        "height": "100%"
                    },
                    "inAnimation": {
                        "type": "NONE",
                        "duration": 1000
                    }
                },
                {
                    "zIndex": 2,
                    "type": "VIDEO",
                    "size": 1227710,
                    "md5": "f5b0f315800cb4befb89b5dff42f1e34",
                    "duration": 0,
                    "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/nova2019.mp4",
                    "layout": {
                        "x": "0%",
                        "y": "20%",
                        "width": "20%",
                        "height": "20%"
                    }
                }
            ]
        }
    ]
}'

application/json

Body

success

array[string]

required

fail

array[string]

required

Example

{
    "success": [
        "8cd86b94c6617c5d771fb91224b45685"
    ],
    "fail": []
}

Request

Request samples

Responses