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

dingtalk.oapi.report.simplelist (获取日志概要数据)

企业可以根据员工userid或者日志模板名称，分页获取员工一段时间范围内在【日志】微应用发送的日志概要信息

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
start_time	Number	必须	1507564800000	查询起始时间
end_time	Number	必须	1507564800000	查询截止时间
template_name	String	可选	周报	要查询的模板名称
userid	String	可选	xxxxx	员工的userid
cursor	Number	必须	0	查询游标，初始传入0，后续从上一次的返回值中获取
size	Number	必须	10	每页数据量

响应参数

名称	类型	示例值	描述
result	PageVo	{}	result
data_list ReportOapiVo [] 日志列表 └ remark String 这是备注备注 └ template_name String 日报日志模板名 └ dept_name String 部门1 部门 └ creator_name String 一里日志创建人 └ creator_id String xxx 日志创建人userid └ create_time Number 1507564800000 日志创建时间 └ report_id String xxxxxxx 日志唯一id └ size Number 10 分页大小 └ next_cursor Number 10000 nextCursor └ has_more Boolean false 是否还有下一页
errcode	Number	0	errcode
errmsg	String	ok	errmsg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/report/simplelist");
OapiReportSimplelistRequest req = new OapiReportSimplelistRequest();
req.setStartTime(1507564800000L);
req.setEndTime(1507564800000L);
req.setTemplateName("周报");
req.setUserid("xxxxx");
req.setCursor(0L);
req.setSize(10L);
OapiReportSimplelistResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/report/simplelist");
OapiReportSimplelistRequest req = new OapiReportSimplelistRequest();
req.StartTime = 1507564800000L;
req.EndTime = 1507564800000L;
req.TemplateName = "周报";
req.Userid = "xxxxx";
req.Cursor = 0L;
req.Size = 10L;
OapiReportSimplelistResponse 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 OapiReportSimplelistRequest;
$req->setStartTime("1507564800000");
$req->setEndTime("1507564800000");
$req->setTemplateName("周报");
$req->setUserid("xxxxx");
$req->setCursor("0");
$req->setSize("10");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/report/simplelist");

curl -X POST "https://oapi.dingtalk.com/topapi/report/simplelist" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=49076b20-1760-4ec7-a41a-3cfdfd74d11b' \
-d 'cursor=0' \
-d 'end_time=1507564800000' \
-d 'size=10' \
-d 'start_time=1507564800000' \
-d 'template_name=%E5%91%A8%E6%8A%A5' \
-d 'userid=xxxxx'

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

req=dingtalk.api.OapiReportSimplelistRequest("https://oapi.dingtalk.com/topapi/report/simplelist")

req.start_time=1507564800000
req.end_time=1507564800000
req.template_name="周报"
req.userid="xxxxx"
req.cursor=0
req.size=10
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.report.simplelist");
add_param(pRequest,"start_time","1507564800000");
add_param(pRequest,"end_time","1507564800000");
add_param(pRequest,"template_name","周报");
add_param(pRequest,"userid","xxxxx");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","10");
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.report.simplelist', {
	'start_time':'1507564800000',
	'end_time':'1507564800000',
	'template_name':'周报',
	'userid':'xxxxx',
	'cursor':'0',
	'size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "data_list":[
            {
                    "remark":"这是备注",
                    "template_name":"日报",
                    "dept_name":"部门1",
                    "creator_name":"一里",
                    "creator_id":"xxx",
                    "create_time":1507564800000,
                    "report_id":"xxxxxxx"
            }
        ],
        "size":10,
        "next_cursor":10000,
        "has_more":false
    },
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.report.simplelist (获取日志概要数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ