调用 ListActivityLiveAnalysisHistories 接口,获取指定直播间的直播复盘场次列表,包括场次 ID、场次起始时间、场次评分等。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListActivityLiveAnalysisHistories | 接口名称。当前 API 的名称为 ListActivityLiveAnalysisHistories。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
ActivityId | Long | 是 |
| 直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| PageNumber | Integer | 否 | 1 | 分页查询页码。默认值为 1。取值大于等于 1。 |
| PageSize | Integer | 否 | 10 | 分页查询数量。默认取值为 10。取值范围为 [1,500]。 |
| LiveStartTime | Long | 否 | 1691450000 | 最早开播时间。用于筛选开播时间晚于或等于该时间的直播场次。Unix 时间戳,单位为秒。 |
| LiveEndTime | Long | 否 | 1691460000 | 最晚开播时间。用于筛选开播时间早于或等于该时间的直播场次。Unix 时间戳,单位为秒。 |
TotalGrade | String | 否 |
| 按直播评分筛选。取值如下:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| LiveHistories | Array of LiveHistories | - | 当前直播间的直播场次列表。 |
| TotalCount | Integer | 1 | 当前直播间的直播场次总数。 |
| ActivityName | String | 年度盛典直播 | 直播间名称。 |
CoverImage | String |
| 横屏直播的封面图 URL。取值情况如下:
|
VerticalCoverImage | String |
| 竖屏直播的封面图 URL。取值情况如下:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| HistoryId | Integer | 9876543210 | 直播复盘的场次 ID。 |
| OrderNumber | Integer | 1 | 直播复盘场次按开播时间从早到晚的次序 ID。 |
| StartTime | Integer | 1691452800 | 当前场次直播开始时间。Unix 时间戳,单位为秒。 |
| EndTime | Integer | 1691460000 | 当前场次直播结束时间。Unix 时间戳,单位为秒。 |
| Vid | String | v001 | 当前直播场次对应的视频 ID。 |
Status | Integer |
| 直播复盘报告生成状态。取值如下:
|
| CoverImage | String | https://example.com/cover.jpg | 当前场次对应的横屏封面图 URL,包含协议头。 |
TotalGrade | String |
| 当前场次的直播评分。取值如下
|
ErrorMessage | String |
| 报告生成失败的具体原因。取值如下:
说明 仅当 |
GET https://livesaas.volcengineapi.com/?Action=ListActivityLiveAnalysisHistories&Version=2023-08-01&ActivityId=1234567890&PageNumber=1&PageSize=10&LiveStartTime=1691450000&LiveEndTime=1691460000&TotalGrade=A
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListActivityLiveAnalysisHistories", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "LiveHistories": [ { "HistoryId": 9876543210, "OrderNumber": 1, "StartTime": 1691452800, "EndTime": 1691460000, "Vid": "v001", "Status": 1, "CoverImage": "https://example.com/cover.jpg", "TotalGrade": "A" } ], "TotalCount": 1, "ActivityName": "年度盛典直播", "CoverImage": "https://example.com/act_cover.jpg", "VerticalCoverImage": "https://example.com/act_v_cover.jpg" } }