第三方应用开发 服务端API 直播 获取直播观看明细
获取直播观看明细
最后更新:2023/12/01
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取直播观看明细
最后更新:2023/12/01

通过该接口可以获取所有观看直播的人员统计

请求方式:POST(HTTPS
请求地址:https://qyapi.weixin.qq.com/cgi-bin/living/get_watch_stat?access_token=ACCESS_TOKEN

请求包体:

{
	"livingid": "livingid1",
	"next_key": "NEXT_KEY"
}

参数说明:

参数必须说明
access_token调用接口凭证
livingid直播的id
next_key上一次调用时返回的next_key,初次调用可以填"0"

权限说明:

应用类型权限要求
自建应用配置到「上课直播/直播 - 可调用接口的应用」中
代开发应用具有「直播」权限
第三方应用具有「直播」权限
  • 能获取本应用创建的直播

注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

返回结果:

{
   "errcode": 0,
   "errmsg": "ok",
   "ending":1,
   "next_key": "NEXT_KEY",
   "stat_info":{
		"users":[
            {
                "userid": "userid",
                "watch_time": 30,
                "is_comment": 1,
				"is_mic": 1
            }
        ],
		"external_users":[
            {
                "external_userid": "external_userid1",
				"type": 1,
				"name": "user name",
                "watch_time": 30,
                "is_comment": 1,
				"is_mic": 1
            },
			{
                "external_userid": "external_userid2",
				"type": 2,
				"name": "user_name",
                "watch_time": 30,
                "is_comment": 1,
				"is_mic": 1
            }
        ],
   }
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
ending是否结束。0:表示还有更多数据,需要继续拉取,1:表示已经拉取完所有数据。注意只能根据该字段判断是否已经拉完数据
next_key当前数据最后一个key值,如果下次调用带上该值则从该key值往后拉,用于实现分页拉取
stat_info统计信息列表
stat_info.users观看直播的企业成员列表
stat_info.users.userid企业成员的userid
stat_info.users.watch_time观看时长,单位为秒
stat_info.users.is_comment是否评论。0-否;1-是
stat_info.users.is_mic是否连麦发言。0-否;1-是
stat_info.users.invitor_userid邀请人的userid
stat_info.users.invitor_external_userid邀请人的external_userid
stat_info.external_users观看直播的外部成员列表
stat_info.external_users.external_userid外部成员的userid
stat_info.external_users.type外部成员类型,1表示该外部成员是微信用户,2表示该外部成员是企业微信用户
stat_info.external_users.name外部成员的名称
stat_info.external_users.watch_time观看时长,单位为秒
stat_info.external_users.is_comment是否评论。0-否;1-是
stat_info.external_users.is_mic是否连麦发言。0-否;1-是
stat_info.external_users.invitor_userid邀请人的userid,邀请人为企业内部成员时返回(观众首次进入直播时,其使用的直播卡片/二维码所对应的分享人;仅“推广产品”直播支持)
stat_info.external_users.invitor_external_userid邀请人的external_userid,邀请人为非企业内部成员时返回(观众首次进入直播时,其使用的直播卡片/二维码所对应的分享人;仅“推广产品”直播支持)
上一篇
获取直播详情
下一篇
直播回调事件