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

获取直播模版列表

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

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

获取当前账号下的直播模版列表。

请求说明

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

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
PageNoInt分页查询页码,默认取值为 1
PageItemCountInt分页查询数量,默认取值为 10

Status

Int

根据模版状态进行筛选,默认取值为 0

  • 0:查询全部模版;
  • 1:查询已创建和下架状态的模版
KeywordString根据模版名称进行筛选

返回参数

参数类型描述
TemplateListArray of Template直播模版信息列表
PageNoInt分页查询页码
PageItemCountInt分页查询数量
TotalItemCountInt查询结果总数

Template

参数类型描述
TemplateIdInt模版 ID
TemplateNameString模版名称

Status

Int

模版的状态

  • 1:已创建
  • 2:下架
  • 3:上架
CoverImageString直播封面图的 URL
DescribeString模版的描述信息
ModifyTimeInt模板的更新时间,Unix 时间戳,单位为秒

IsSystemTemplate

Int

是否为在运营后台创建的系统模版,系统模版不支持修改

  • 1:系统模版
  • 2:自定义模版

IsDefaultTemplate

Int

是否为默认模版

  • 0:否
  • 1:是

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetAccountTemplateAPI&Version=2020-06-01&Status=0

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230115231938FA71DB55CB36FBD4335F",
        "Action": "GetAccountTemplateAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1673795978
    },
    "Result": {
        "PageNo": 1,
        "PageItemCount": 10,
        "TotalItemCount": 1,
        "TemplateList": [
            {
                "TemplateId": 1724367076931614,
                "TemplateName": "模版名称",
                "Status": 3,
                "CoverImage": "//p-boe.xxx.image",
                "Describe": "模板的描述信息",
                "ModifyTime": 1673203160,
                "IsSystemTemplate": 2,
                "IsDefaultTemplate": 1
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023011523363514F57417519398A3684C",
        "Action": "GetAccountTemplateAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InternalError",
            "Message": "The request has failed due to an unknown error."
        },
        "SystemTime": 1673796996
    },
    "Result": null
}

错误码

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

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