查询直播观看人员信息

GET

/v1.0/live/lives/watchUsers

**
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，查询直播观看人员的具体观看信息。

调用本接口，根据直播ID，查询直播观看人员的信息，可获取的信息如下：

企业内部应用调用本接口，可获取以下信息：

当前组织内的员工观看直播信息，包括员工userId、姓名、观看时长等。

非当前组织内的成员观看直播信息，包括成员昵称、观看时长等。

第三方企业应用调用本接口，可获取以下信息：

当前组织内的员工观看直播信息，包括员工userId、姓名、观看时长等。

非当前组织内的成员观看直播信息，只能获取到观看时长。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉钉直播获取数据读权限	API Explorer
第三方企业应用	支持	钉钉直播获取数据读权限	API Explorer
第三方个人应用	暂不支持	钉钉直播获取数据读权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParam	lippi_live.stream.paramError	参数错误，该直播不存在
500	serviceError	error:%s	系统服务错误

请求参数

Query 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dingtalk.com/v1.0/live/lives/watchUsers?liveId=String&unionId=String&pageNumber=Integer&pageSize=Integer'

响应示例

{
    "result": {
        "orgUsesList": [
            {
                "unionId": "string",
                "userId": "string",
                "name": "string",
                "deptName": "string",
                "watchLiveTime": 0,
                "watchPlaybackTime": 0,
                "watchProgressMs": 0
            }
        ],
        "outOrgUserList": [
            {
                "name": "string",
                "watchLiveTime": 0,
                "watchPlaybackTime": 0,
                "watchProgressMs": 0
            }
        ]
    }
}

修改于 2024-01-16 08:10:28

修改直播属性信息

概述

查询直播观看人员信息

权限#

错误码#

请求参数

返回响应

权限

错误码