文档中心 > API类目 > 钉钉API

dingtalk.oapi.kac.datav.videolive.viewer.list (查询视频直播观看人员列表)

查询指定场次的视频直播的观看人员列表（含回看人员）

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	GroupLiveViewerReq	必须			请求对象
└ cursor Number 必须 0 分页游标；首页请使用0，之后直接使用返回结果中的next_cursor └ live_uuid String 必须 90d34eb3-f4c1-4f7a-93cf-170a207e0382 直播uuid └ size Number 必须 100 分页大小;不超过500 └ openConversationId String 可选 cidwhyq0/E0uFxxxxxxQrixXw== 对外群id

响应参数

名称	类型	示例值	描述
errcode	Number	0	结果码
errmsg	String	成功	提示信息
result	GroupLiveViewerPageResult		结果对象
data GroupLiveViewer [] 列表数据项 └ play_duration Number 60000 观看直播时长（毫秒） └ play_duration_min String 1 观看直播时长（分钟） └ play_record_duration Number 60000 观看直播回放时长（毫秒） └ play_record_duration_min String 1 观看直播回放时长（分钟） └ userid String 12344 员工在当前企业内的唯一标识，也称staffId。可由企业在创建时指定，并代表一定含义比如工号，创建后不可修改 └ has_more Boolean false 是否有下一页；true则存在更多分页 └ next_cursor Number 0 下一次请求的分页游标

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/videolive/viewer/list");
OapiKacDatavVideoliveViewerListRequest req = new OapiKacDatavVideoliveViewerListRequest();
GroupLiveViewerReq obj1 = new GroupLiveViewerReq();
obj1.setCid("1234");
obj1.setCursor(0L);
obj1.setLiveUuid("90d34eb3-f4c1-4f7a-93cf-170a207e0382");
obj1.setSize(100L);
obj1.setOpenConversationId("cidwhyq0/E0uFxxxxxxQrixXw==");
req.setRequest(obj1);
OapiKacDatavVideoliveViewerListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/videolive/viewer/list");
OapiKacDatavVideoliveViewerListRequest req = new OapiKacDatavVideoliveViewerListRequest();
OapiKacDatavVideoliveViewerListRequest.GroupLiveViewerReqDomain obj1 = new OapiKacDatavVideoliveViewerListRequest.GroupLiveViewerReqDomain();
obj1.Cid = "1234";
obj1.Cursor = 0L;
obj1.LiveUuid = "90d34eb3-f4c1-4f7a-93cf-170a207e0382";
obj1.Size = 100L;
obj1.OpenConversationId = "cidwhyq0/E0uFxxxxxxQrixXw==";
req.Request_ = obj1;
OapiKacDatavVideoliveViewerListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiKacDatavVideoliveViewerListRequest;
$request = new GroupLiveViewerReq;
$request->cid="1234";
$request->cursor="0";
$request->live_uuid="90d34eb3-f4c1-4f7a-93cf-170a207e0382";
$request->size="100";
$request->openConversationId="cidwhyq0/E0uFxxxxxxQrixXw==";
$req->setRequest($request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/kac/datav/videolive/viewer/list");

curl -X POST "https://oapi.dingtalk.com/topapi/kac/datav/videolive/viewer/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=fb073762-23b8-48d7-8ea7-f6f5e4932f01' \
-d 'request=null'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiKacDatavVideoliveViewerListRequest("https://oapi.dingtalk.com/topapi/kac/datav/videolive/viewer/list")

req.request=""
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.kac.datav.videolive.viewer.list");
add_param(pRequest,"request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.kac.datav.videolive.viewer.list', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"成功",
    "result":{
        "data":[
            {
                    "play_duration":60000,
                    "play_duration_min":"1",
                    "play_record_duration":60000,
                    "play_record_duration_min":"1",
                    "userid":"12344"
            }
        ],
        "has_more":false,
        "next_cursor":0
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.kac.datav.videolive.viewer.list (查询视频直播观看人员列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ