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

dingtalk.oapi.kac.datav.videolive.detail.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	VideoLiveDetailRequest	必须			请求参数对象
└ data_id String 必须 20200401 日期标识 └ size Number 必须 10 分页大小;不超过100 └ cursor Number 必须 0 分页游标；首页请使用0，之后直接使用返回结果中的next_cursor

响应参数

名称	类型	示例值	描述
errcode	Number	100	错误码
errmsg	String	成功	错误信息
result	VideoLiveDetailResponse	result	结果对象
└ has_more Boolean false 是否有下一页；true则存在更多分页 └ next_cursor Number 100 下一次请求的分页游标 data VideoLiveDetailVo [] data 数据明细列表 └ group_name String 直播演示群直播群名称 └ group_user_count Number 100 群人数 └ live_watch_count Number 10 观看直播次数 └ live_watch_duration String 1000 直播时长（秒） └ live_watch_end_time String 2020-04-08 10:54:03 直播结束时间 └ live_watch_start_time String 2020-04-08 09:54:03 直播开始时间 └ live_watch_title String 演示教学课直播标题 └ live_watch_user_count Number 10 观看直播人数 └ userid String 1234 员工在当前企业内的唯一标识，也称staffId。可由企业在创建时指定，并代表一定含义比如工号，创建后不可修改 └ staff_name String 王小毛直播发起人用户名称 └ uuid String 21232d87-2b63-4f68-9c0a-db54ddd72379 直播uuid └ dept_id Number 1233 部门ID └ dept_name String 部门名称部门名称 └ staff_job_num String 10002 直播发起人员工工号 └ live_watch_duration_min String 10.123 直播时长（分钟） └ openConversationId String cid123h12k3h12k 群对外开放的id

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/videolive/detail/list");
OapiKacDatavVideoliveDetailListRequest req = new OapiKacDatavVideoliveDetailListRequest();
VideoLiveDetailRequest obj1 = new VideoLiveDetailRequest();
obj1.setDataId("20200401");
obj1.setSize(10L);
obj1.setCursor(0L);
req.setRequest(obj1);
OapiKacDatavVideoliveDetailListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/datav/videolive/detail/list");
OapiKacDatavVideoliveDetailListRequest req = new OapiKacDatavVideoliveDetailListRequest();
OapiKacDatavVideoliveDetailListRequest.VideoLiveDetailRequestDomain obj1 = new OapiKacDatavVideoliveDetailListRequest.VideoLiveDetailRequestDomain();
obj1.DataId = "20200401";
obj1.Size = 10L;
obj1.Cursor = 0L;
req.Request_ = obj1;
OapiKacDatavVideoliveDetailListResponse 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 OapiKacDatavVideoliveDetailListRequest;
$request = new VideoLiveDetailRequest;
$request->data_id="20200401";
$request->size="10";
$request->cursor="0";
$req->setRequest($request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/kac/datav/videolive/detail/list");

curl -X POST "https://oapi.dingtalk.com/topapi/kac/datav/videolive/detail/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=78d417cb-b816-4e39-82ac-237f1b63ed51' \
-d 'request=null'

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

req=dingtalk.api.OapiKacDatavVideoliveDetailListRequest("https://oapi.dingtalk.com/topapi/kac/datav/videolive/detail/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.detail.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.detail.list', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":100,
    "errmsg":"成功",
    "result":{
        "has_more":false,
        "next_cursor":100,
        "data":[
            {
                    "group_name":"直播演示群",
                    "group_user_count":100,
                    "live_watch_count":10,
                    "live_watch_duration":"1000",
                    "live_watch_end_time":"2020-04-08 10:54:03",
                    "live_watch_start_time":"2020-04-08 09:54:03",
                    "live_watch_title":"演示教学课",
                    "live_watch_user_count":10,
                    "userid":"1234",
                    "staff_name":"王小毛",
                    "uuid":"21232d87-2b63-4f68-9c0a-db54ddd72379",
                    "dept_id":1233,
                    "dept_name":"部门名称",
                    "staff_job_num":"10002",
                    "live_watch_duration_min":"10.123",
                    "openConversationId":"cid123h12k3h12k"
            }
        ]
    }
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.kac.datav.videolive.detail.list (查询视频直播明细列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ