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

dingtalk.corp.report.list (查询企业员工发出的日志列表)

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

公共参数

请求地址：

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

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

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

响应参数

名称	类型	示例值	描述
result	DingOpenResult	{}	result
result PageVo {} result data_list ReportOapiVo [] [] 日志列表 contents JsonObject [] [] 日志内容 └ sort String 1 排序 └ type String 0 类型 └ value String 开发工作用户填写的内容 └ key String 今日工作模板内容 └ 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 是否还有下一页 └ ding_open_errcode Number -1 dingOpenErrcode └ error_msg String 系统异常 errorMsg └ success Boolean -1 success

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpReportListRequest req = new CorpReportListRequest();
req.setStartTime(1507564800000L);
req.setEndTime(1507564800000L);
req.setTemplateName("周报");
req.setUserid("xxxxx");
req.setCursor(0L);
req.setSize(10L);
CorpReportListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://eco.taobao.com/router/rest");
CorpReportListRequest req = new CorpReportListRequest();
req.StartTime = 1507564800000L;
req.EndTime = 1507564800000L;
req.TemplateName = "周报";
req.Userid = "xxxxx";
req.Cursor = 0L;
req.Size = 10L;
CorpReportListResponse 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_TOP, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new CorpReportListRequest;
$req->setStartTime("1507564800000");
$req->setEndTime("1507564800000");
$req->setTemplateName("周报");
$req->setUserid("xxxxx");
$req->setCursor("0");
$req->setSize("10");
$resp = $c->execute($req, $access_token, "https://eco.taobao.com/router/rest");

curl -X POST "https://eco.taobao.com/router/rest" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'format=json' \
-d 'method=dingtalk.corp.report.list' \
-d 'partner_id=apidoc' \
-d 'session=2821f375-c28b-4141-b2fb-57840cce2680' \
-d 'timestamp=2025-04-24+15%3A34%3A59' \
-d 'v=2.0' \
-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.CorpReportListRequest("https://eco.taobao.com/router/rest")

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.corp.report.list");
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.corp.report.list', {
	'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);
})

响应示例

XML示例
JSON示例

<dingtalk_corp_report_list_response>
    <result>
        <result>
            <data_list>
                <report_oapi_vo>
                    <contents>
                        <json_object>
                            <sort>1</sort>
                            <type>0</type>
                            <value>开发工作</value>
                            <key>今日工作</key>
                        </json_object>
                    </contents>
                    <remark>这是备注</remark>
                    <template_name>日报</template_name>
                    <dept_name>部门1</dept_name>
                    <creator_name>一里</creator_name>
                    <creator_id>xxx</creator_id>
                    <create_time>1507564800000</create_time>
                    <report_id>xxxxxxx</report_id>
                </report_oapi_vo>
            </data_list>
            <size>10</size>
            <next_cursor>10000</next_cursor>
            <has_more>false</has_more>
        </result>
        <ding_open_errcode>-1</ding_open_errcode>
        <error_msg>系统异常</error_msg>
        <success>-1</success>
    </result>
</dingtalk_corp_report_list_response>

{
    "dingtalk_corp_report_list_response":{
        "result":{
            "result":{
                "data_list":{
                    "report_oapi_vo":[
                        {
                            "contents":{
                                "json_object":[
                                    {
                                        "sort":"1",
                                        "type":"0",
                                        "value":"开发工作",
                                        "key":"今日工作"
                                    }
                                ]
                            },
                            "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
            },
            "ding_open_errcode":-1,
            "error_msg":"系统异常",
            "success":-1
        }
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.corp.report.list (查询企业员工发出的日志列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ