获取直播观看明细

POST

/cgi-bin/living/get_watch_stat

服务端API第三方应用开发企业内部开发

权限说明：「上课直播/直播」应用有获取用户的所有直播自建应用和第三方应用只能获取本应用创建的直播

文档ID: 21999
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/93716
https://open.work.weixin.qq.com/api/doc/90000/90135/93636

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/living/get_watch_stat?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{"livingid":"livingid1","next_key":"NEXT_KEY"}'

响应示例

{
   "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
            }
        ],
   }
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

livingid

string

直播的id

必需

next_key

string

可选

上一次调用时返回的next_key，初次调用可以填”0”

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

ending

integer <int32>

可选

是否结束。0：表示还有更多数据，需要继续拉取，1：表示已经拉取完所有数据。注意只能根据该字段判断是否已经拉完数据

next_key

string

可选

当前数据最后一个key值，如果下次调用带上该值则从该key值往后拉，用于实现分页拉取

errmsg

string

可选

对返回码的文本描述内容

stat_info

object

统计信息列表

可选

external_users

array [object {8}]

可选

观看直播的外部成员列表

users

array [object {4}]

可选

观看直播的企业成员列表

获取直播详情

获取跳转小程序商城的直播观众信息