最近更新时间:2023.02.01 14:10:46
首次发布时间:2023.02.01 14:10:46
获取当前账号下的直播模版列表。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称 |
Version | String | 是 | 接口版本。直播当前 API 的版本为 2020-06-01 |
PageNo | Int | 否 | 分页查询页码,默认取值为 1 |
PageItemCount | Int | 否 | 分页查询数量,默认取值为 10 |
Status | Int | 否 | 根据模版状态进行筛选,默认取值为
|
Keyword | String | 否 | 根据模版名称进行筛选 |
参数 | 类型 | 描述 |
---|---|---|
TemplateList | Array of Template | 直播模版信息列表 |
PageNo | Int | 分页查询页码 |
PageItemCount | Int | 分页查询数量 |
TotalItemCount | Int | 查询结果总数 |
参数 | 类型 | 描述 |
---|---|---|
TemplateId | Int | 模版 ID |
TemplateName | String | 模版名称 |
Status | Int | 模版的状态
|
CoverImage | String | 直播封面图的 URL |
Describe | String | 模版的描述信息 |
ModifyTime | Int | 模板的更新时间,Unix 时间戳,单位为秒 |
IsSystemTemplate | Int | 是否为在运营后台创建的系统模版,系统模版不支持修改
|
IsDefaultTemplate | Int | 是否为默认模版
|
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 }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.ActivityIDInvalid | The specified parameter ActivityID is invalid. | 直播间 ID 不符合规范,请修改后重试 |
500 | InternalError | The request has failed due to an unknown error. | 请求处理过程中出现了未知错误,请联系技术支持获取帮助 |