使用教程

本文介绍第三方企业系统如何集成钉钉日志。

本文介绍了创建一个企业内部应用，使用日志提供的API，实现在第三方系统中直接发起钉钉日志。

说明

本流程的案例实现仅支持钉钉PC客户端内实现，手机端暂不支持。

接入流程

登录开发者后台，创建企业内部应用。

应用类型：选择H5微应用。

开发方式：选择企业自主开发。

获取AppKey和AppSecret。

添加接口调用权限，开通日志项的所有权限点。

获取应用访问凭证获取企业内部应用的access_token。调用接口时，通过accessToken鉴权调用者身份。

手动在钉钉的日志中创建一个日志模板。

说明

创建的模板内组件目前只支持文本类型

调用保存日志内容接口，获取contentId。

拼接URL，在三方系统页面内访问该URL，可以跳转进入日志发起页面，拼接的URL如下

dingtalk://dingtalkclient/action/openapp?corpid={corpid}
&container_type=work_platform
&app_id=2
&redirect_type=jump
&redirect_url="+encodeURIComponent("https://landray.dingtalkapps.com/alid/app/reportpc/createreport.html?corpid={corpid}&templateid={templateid}&contentid={contentid}&callbackUrl={callback_url}&dd_from=ThirdParty")

说明

URL参数说明

corpId: 该日志模板所在企业的CorpId，登录钉钉开发者后台获取。

container_type:固定值work_platform。

app_id:固定值2。

templateid：日志模板Id，调用获取模板详情接口获取。

contentid: 调用保存日志内容接口返回的contentId。

redirect_url：跳转的日志提交页面地址，必须encodeURL处理。

callbackUrl：第三方自己提供的回调的url，用于用户提交日志成功之后，通知第三方生成的日志ID，第三方可以基于此ID拼接成日志详情页的url，可以关联到钉钉里面的日志详情。(回调的url由企业自己提供，钉钉日志前端在提交日志时会带上这个url，服务端在提交日志成功之后触发回调。)

dd_from：固定为ThirdParty。

说明

callbackUrl的说明

提交日志成功时，钉钉服务器会以GET请求的方式，请求构造的回调URL

例如，开发者构造的回调URL为http://www.dingtalk.com/callback，提交日志时，钉钉服务器的请求为

GET http://www.dingtalk.com/callback?reportId=17d6xxxxxx

开发者构造回调URL的示例如下

@RestController
public class reportCallBack {
    @RequestMapping(value = "/callback",method = RequestMethod.GET)
    public void report(@RequestParam(value = "reportId")String reportId){
        System.out.println(reportId);
    }
}

拼接好的URL，在企业自有系统内访问跳转，即可打开钉钉填写日志页面，如下图所示。

主体流程图示说明。

场景一：编辑后再发送

主体流程

主体流程是在企业内部系统中，点击“生成周报”的时候：

获取要生成的模板的详情，根据模板和周报内容组装对应的内容，并调用开放平台的接口上传内容，开放平台会返回对应的contentId。

拼接写日志页面的url，跳转到钉钉日志的写日志页面。

在写日志页面进行编辑（可选），选择接收人后进行发送。

发送完，触发对应企业的回调url，通知已发出的日志id。

调用流程图如下：

说明

开放平台已开通上传图片接口。

回调URL

企业保存完日志内容后，点击跳转到钉钉的URL完整的格式如下：

dingtalk://dingtalkclient/action/openapp?corpid={corpid}&container_type=work_platform&app_id=2&redirect_type=jump&redirect_url="+ encodeURIComponent("https://landray.dingtalkapps.com/alid/app/reportpc/createreport.html?corpid={corpid}&templateid={templateid}&contentid={contentid}&callbackUrl={callback_url}&dd_from=ThirdParty")

corpId: 企业的corpId。

templateid：日志模板ID。

contentid: 保存内容后返回的contentId。

callbackUrl：第三方自己提供的回调的url，用于用户提交日志成功之后，通知第三方生成的日志id，第三方可以基于此id拼接成日志详情页的url，可以关联到钉钉里面的日志详情。(回调的url由企业自己提供，钉钉日志前端在提交日志时会带上这个url，服务端在提交日志成功之后触发回调。)

dd_from：固定为ThirdParty。

场景二：直接发送

日志集成后，在企业内部系统中，点击“生成周报”时：

后端先调用开放平台接口获取模板详情。

调用开放平台接口上传周报中的图片，获取上传图片后的mediaId。

根据模板字段组装日志内容(包括上传图片后的mediaId)，再调用开放平台接口创建日志。

钉钉日志创建并发送完日志后，会返回对应的日志id。

调用流程图如下：

场景三：查看日志阅读情况

获取日志的阅读情况，包含已读人数、评论条数、评论人数和点赞人数等，并供企业员工查看。

企业开通日志，员工使用日志并提交周报、日报等。

各部门日志填报完成后，企业内部系统调用获取日志统计数据接口，可以在内部系统查看日志阅读情况，生成日志报表，并推送给企业管理员及员工。

企业管理员和员工可以在企业内部系统查看日志阅读情况，包含日志的已读人数、评论条数、评论人数、点赞人数等。生成报表页，方便在移动端实时查看。

接入流程#

场景一：编辑后再发送#

主体流程#

回调URL#