You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

上架/下架/解绑回放

最近更新时间：2023.12.05 10:31:12

首次发布时间：2022.03.29 22:10:12

我的收藏

对回放视频进行上架、下架和解绑操作。操作前需要先上传回放。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

  • 请求方式：POST
  • 请求地址：https://livesaas.volcengineapi.com/?Action=UpdateMediaOnlineStatusAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是UpdateMediaOnlineStatusAPI接口名称。当前 API 的名称为 UpdateMediaOnlineStatusAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。

Body

参数类型是否必选示例值描述
ActivityIdLong是1772441830705直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
MediaIdLong是3706016回放列表视频 ID。您可以通过 ListMediasAPI 接口查询 ID（即返回参数 MediaId）。

OnlineStatus

Integer

是

1

设置回放视频的状态。支持以下取值：

  • 0：下架
  • 1：上架
  • 2：解绑

ForceReplayStatus

Boolean

否

true

在直播状态为预告或已结束时，上架回放（即 OnlineStatus 取值为 1），是否将直播状态切换为回放。默认取值为 false。

  • true：切换，则直播状态切换为回放并播放上架的回放视频。
  • false：不切换，则直播状态不变且不播放上架的回放视频。

返回参数

无。

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateMediaOnlineStatusAPI&Version=2020-06-01

{
  "ActivityId": 1772441830705,
  "MediaId": 3706016,
  "OnlineStatus": 1,
  "ForceReplayStatus": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateMediaOnlineStatusAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1655978114
  }
}

错误码

访问公共错误码和错误码获取详细信息。