更新直播模版状态--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

更新直播模版状态

最近更新时间：2023.12.01 12:01:26首次发布时间：2023.02.01 14:10:46

更新直播模版上下架或删除状态。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateAccountTemplateStatusAPI`	接口名称。当前 API 的名称为 `UpdateAccountTemplateStatusAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数类型是否必选示例值描述

TemplateId Integer 是 1724367076931614 直播模版 ID。您可以通过 GetAccountTemplateAPI 接口查询 ID。

参数	类型	是否必选	示例值	描述
TemplateId	Integer	是	`1724367076931614`	直播模版 ID。您可以通过 GetAccountTemplateAPI 接口查询 ID。
Status	Integer	是	`3`	直播模版状态。支持以下取值： `2`：下架 `3`：上架 `4`：删除

Status

Integer

是

3

直播模版状态。支持以下取值：

2：下架
3：上架
4：删除

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	是否更新成功。支持以下取值： `true`：成功 `false`：失败

Status

Boolean

true

是否更新成功。支持以下取值：

true：成功
false：失败

示例

请求示例

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

{
  "TemplateId": 1724367076931614,
  "Status": 3
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230115233554395A95AB969C1BA439BB",
    "Action": "UpdateAccountTemplateStatusAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1673796954
  },
  "Result": {
    "Status": true
  }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter.TemplateIdNotFound	The specified parameter TemplateId is invalid.	`TemplateId` 参数不符合规范。请修改后重试。
400	InvalidParameter.StatusError	The specified parameter Status is invalid.	`Status` 参数不符合规范。请修改后重试。