You need to enable JavaScript to run this app.
导航
获取直播模板列表
最近更新时间:2025.01.22 10:47:47首次发布时间:2023.02.01 14:10:46

调用 GetAccountTemplateAPI 接口获取直播模板列表。

注意事项

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

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringGetAccountTemplateAPI接口名称。当前 API 的名称为 GetAccountTemplateAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01
PageNoInteger1分页查询页码。默认值为 1。取值大于等于 1。
PageItemCountInteger10分页查询数量。默认值为 10

Status

Integer

0

模板状态。默认值为 0。取值如下:

  • 0:所有状态
  • 1:已创建和下架
KeywordStringA模板名称。支持模糊搜索。

返回参数

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

TemplateList

参数类型示例值描述
TemplateIdInteger172436****931614直播模板 ID。
TemplateNameString模板 A直播模板名称。

Status

Integer

3

直播模板状态。取值如下:

  • 1:已创建
  • 2:下架
  • 3:上架
CoverImageString//p.xxx.image直播间的封面图 URL。
DescribeString这是一个模板直播模板的描述信息。
ModifyTimeInteger1673203160直播模板的更新时间。Unix 时间戳,单位为秒。

IsSystemTemplate

Integer

2

直播模板类型。取值如下:

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

IsDefaultTemplate

Integer

1

是否为默认模板。取值如下:

  • 0:否
  • 1:是

LiveLayout

Integer

2

直播模式。取值如下:

  • 1:三分屏。主播画面和视频画面使用不同视频源,主播画面不会遮挡视频画面。详见三分屏直播
  • 2:纯视频。主播画面和视频画面共用一个视频源,支持调整主播画面位置

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetAccountTemplateAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TemplateList": [
            {
                "TemplateId": 172436****931614,
                "TemplateName": "模板 A",
                "Status": 3,
                "CoverImage": "//p.xxx.image",
                "Describe": "这是一个模板",
                "ModifyTime": 1673203160,
                "IsSystemTemplate": 2,
                "IsDefaultTemplate": 1,
                "LiveLayout": 2
            }
        ],
        "PageNo": 1,
        "PageItemCount": 10,
        "TotalItemCount": 1
    }
}

错误码

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