# 获取留资直播数据详情
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getfinderlivedatalist
通过此接口可获取留资直播数据详情
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/finderlive/get_finder_live_data_list?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:160
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| start_time | number | 否 | 查询范围的开始时间(与关播时间对比) |
| end_time | number | 否 | 查询范围的结束时间(与关播时间对比) |
| last_buffer | string | 否 | 顺序翻页,传入上次请求返回的last_buffer, 会从上次返回的结果往后翻一页 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| last_buffer | string | 本次翻页的上下文,用于顺序翻页请求 |
| continue_flag | boolean | 是否还有直播 |
| item | objarray | 直播信息 |
# Res.item(Array) Object Payload
直播信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| export_id | string | 直播唯一id |
| live_start_time | number | 开播时间戳 |
| live_duration_in_seconds | number | 直播时长 |
| total_audience_count | number | 观看人数 |
| total_cheer_count | number | 喝彩次数 |
| forward_count | number | 分享次数 |
| total_comment_count | number | 评论条数 |
| audiences_avg_seconds | number | 人均观看时长 |
| max_online_count | number | 最高在线人数 |
| new_follow_count | number | 新增粉丝 |
| new_follow_count_biz | number | 公众号新增粉丝 |
# 4. 注意事项
该接口只包含2023.9.21号起,同时直播间有1min及以上的留资挂载才能导出对应直播数据
# 5. 代码示例
请求示例
{
"start_time": 1694142436,
"end_time": 1694228836,
"last_buffer": "EB4YAg"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"item": [
{
"export_id": "18881222222",
"live_start_time": 1694142436,
"live_duration_in_seconds": 3600,
"total_audience_count": 10000,
"total_cheer_count": 1000000,
"forward_count": 1000,
"total_comment_count": 10000,
"audiences_avg_seconds": 600,
"max_online_count": 200,
"new_follow_count": 10,
"new_follow_count_biz": 0
}
],
"last_buffer": "EB4YAg=",
"continue_flag": true
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -2 | 请求的参数错误 |
| 1 | 请求的信息不存在 |
| 48001 | 接口权限未开启,需前往视频号助手- 开放能力-开放场景 打开开关 |
| 100000 | 没有权限访问 |
# 7. 适用范围
本接口支持「视频号助手」账号类型调用。其他账号类型如无特殊说明,均不可调用。