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

更新直播模版状态

最近更新时间2023.02.01 14:10:46

首次发布时间2023.02.01 14:10:46

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选描述
TemplateIdInt直播模版 ID。您可以通过调用 GetAccountTemplateAPI 接口查询 ID

Status

Int

模版状态

  • 2:下架
  • 3:上架
  • 4:删除

返回参数

参数类型描述

Status

Bool

是否更新成功

  • true:更新成功
  • false:更新失败

示例

请求示例

POST http://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
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023012817001358B0888A378675F3209D",
        "Action": "UpdateAccountTemplateStatusAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InvalidParameter.StatusError",
            "Message": "The specified parameter Status is invalid."
        },
        "SystemTime": 1674896413
    },
    "Result": null
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.TemplateIdNotFoundThe specified parameter TemplateId is invalid.直播间模版 ID 不符合规范,请修改后重试
400InvalidParameter.StatusErrorThe specified parameter Status is invalid.模版状态不符合规范,请修改后重试
500InternalErrorThe request has failed due to an unknown error.请求处理过程中出现了未知错误,请联系技术支持获取帮助