钉钉开发文档

日志

更新时间: 2019-4-8

获取用户日志数据

企业使用此接口查询用户某个模板的日志情况,进行统计分析,也可以与自有业务系统对接,将日志的表单数据映射到业务系统。
企业可以根据员工userid或者日志模板名称,分页获取员工一段时间范围内钉钉日志应用发送的日志详细信息。

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/topapi/report/list?access_token=ACCESS_TOKEN
参数说明

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

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/report/list");
OapiReportListRequest request = new OapiReportListRequest();
request.setUserid("1226682231742708");
request.setStartTime(System.currentTimeMillis()-TimeUnit.DAYS.toMillis(3));
request.setEndTime(System.currentTimeMillis());
request.setCursor(0L);
request.setSize(10L);
OapiReportListResponse response = client.execute(request, accessToken);

返回结果

{
    "result":{
        "data_list":[
            {
                    "contents":[
                        {
                                "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
    },
    "errcode":0,
    "errmsg":"ok"
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
result
└ data_list 日志列表
└ contents 日志内容
└ sort 排序
└ type 类型
└ value 用户填写的内容
└ key 模板内容
└ remark 备注
└ template_name 日志模板名
└ dept_name 部门
└ creator_name 日志创建人
└ creator_id 日志创建人userid
└ create_time 日志创建时间
└ report_id 日志唯一id
└ size 分页大小
└ next_cursor 下一游标
└ has_more 是否还有下一页

获取用户可见的日志模板

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/topapi/report/template/listbyuserid?access_token=ACCESS_TOKEN
参数说明

名称 类型 是否必须 示例值 描述
userid String 可选,不传表示获取企业的所有模板 manager7078 用户id
offset Number 必须 0 分页游标,从0开始。根据返回结果里的next_cursor是否为空来判断是否还有下一页,且再次调用时offset设置成next_cursor的值
size Number 必须 100 分页大小,最大可设置成100

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/report/template/listbyuserid");
OapiReportTemplateListbyuseridRequest req = new OapiReportTemplateListbyuseridRequest();
req.setUserid("manager7078");
req.setOffset(0L);
req.setSize(100L);
OapiReportTemplateListbyuseridResponse rsp = client.execute(req, accessToken);

返回结果

{
    "errcode":0,
    "errmsg":"成功",
    "result":{
        "template_list":[
            {
                    "name":"日报",
                    "icon_url":"https:\/\/landray.dingtalkapps.com\/alid\/app\/report\/images\/ico-png\/0.png",
                    "report_code":"14e882e7fd7e774e40ce9d144ddaa84d",
                    "url":"https:\/\/landray.dingtalkapps.com\/alid\/app\/report\/createReport_new.html?skip=0&corpid=${corpid}&id=${report_code}"
            }
        ],
        "next_cursor":100
    }
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
template_list 日志模板列表
└ name 日志模板名称
└ icon_url 图标url
└ report_code 模板唯一标识
└ url 模板跳转url
next_cursor 下一次分页调用的offset值,当返回结果里没有next_Cursor时,表示分页结束

获取用户日志未读数

请求方式:POST(HTTPS)
请求地址https://oapi.dingtalk.com/topapi/report/getunreadcount?access_token=ACCESS_TOKEN
参数说明

名称 类型 是否必须 示例值 描述
userid String 必须 manager7078 用户id

SDK请求示例(JAVA)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/report/getunreadcount");
OapiReportGetunreadcountRequest request = new OapiReportGetunreadcountRequest();
request.setUserid("1226682231742708");
OapiReportGetunreadcountResponse response = client.execute(request,accessToken);

返回结果

{
    "errcode": 0,
    "errmsg": "ok",
    "count": 1
}
参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
count 日志未读数
以上内容是否对您有帮助:
在文档使用中是否遇到以下问题(多选):
  • 内容错误
  • 更新不及时
  • 链接错误
  • 缺少代码/图片示例
  • 太简单/步骤待完善
手机号
更多建议
提交成功,感谢您的反馈!