You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

上架/下架/解绑回放

最近更新时间2022.10.24 18:36:56

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

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

请求说明

  • 接口名称:UpdateMediaOnlineStatusAPI
  • 请求方式:POST
  • 接口地址:http://livesaas.volcengineapi.com/?Action=UpdateMediaOnlineStatusAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

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

Query

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

Body

参数类型是否必选描述
ActivityIdInt64直播间 ID
MediaIdInt64回放列表视频 ID

OnlineStatus

Int32

回放播放状态操作。支持以下三种取值。

  • 0:下架;
  • 1:上架;
  • 2:解绑。

ForceReplayStatus

Bool

在活动状态为预告时,上架回放,是否将活动状态切换为回放中。

  • true:活动状态切换为回放中;
  • false:活动状态不切换。

返回参数

无。

示例

请求示例

POST http://livesaas.volcengineapi.com/?Action=UpdateMediaOnlineStatusAPI&Version=2020-06-01
{
    "ActivityId":732412312,	
    "MediaId":3706016,   
    "OnlineStatus":1,
    "ForceReplayStatus":true
}

正常返回示例

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

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"UpdateMediaOnlineStatusAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
    }
}

错误码

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