导出文档内容指南
目录
  一、说明 
  二、整体流程 
2.1  开放平台前置链路
2.1.1  成为钉钉开发者
2.1.2  创建 AI 助理 & 钉钉开放应用
2.1.3  在调用服务端 API 前，确保已添加 API 所需的权限。详情请参考添加接口调用权限。
2.1.4  订阅事件
2.1.5  在调用服务端 API 前，获取 API 访问凭证 accessToken
2.2  文档授权链路 :  知识库或文档添加 AI 助理权限 
2.3  业务流程图
  三、导出文档内容接口
3.1  接口信息
3.2 权限
3.3 请求方法
3.4 Header参数
3.5 Path参数
3.6 Query参数
3.7  返回参数
3.8  错误码
  四、钉钉文档导出完成事件 
4.1  事件信息
4.2 功能描述
4.3 支持应用类型
4.4 事件体描述
 4.4.1 Stream 模式推送
4.4.2 Http 推送
  五、示例代码
5.1 单篇文档导出 demo
5.2  批量导出知识库文档 demo
﻿
  一、说明 
该方案支持导出企业归属的钉钉知识库、钉钉文档内容，导出格式为 Markdown
﻿
  二、整体流程 
﻿﻿
﻿
2.1  开放平台前置链路
2.1.1  成为钉钉开发者
确保已经完成了钉钉开发者的注册与激活，并拥有子管理员和开发者权限，可以登录开发者后台。若尚未完成，请参考成为钉钉开发者。
2.1.2  创建 AI 助理 & 钉钉开放应用
1.创建 AI 助理（下图为钉钉 8.0 版本示意图，其他版本请找到对应的 AI 助理创建入口）
﻿﻿
2.按照图示创建一个 AI 助理
3.﻿
﻿﻿
﻿﻿
﻿﻿
﻿﻿
﻿﻿
﻿
可以看到自动创建了一个钉钉开放应用，后续就通过该开放应的认证信息进行调用接口
﻿﻿
﻿
返回 AI 助理创建窗口，进行完成 AI 助理创建的其他流程
﻿﻿
﻿﻿
﻿﻿
﻿﻿
﻿﻿
2.1.3  在调用服务端 API 前，确保已添加 API 所需的权限。详情请参考添加接口调用权限。
接口名称
权限
示例
获取知识库列表接口
知识库读权限
﻿﻿
获取知识库节点列表接口
知识库节点读权限
﻿﻿
导出内容接口
钉钉文档读权限
﻿﻿
2.1.4  订阅事件
导出文档内容流程为异步方式，导出内容结果以事件消息的方式返回给业务方，需要业务方订阅相应的时间。事件详情见“四、钉钉文档导出完成事件”。订阅事件流程如下图所示。详细说明文档：开放平台事件订阅说明文档﻿
﻿﻿
﻿﻿
2.1.5  在调用服务端 API 前，获取 API 访问凭证 accessToken
详情请参考新版服务端API-获取第三方应用授权企业的accessToken。
2.2  文档授权链路 :  知识库或文档添加 AI 助理权限 
1.进入要导出的知识库或者文档的权限管理页面
知识库权限管理
﻿﻿
文档权限管理
﻿﻿
﻿
2.添加 AI 助理权限
输入 AI 助理名称，添加为可查看及下载权限
﻿﻿
﻿﻿
2.3  业务流程图
接口名称
详情
获取知识库列表接口
﻿https://open.dingtalk.com/document/orgapp/get-knowledge-base-list﻿
知识库读权限
获取知识库节点列表接口
﻿https://open.dingtalk.com/document/orgapp/get-node-list﻿
知识库节点读权限
导出内容内容接口
定向开放接口：需要联系开发同学开通灰度
详细说明文档见“三、导出文档内容接口”
监听「钉钉文档内容导出结果」事件
详细说明文档见“四、钉钉文档导出完成事件”
﻿
  三、导出文档内容接口
3.1  接口信息
﻿
﻿
﻿
﻿
该接口为异步接口，调用成功返回 taskId，订阅「钉钉文档导出完成事件」事件获取调用结果。
﻿
﻿
﻿
﻿
支持的文档格式为钉钉文档、钉钉表格、 pdf 、docx、xlsx，后续会支持更多格式。
﻿
﻿
﻿
﻿
暂时支持以 markdown 格式导出。
返回的链接有效期为 2 小时
3.2 权限
要调用此 API，需要以下权限之一。
应用类型
是否支持
权限
企业内部应用
支持
钉钉文档读权限
第三方企业应用
支持
钉钉文档读权限
3.3 请求方法
5
POST /v1.0/doc/{dentryUuid}/export?targetFormat=markdown HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
3.4 Header参数
名称
类型
是否必填
描述
x-acs-dingtalk-access-token
String
是
调用该接口的访问凭证。
●企业内部应用可调用获取企业内部应用的accessToken 接口获取。
●第三方企业应用可调用获取第三方应用授权企业的accessToken 接口获取。
3.5 Path参数
名称
类型
是否必填
描述
dentryUuid
String
是
节点 dentryUuid：
企业内部应用，可通过调用获取节点列表接口，获取返回参数 nodeId 字段。
第三方企业应用，可通过调用获取节点列表接口，获取返回参数 nodeId 字段。
3.6 Query参数
名称
类型
是否必填
描述
targetFormat
String
否
目标格式，可缺省，取值：
●markdown
3.7  返回参数
名称
类型
描述
taskId
Long
任务 id
3.8  错误码
HttpCode
错误码
错误信息
说明
400
paramError
%s
参数错误
403
permissionDenied
The operator has no permission.
当前用户无此操作权限
404
documentNotExist
%s
文档不存在或格式不支持
404
unsupportedFormat
%s
暂不支持该导出格式
404
docNotOrgOpen
%s
未组织内公开，不支持获取内容
500
systemError
%s
服务繁忙，请稍后重试
500
unknownError
Unknown Error
未知错误
﻿
  四、钉钉文档导出完成事件 
4.1  事件信息
名称
值
中文名称
钉钉文档导出完成事件
英文名称
dingdoc_export_finish
4.2 功能描述
当调用「导出文档内容」接口后，钉钉通过事件订阅的方式将文档导出结果和后续更新结果推送给开发者。
4.3 支持应用类型
应用类型
Stream 模式推送
HTTP 推送
SyncHTTP/RDS 推送
企业内部应用
支持
支持
不支持
第三方企业应用
支持
不支持
支持
4.4 事件体描述
 4.4.1 Stream 模式推送
名称
类型
示例值
描述
eventUnifiedAppId
String
bbb381b6-f01xxxxx58daac
统一应用身份 Id。
eventCorpId
String
ding9f50b15bxxxx16741
事件所属的 corpId。
eventType
String
doc_content_export_result
事件类型。
eventId
String
c7c7120f2c07419**ebdba0318c8
事件的唯一 Id。
eventBornTime
Long
1683533823336
事件生成时间。
data
Object
﻿
事件体 data。
data 结构如下
名称
类型
示例值
描述
corpId
String
ding9f50b15bxxxx16741
企业 corp_id。
bizId
String
1663**35567
事件 bizData 介绍。
bizType
Number
432
事件 bizType。
bizData
Object
﻿
事件 bizData 介绍。
bizData 结构如下
名称
类型
示例值
描述
eventId
String
c7c7120f2c07419**ebdba0318c8
事件的唯一 Id。
extension
String
adoc
文档后缀名。
unionId
String
P2D3iPA4H3OVQNjii28mTXAQiEiE
事件触发者信息。
syncAction
String
doc_export
事件英文名。
format
String
markdown
导出格式。
errorCode
String
52622003
错误码。
type
String
FILE_EXPORT
事件类型。
url
String
http://lippi.oss-cn.aliyuncs.com/doc/10296275054?Expires=1745292134&OSSAccessKeyId=APRGq4&Signature=vw1ib6Efsr%%3D
导出内容下载地址。
errorMsg
String
task initial cp not found
错误信息。
success
Boolean
true
是否成功。
dentryUuid
String
YndMj49yWj95B3qAfmwYPKYY83pmz5aA
文档唯一标识。
name
String
测试文档
文档名。
operation
String
file_export
事件触发的行为。
taskId
String
123456
导出任务 id。
事件体示例
29
{
  "eventUnifiedAppId": "bbb381b6-f01xxxxx58daac",
  "eventCorpId": "ding9f50b15bxxxx16741",
  "eventType": "dingdoc_export_finish",
  "eventId": "c7c7120f2c07419**ebdba0318c8",
  "eventBornTime": 1683533823336,
  "data": {
    "bizType": "432",
    "corpId": "ding9f50b15bxxxx16741",
    "bizId": "1663**35567",
    "bizData": {
      "eventId": "c7c7120f2c07419**ebdba0318c8",
      "extension": "adoc",
      "unionId": "P2D3iPA4H3OVQNjii28mTXAQiEiE",
      "syncAction": "doc_export",
      "format": "markdown",
      "errorCode": "52622003",
      "type": "FILE_EXPORT",
      "url": "http://lippi.oss-cn.aliyuncs.com/doc/10296275054?Expires\u003d1745292134\u0026OSSAccessKeyId\u003dAPRGq4\u0026Signature\u003dvw1ib6Efsr%%3D",
      "errorMsg": "task initial cp not found",
      "success": true,
      "dentryUuid": "YndMj49yWj95B3qAfmwYPKYY83pmz5aA",
      "name": "测试文档",
      "operation": "file_export",
      "taskId": "123456"
    }
  }
}
4.4.2 Http 推送
名称
类型
示例值
描述
EventType
String
dingdoc_export_finish
事件英文名称。
EventTime
Long
1663143335567
事件发生的时间。
CorpId
String
ding9f50b15bxxxx16741
企业 corpId。
BizId
String
1663**35567
无业务意义，幂等。
eventId
String
c7c7120f2c07419**ebdba0318c8
事件的唯一 Id。
corp_id
String
ding9f50b15bxxxx16741
企业 corp_id。
biz_id
String
1663**35567
事件 bizData 介绍。
biz_type
Number
432
事件 bizType。
biz_data
Object
﻿
事件 bizData 介绍。
biz_data 结构如下
名称
类型
示例值
描述
eventId
String
c7c7120f2c07419**ebdba0318c8
事件的唯一 Id。
extension
String
adoc
文档后缀名。
unionId
String
P2D3iPA4H3OVQNjii28mTXAQiEiE
事件触发者信息。
syncAction
String
doc_export
事件英文名。
format
String
markdown
导出格式。
errorCode
String
52622003
错误码。
type
String
FILE_EXPORT
事件类型。
url
String
http://lippi.oss-cn.aliyuncs.com/doc/10296275054?Expires=1745292134&OSSAccessKeyId=APRGq4&Signature=vw1ib6Efsr%%3D
导出内容下载地址。
errorMsg
String
task initial cp not found
错误信息。
success
Boolean
true
是否成功。
dentryUuid
String
YndMj49yWj95B3qAfmwYPKYY83pmz5aA
文档唯一标识。
name
String
测试文档
文档名。
operation
String
file_export
事件触发的行为。
taskId
String
123456
导出任务 id。
示例
27
{
  "EventType": "dingdoc_export_finish",
  "EventTime": 1663143335567,
  "CorpId": "ding9f50b15bxxxx16741",
  "BizId": "1663**35567",
  "eventId": "c7c7120f2c07419**ebdba0318c8",
  "biz_type": "432",
  "biz_id": "1663**35567",
  "biz_data": {
    "eventId": "c7c7120f2c07419**ebdba0318c8",
    "extension": "adoc",
    "unionId": "P2D3iPA4H3OVQNjii28mTXAQiEiE",
    "syncAction": "doc_export",
    "format": "markdown",
    "errorCode": "52622003",
    "type": "FILE_EXPORT",
    "url": "http://lippi.oss-cn.aliyuncs.com/doc/10296275054?Expires\u003d1745292134\u0026OSSAccessKeyId\u003dAPRGq4\u0026Signature\u003dvw1ib6Efsr%%3D",
    "errorMsg": "task initial cp not found",
    "success": true,
    "dentryUuid": "YndMj49yWj95B3qAfmwYPKYY83pmz5aA",
    "name": "测试文档",
    "operation": "file_export",
    "taskId": "123456"
  },
  "corp_id": "ding9f50b15bxxxx16741"
}
﻿
  五、示例代码
5.1 单篇文档导出 demo
1.添加  maven 依赖
6
<dependency>
<groupId>com.dingtalk.open</groupId>
<artifactId>app-stream-client</artifactId>
<version>1.3.7</version>
</dependency>
2. 初始化导出事件监听类
50
public class ExportResultEventListener {
    public static void main(String[] args) throws Exception {
        // 应用的clientId 和 clientSecret
        String clientId = "xxx";
        String clientSecret = "xxx";
        // 监听文档导出事件
        System.out.println("launch stream client...");
        OpenDingTalkStreamClientBuilder
            .custom()
            .credential(new AuthClientCredential(clientId, clientSecret))
            //注册事件监听
            .registerAllEventListener(new GenericEventListener() {
                public EventAckStatus onEvent(GenericOpenDingTalkEvent event) {
                    try {
                        //事件唯一Id
                        String eventId = event.getEventId();
                        //事件类型
                        String eventType = event.getEventType();
                        //事件产生时间
                        Long bornTime = event.getEventBornTime();
                        //获取事件体
                        JSONObject bizData = event.getData();
                        //处理事件
                        process(bizData);
                        //消费成功
                        return EventAckStatus.SUCCESS;
                    } catch (Exception e) {
                        //消费失败
                        System.out.println(e.getMessage());
                        return EventAckStatus.LATER;
                    }
                }
            })
            .build().start();
    }


    /**
     * 监听文档导出完成事件
     * @param bizData
     */
    private static void process(JSONObject bizData) {
        System.out.println("receive doc export result:");
        System.out.println(bizData.toJSONString());
        String url = bizData.getString("url");
        System.out.println("url:" + url);
    }
}

3.调用导出文档内容，触发导出
75
public class TriggerExportDoc {
    public static void main(String[] args) throws Exception {
        // 应用的clientId 和 clientSecret
        String clientId = "xxx";
        String clientSecret = "xxx";

        // 1, 获取应用 accessToken
        String accessToken = getAccessToken(clientId, clientSecret);

        // 2. 执行文档导出操作
        // 例如：文档链接 https://alidocs.dingtalk.com/i/nodes/AR4GpnMqJzRQ67Ppu03yQDXwJKe0xjE3
        // dentryUuid则为AR4GpnMqJzRQ67Ppu03yQDXwJKe0xjE3
        String dentryUuid = "xxxx";
        triggerDocExport(accessToken, dentryUuid);
    }

    private static String getAccessToken(String appKey, String appSecret) throws Exception {
        System.out.println("start to get accessToken...");
        URL url = new URL("https://api.dingtalk.com/v1.0/oauth2/accessToken");
        String jsonInput = String.format("{\"appKey\":\"%s\",\"appSecret\":\"%s\"}", appKey, appSecret);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();

        // 设置请求方法
        connection.setRequestMethod("GET");
        connection.setRequestProperty("Content-Type", "application/json");
        connection.setDoOutput(true); // 允许输出请求体（即使无数据）

        // 写入请求体
        try (OutputStream os = connection.getOutputStream()) {
            byte[] input = jsonInput.getBytes("UTF-8");
            os.write(input, 0, input.length);
        }

        // 读取响应
        String accessToken = null;
        int responseCode = connection.getResponseCode();
        if (responseCode == HttpURLConnection.HTTP_OK) {
            try (BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String inputLine;
                StringBuilder response = new StringBuilder();
                while ((inputLine = in.readLine()) != null) {
                    response.append(inputLine);
                }

                JSONObject jsonObject = JSONObject.parseObject(response.toString());
                accessToken = jsonObject.get("accessToken").toString();
            }
        } else {
            throw new RuntimeException("HTTP请求失败: " + responseCode);
        }
        connection.disconnect();
        System.out.println("finish get access token. token: " + accessToken);
        return accessToken;
    }

    private static void triggerDocExport(String accessToken, String dentryUuid) throws Exception {
        System.out.println("start to export doc...");

        URL url = new URL(String.format("https://api.dingtalk.com/v1.0/doc/%s/export", dentryUuid));
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();

        // 设置请求方法
        connection.setRequestMethod("POST");
        connection.setRequestProperty("x-acs-dingtalk-access-token", accessToken);
        connection.setDoOutput(true);

        // 读取响应
        int responseCode = connection.getResponseCode();

        connection.disconnect();
        System.out.println("Status Code: " + responseCode);
        System.out.println("finish trigger export.");
    }
}
5.2  批量导出知识库文档 demo
//待补充
﻿