请求方式:GET(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
livingid | 是 | 直播ID |
权限说明:
应用类型 | 权限要求 |
---|---|
自建应用 | 配置到「上课直播 - 可调用接口的应用」和「家长可以使用的应用」中 |
代开发应用 | 具有「直播」和「家校沟通」权限 |
第三方应用 | 具有「直播」和「家校沟通」权限 |
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"living_info":{
"theme": "直角三角形讲解",
"living_start": 1586405229,
"living_duration": 1800,
"anchor_userid": "zhangsan",
"living_range":{
"partyids":[1,4,9],
"group_names":[
"group_name1",
"group_name2"
]
},
"viewer_num": 100,
"comment_num": 110,
"open_replay": 1,
"push_stream_url": "https://www.qq.test.com",
"online_count": 1,
"subscribe_count": 1
}
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
living_info | 直播信息 |
living_info.theme | 直播主题 |
living_info.living_start | 直播开始时间戳 |
living_info.living_duration | 直播时长,单位为秒 |
living_info.anchor_userid | 主播的userid |
living_info.living_range | 直播范围,如果直播范围包含的是班级群,优先返回班级群对应班级的partyid,否则直接返回群名称 |
living_info.living_range.partyids | 班级的partyid列表 |
living_info.living_range.group_names | 群名称列表 |
living_info.viewer_num | 观看直播总人数 |
living_info.comment_num | 评论数 |
living_info.open_replay | 是否开启回放,1表示开启,0表示关闭 |
living_info.push_stream_url | 推流地址,仅直播类型为活动直播并且直播状态是待开播返回该字段 |
living_info.online_count | 当前在线观看人数 |
living_info.subscribe_count | 直播预约人数 |