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

获取直播模版列表

最近更新时间：2023.12.01 10:08:49

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

我的收藏

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

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetAccountTemplateAPI接口名称。当前 API 的名称为 GetAccountTemplateAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
PageNoInteger否1分页查询页码，默认取值为 1。
PageItemCountInteger否10分页查询数量，默认取值为 10。

Status

Integer

否

0

根据模版状态进行筛选，支持以下取值，默认取值为 0。

  • 0：全部模版
  • 1：已创建和下架状态的模板
KeywordString否模版名称根据模版名称进行模糊筛选。

返回参数

参数类型示例值描述
TemplateListArray of TemplateList-直播模版信息列表。
PageNoInteger1分页查询页码。
PageItemCountInteger10分页查询数量。
TotalItemCountInteger1查询结果总数。

TemplateList

参数类型示例值描述
TemplateIdInteger1724367076931614直播模版 ID。
TemplateNameString模版名称直播模版名称。

Status

Integer

3

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

  • 1：已创建
  • 2：下架
  • 3：上架
CoverImageString//p-boe.xxx.image直播间的封面图 URL。
DescribeString模板的描述信息直播模版的描述信息。
ModifyTimeInteger1673203160直播模板的更新时间。Unix 时间戳，单位为秒。

IsSystemTemplate

Integer

2

直播模板类型。支持以下取值：

  • 1：运营后台创建的系统模版。不支持修改。
  • 2：自定义模版

IsDefaultTemplate

Integer

1

是否为默认模版。支持以下取值：

  • 0：否
  • 1：是

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetAccountTemplateAPI&Version=2020-06-01&PageNo=1&PageItemCount=10&Status=0&Keyword=模版名称

返回示例

{
  "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
      }
    ]
  }
}

错误码

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