NovaCloud-CN

单页紧急插播节目

POST

/v2/player/emergency-program/page

提示

通过此接口可以制作紧急插播节目并下发给播放器。

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

高级接口。

请求参数

Header 参数

AppKey

string

接入键

必需

默认值:

Nonce

string

必需

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

CurTime

string

必需

当前 UTC 时间戳

CheckSum

string

请求签名

必需

Body 参数application/json

playerIds

array[string]

必需

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

attribute

object

紧急插播基本属性

必需

spotsType

string

必需

紧急插播类型。IMMEDIATELY - 立即插播；TIMING - 定时插播

normalProgramStatus

string

必需

普通节目播放状态。NORMAL - 正常播放；PAUSE - 暂停播放

duration

number

必需

插播播放时长，精确到毫秒，不能大于24小时

timingTime

string

可选

定时插播时间，如：12:00:00

backgroundColor

string

可选

文字页面背景色，16位数字色值，默认透明色，#00000000代表透明色

page

array [object {2}]

必需

需要播放的页面内容集合

name

string

页面名称

必需

widgets

array [object {9}]

页面上的组件集合

必需

示例

{
  "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
      }
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-cn.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
            }
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

success

array[string]

必需

下发成功的播放器ID集合

fail

array[string]

必需

下发失败的播放器ID集合

示例

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

修改于 2024-08-07 01:35:02

获取播放器配置状态

撤销紧急插播节目