常规节目

提示

通过此接口可以制作常规节目并下发给播放器。

支持 T卡 2.0.0 以上版本。

子账号只能操作本工作组以及子工作组的数据。

高级接口。

请求参数

Header 参数

AppKey

string

接入键

必需

默认值:

Nonce

string

必需

随机字符串（8~64个字符，仅限数字或英文字母）

CurTime

string

必需

当前 UTC 时间戳

CheckSum

string

请求签名

必需

Body 参数application/json

playerIds

array[string]

必需

需要处理的播放器ID集合。最多支持100个播放器同时处理

schedule

object

可选

整个节目的时间排期，如果为空，会全天24小时循环播放；若节目级排期和page级排期同时设置，播放以排期交集为准

startDate

string

必需

播放开始日期，如：2020-04-12

endDate

string

必需

播放结束日期，如：2020-12-22

plans

array [object {3}]

具体播放计划集合

必需

pages

array [object {3}]

必需

需要播放的页面内容集合

name

string

页面名称

必需

schedules

array [object {3}]

可选

此 Page 页播放时间排期集合，如果为空，会全天24小时循环播放；若节目级排期和page级排期同时设置，播放以排期交集为准

widgets

array [object {11}]

页面上的组件集合

必需

noticeUrl

string

可选

节目下载进度通知接口，会通过此接口将节目的下载进度发给客户，接口的响应时间不能超过3s
回调示例
{
"playerId": "553cbfe2ff4ad2e0d6bd89bb2c4e85e2",
"precess": 0.5,
"status":0
}
precess：节目下载进度，范围为：0-1
status：状态，0-正常状态;1001-媒体下载异常（一般是网络异常么有下载到），文件md5校验失败;1002-媒体超规格无法播放异常
errmsg：status不为0时，此内容为异常信息描述

示例

{
  "playerIds": [
    "553cbfe2ff4ad2e0d6bd89bb2c4e85e2"
  ],
  "schedule": {
    "startDate": "2020-04-11",
    "endDate": "2060-05-12",
    "plans": [
      {
        "weekDays": [
          1,
          2,
          3,
          4,
          5
        ],
        "startTime": "00:00",
        "endTime": "22:00"
      },
      {
        "weekDays": [
          0,
          6
        ],
        "startTime": "00:33",
        "endTime": "22: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%"
          }
        }
      ]
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-cn.vnnox.com/v2/player/program/normal' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--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",
                "endTime":"22:00"
            },
            {
                "weekDays":[
                    0,
                    6
                ],
                "startTime":"00:33",
                "endTime":"22: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]

必需

下发成功的播放器ID集合

fail

array[string]

必需

下发失败的播放器ID集合

示例

{
  "success": [
    "6226495f8a030b075e2f6757236620e2"
  ],
  "fail": [
    "6226495f8a030b075e2f6757sdf620e2"
  ]
}

请求参数

示例代码

返回响应