您可通过此接口获取当前账号下的直播模版列表。
请求频率:单用户请求频率限制为 120 次/分钟。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetAccountTemplateAPI | 接口名称。当前 API 的名称为 GetAccountTemplateAPI 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
PageNo | Integer | 否 | 1 | 分页查询页码,默认值为 1 。 |
PageItemCount | Integer | 否 | 10 | 分页查询数量,默认值为 10 。 |
Status | Integer | 否 |
| 根据模版状态进行筛选,默认值为
|
Keyword | String | 否 | 模版名称 | 根据模版名称进行模糊筛选。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TemplateList | Array of TemplateList | - | 直播模版信息列表。 |
PageNo | Integer | 1 | 分页查询页码。 |
PageItemCount | Integer | 10 | 分页查询数量。 |
TotalItemCount | Integer | 1 | 查询结果总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TemplateId | Integer | 1724367076931614 | 直播模版 ID。 |
TemplateName | String | 模版名称 | 直播模版名称。 |
Status | Integer |
| 直播模版状态。取值如下:
|
CoverImage | String | //p.xxx.image | 直播间的封面图 URL。 |
Describe | String | 模板的描述信息 | 直播模版的描述信息。 |
ModifyTime | Integer | 1673203160 | 直播模板的更新时间。Unix 时间戳,单位为秒。 |
IsSystemTemplate | Integer |
| 直播模板类型。取值如下:
|
IsDefaultTemplate | Integer |
| 是否为默认模版。取值如下:
|
LiveLayout | Integer |
| 直播模式。取值如下:
|
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.xxx.image", "Describe": "模板的描述信息", "ModifyTime": 1673203160, "IsSystemTemplate": 2, "IsDefaultTemplate": 1, "LiveLayout": 2 } ] } }