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

dingtalk.oapi.live.grouplive.viewrecord (拉取直播观看记录明细数据)

根据直播uuid和群id，拉取本群所有人直播/回放观看记录明细。如：谁/什么时候开始/什么时候结束/看了多久/直播还是回放

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	描述
live_uuid	String	必须	dfg-dfg-dfh	直播uuid
page_index	Number	必须	0	分页拉取
page_size	Number	必须	100	一页多少数据，默认100
dept_id	Number	必须	456723	部门id

响应参数

名称	类型	示例值	描述
result	QueryLiveViewRecordDetail		返回结果
record_list UserViewRecordDetailModelList [] 用户观看记录 └ live_end_unix_time Number 1606889856 结束观看时间戳 └ live_begin_unix_time Number 1606889756 开始观看时间戳 └ view_type Number 0 0：直播 1：回放 └ user_name String 神秘用户用户名 └ watch_time_second Number 100 观看时长，单位s └ user_id String 3463456 用户id └ title String 神秘标题直播标题 └ live_uuid String dfg-dfg-dfh-dfh 直播uuid └ group_name String 神秘群名称群名称 └ has_more Boolean false 是否分页拉取完成，true：完成 └ dept_id Number 34534 部门id
errcode	Number	400002	错误码
errmsg	String	参数错误	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/grouplive/viewrecord");
OapiLiveGroupliveViewrecordRequest req = new OapiLiveGroupliveViewrecordRequest();
req.setLiveUuid("dfg-dfg-dfh");
req.setPageIndex(0L);
req.setPageSize(100L);
req.setDeptId(456723L);
OapiLiveGroupliveViewrecordResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/live/grouplive/viewrecord");
OapiLiveGroupliveViewrecordRequest req = new OapiLiveGroupliveViewrecordRequest();
req.LiveUuid = "dfg-dfg-dfh";
req.PageIndex = 0L;
req.PageSize = 100L;
req.DeptId = 456723L;
OapiLiveGroupliveViewrecordResponse 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 OapiLiveGroupliveViewrecordRequest;
$req->setLiveUuid("dfg-dfg-dfh");
$req->setPageIndex("0");
$req->setPageSize("100");
$req->setDeptId("456723");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/live/grouplive/viewrecord");

curl -X POST "https://oapi.dingtalk.com/topapi/live/grouplive/viewrecord" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=aab248c7-a69c-4f10-a66a-a1b63fb165a1' \
-d 'dept_id=456723' \
-d 'live_uuid=dfg-dfg-dfh' \
-d 'page_index=0' \
-d 'page_size=100'

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

req=dingtalk.api.OapiLiveGroupliveViewrecordRequest("https://oapi.dingtalk.com/topapi/live/grouplive/viewrecord")

req.live_uuid="dfg-dfg-dfh"
req.page_index=0
req.page_size=100
req.dept_id=456723
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.live.grouplive.viewrecord");
add_param(pRequest,"live_uuid","dfg-dfg-dfh");
add_param(pRequest,"page_index","0");
add_param(pRequest,"page_size","100");
add_param(pRequest,"dept_id","456723");
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.live.grouplive.viewrecord', {
	'live_uuid':'dfg-dfg-dfh',
	'page_index':'0',
	'page_size':'100',
	'dept_id':'456723'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "record_list":[
            {
                    "live_end_unix_time":1606889856,
                    "live_begin_unix_time":1606889756,
                    "view_type":0,
                    "user_name":"神秘用户",
                    "watch_time_second":100,
                    "user_id":"3463456"
            }
        ],
        "title":"神秘标题",
        "live_uuid":"dfg-dfg-dfh-dfh",
        "group_name":"神秘群名称",
        "has_more":false,
        "dept_id":34534
    },
    "errcode":400002,
    "errmsg":"参数错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.live.grouplive.viewrecord (拉取直播观看记录明细数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ