Skip to main content
Call this API to copy a document in Knowledge Base or Drive.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v2.0/doc/dentries/copy
HTTP MethodPOST
Supported app typeappType-企业内部应用
Required permissionspermission-SNS.Document.WorkspaceDocument.Write-SNS知识库文档写权限

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe API credential. Obtain it by calling the Get user token API.

Request body

NameTypeRequiredDescription
paramObjectYesThe required parameter.
sourceDentryUuidStringYesThe unique identifier of the source file. Use the value of the dentryUUid field returned by the File Search API.
targetParentDentryUuidStringYesThe unique identifier of the target file. Use the value of the dentryUUid field returned by the File Search API.
targetPreDentryUuidStringNoThe unique identifier of the file that precedes the target (optional). Use the value of the dentryUUid field returned by the File Search API.

Request example

HTTP
POST /v2.0/doc/dentries/copy HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:example-token
Content-Type:application/json

{
  "param" : {
    "sourceDentryUuid" : "dentryUuid",
    "targetParentDentryUuid" : "dentryUuid",
    "targetPreDentryUuid" : "dentryUuid"
  }
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using the token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_2_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkdoc_2_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_2_0.models.CopyDocHeaders copyDocHeaders = new com.aliyun.dingtalkdoc_2_0.models.CopyDocHeaders();
        copyDocHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_2_0.models.CopyDocRequest.CopyDocRequestParam param = new com.aliyun.dingtalkdoc_2_0.models.CopyDocRequest.CopyDocRequestParam()
                .setSourceDentryUuid("dentryUuid")
                .setTargetParentDentryUuid("dentryUuid")
                .setTargetPreDentryUuid("dentryUuid");
        com.aliyun.dingtalkdoc_2_0.models.CopyDocRequest copyDocRequest = new com.aliyun.dingtalkdoc_2_0.models.CopyDocRequest()
                .setParam(param);
        try {
            client.copyDocWithOptions(copyDocRequest, copyDocHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message attributes, which help locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message attributes, which help locate the issue
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_dingtalk.doc_2_0.client import Client as dingtalkdoc_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_2_0 import models as dingtalkdoc__2__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkdoc_2_0Client:
        """
        Initialize the account Client using the token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_2_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        copy_doc_headers = dingtalkdoc__2__0_models.CopyDocHeaders()
        copy_doc_headers.x_acs_dingtalk_access_token = '<your access token>'
        param = dingtalkdoc__2__0_models.CopyDocRequestParam(
            source_dentry_uuid='dentryUuid',
            target_parent_dentry_uuid='dentryUuid',
            target_pre_dentry_uuid='dentryUuid'
        )
        copy_doc_request = dingtalkdoc__2__0_models.CopyDocRequest(
            param=param
        )
        try:
            client.copy_doc_with_options(copy_doc_request, copy_doc_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        copy_doc_headers = dingtalkdoc__2__0_models.CopyDocHeaders()
        copy_doc_headers.x_acs_dingtalk_access_token = '<your access token>'
        param = dingtalkdoc__2__0_models.CopyDocRequestParam(
            source_dentry_uuid='dentryUuid',
            target_parent_dentry_uuid='dentryUuid',
            target_pre_dentry_uuid='dentryUuid'
        )
        copy_doc_request = dingtalkdoc__2__0_models.CopyDocRequest(
            param=param
        )
        try:
            await client.copy_doc_with_options_async(copy_doc_request, copy_doc_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes, which help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\CopyDocHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\CopyDocRequest\param;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\CopyDocRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using the token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $copyDocHeaders = new CopyDocHeaders([]);
        $copyDocHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $param = new param([
            "sourceDentryUuid" => "dentryUuid",
            "targetParentDentryUuid" => "dentryUuid",
            "targetPreDentryUuid" => "dentryUuid"
        ]);
        $copyDocRequest = new CopyDocRequest([
            "param" => $param
        ]);
        try {
            $client->copyDocWithOptions($copyDocRequest, $copyDocHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains code and message attributes, which help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_2_0  "github.com/alibabacloud-go/dingtalk/doc_2_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client using the token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_2_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_2_0.Client{}
  _result, _err = dingtalkdoc_2_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  copyDocHeaders := &dingtalkdoc_2_0.CopyDocHeaders{}
  copyDocHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  param := &dingtalkdoc_2_0.CopyDocRequestParam{
    SourceDentryUuid: tea.String("dentryUuid"),
    TargetParentDentryUuid: tea.String("dentryUuid"),
    TargetPreDentryUuid: tea.String("dentryUuid"),
  }
  copyDocRequest := &dingtalkdoc_2_0.CopyDocRequest{
    Param: param,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CopyDocWithOptions(copyDocRequest, copyDocHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains code and message attributes, which help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_2_0 = require('@alicloud/dingtalk/doc_2_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client using the token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdoc_2_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let copyDocHeaders = new dingtalkdoc_2_0.CopyDocHeaders({ });
    copyDocHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let param = new dingtalkdoc_2_0.CopyDocRequestParam({
      sourceDentryUuid: 'dentryUuid',
      targetParentDentryUuid: 'dentryUuid',
      targetPreDentryUuid: 'dentryUuid',
    });
    let copyDocRequest = new dingtalkdoc_2_0.CopyDocRequest({
      param: param,
    });
    try {
      await client.copyDocWithOptions(copyDocRequest, copyDocHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes, which help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client using the token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CopyDocHeaders copyDocHeaders = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CopyDocHeaders();
            copyDocHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CopyDocRequest.CopyDocRequestParam param = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CopyDocRequest.CopyDocRequestParam
            {
                SourceDentryUuid = "dentryUuid",
                TargetParentDentryUuid = "dentryUuid",
                TargetPreDentryUuid = "dentryUuid",
            };
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CopyDocRequest copyDocRequest = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.CopyDocRequest
            {
                Param = param,
            };
            try
            {
                client.CopyDocWithOptions(copyDocRequest, copyDocHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes, which help locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
isAsyncBooleanWhether this operation is asynchronous. If true, poll the result of the async task by taskId.
taskIdStringThe task ID. Returned only for asynchronous operations.
syncCopyResultObjectThe result of the synchronous operation. Note that this field is still returned when isAsync is true.
dentryUuidStringThe unique file ID.
driveSpaceIdStringThe storage-layer space ID.
driveDentryIdStringThe storage-layer file ID.
extensionStringThe file extension.
nameStringThe node name.
urlStringThe access link of the node.
spaceInfoObjectInformation about the space where the node resides.
sceneTypeStringThe scenario to which the resource belongs.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "isAsync" : true,
  "taskId" : "true",
  "syncCopyResult" : {
    "dentryUuid" : "dentryUuid",
    "driveSpaceId" : "driveSpaceId",
    "driveDentryId" : "driveDentryId",
    "extension" : "docx",
    "name" : "name",
    "url" : "https://example.com",
    "spaceInfo" : {
      "sceneType" : "im"
    }
  }
}

Error codes

If this API returns an error, find the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error.
500systemError%sThe service is busy. Try again later.
500documentNotExist%sThe document does not exist or its format is not supported.
500permissionDenied%sNo copy permission.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sThe request has timed out.