Skip to main content
Call this API to send a file link to a specified chat.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/convFile/conversations/files/links/send
HTTP MethodPOST
Supported app typeappType-Internal app
Required permissionspermission-ConvFile.File.Send-Group file send permission

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. Obtain it by calling the Query user details API.

Request body

NameTypeRequiredDescription
spaceIdStringYesThe ID of the space where the file is located. Obtain it by calling the Add a space API.
dentryIdStringYesThe file ID. Obtain the value of the id parameter by calling the Get the list of files or folders API.
openConversationIdStringYesThe openConversationId of the target chat. Obtain the value of the openConversationId parameter by calling the Create a group API.

Request example

HTTP
POST /v1.0/convFile/conversations/files/links/send?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "spaceId" : "786xxxxx",
  "dentryId" : "908xxxxx",
  "openConversationId" : "cidCxxxxx"
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client using a Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkconv_file_1_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.dingtalkconv_file_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkconv_file_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkconv_file_1_0.models.SendLinkHeaders sendLinkHeaders = new com.aliyun.dingtalkconv_file_1_0.models.SendLinkHeaders();
        sendLinkHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconv_file_1_0.models.SendLinkRequest sendLinkRequest = new com.aliyun.dingtalkconv_file_1_0.models.SendLinkRequest()
                .setUnionId("chyxxxxx")
                .setSpaceId("786xxxxx")
                .setDentryId("908xxxxx")
                .setOpenConversationId("cidCxxxxx");
        try {
            client.sendLinkWithOptions(sendLinkRequest, sendLinkHeaders, 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 the code and message attributes, which help developers locate issues
            }

        } 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 the code and message attributes, which help developers locate issues
            }

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

from typing import List

from alibabacloud_dingtalk.convFile_1_0.client import Client as dingtalkconvFile_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.convFile_1_0 import models as dingtalkconv_file__1__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() -> dingtalkconvFile_1_0Client:
        """
        Initialize the account Client using a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkconvFile_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        send_link_headers = dingtalkconv_file__1__0_models.SendLinkHeaders()
        send_link_headers.x_acs_dingtalk_access_token = '<your access token>'
        send_link_request = dingtalkconv_file__1__0_models.SendLinkRequest(
            union_id='chyxxxxx',
            space_id='786xxxxx',
            dentry_id='908xxxxx',
            open_conversation_id='cidCxxxxx'
        )
        try:
            client.send_link_with_options(send_link_request, send_link_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help developers locate issues
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        send_link_headers = dingtalkconv_file__1__0_models.SendLinkHeaders()
        send_link_headers.x_acs_dingtalk_access_token = '<your access token>'
        send_link_request = dingtalkconv_file__1__0_models.SendLinkRequest(
            union_id='chyxxxxx',
            space_id='786xxxxx',
            dentry_id='908xxxxx',
            open_conversation_id='cidCxxxxx'
        )
        try:
            await client.send_link_with_options_async(send_link_request, send_link_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help developers locate issues
                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\Vconv_file_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Models\SendLinkHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Models\SendLinkRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using a 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();
        $sendLinkHeaders = new SendLinkHeaders([]);
        $sendLinkHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $sendLinkRequest = new SendLinkRequest([
            "unionId" => "chyxxxxx",
            "spaceId" => "786xxxxx",
            "dentryId" => "908xxxxx",
            "openConversationId" => "cidCxxxxx"
        ]);
        try {
            $client->sendLinkWithOptions($sendLinkRequest, $sendLinkHeaders, 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 the code and message attributes, which help developers locate issues
            }
        }
    }
}
$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 (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkconvfile_1_0  "github.com/alibabacloud-go/dingtalk/convFile_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

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

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

  sendLinkHeaders := &dingtalkconvfile_1_0.SendLinkHeaders{}
  sendLinkHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  sendLinkRequest := &dingtalkconvfile_1_0.SendLinkRequest{
    UnionId: tea.String("chyxxxxx"),
    SpaceId: tea.String("786xxxxx"),
    DentryId: tea.String("908xxxxx"),
    OpenConversationId: tea.String("cidCxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SendLinkWithOptions(sendLinkRequest, sendLinkHeaders, &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 the code and message attributes, which help developers locate issues
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkconvFile_1_0, * as $dingtalkconvFile_1_0 from '@alicloud/dingtalk/convFile_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account Client using a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkconvFile_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkconvFile_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let sendLinkHeaders = new $dingtalkconvFile_1_0.SendLinkHeaders({ });
    sendLinkHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let sendLinkRequest = new $dingtalkconvFile_1_0.SendLinkRequest({
      unionId: "chyxxxxx",
      spaceId: "786xxxxx",
      dentryId: "908xxxxx",
      openConversationId: "cidCxxxxx",
    });
    try {
      await client.sendLinkWithOptions(sendLinkRequest, sendLinkHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message attributes, which help developers locate issues
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client using a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkconv_file_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkconv_file_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendLinkHeaders sendLinkHeaders = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendLinkHeaders();
            sendLinkHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendLinkRequest sendLinkRequest = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendLinkRequest
            {
                UnionId = "chyxxxxx",
                SpaceId = "786xxxxx",
                DentryId = "908xxxxx",
                OpenConversationId = "cidCxxxxx",
            };
            try
            {
                client.SendLinkWithOptions(sendLinkRequest, sendLinkHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which help developers locate issues
                }
            }
            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 the code and message attributes, which help developers locate issues
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
fileObjectThe file link information sent to the target chat.
idStringThe file ID.
conversationIdStringThe openConversationId of the chat where the file is located.
spaceIdStringThe ID of the space where the file is located.
parentIdStringThe ID of the parent folder where the file is located. The ID of the root folder is 0.
typeStringThe file type. - FILE: file - FOLDER: folder
nameStringThe file name.
sizeLongThe file size, in bytes.
pathStringThe file path.
versionLongThe file version number.
statusStringThe file status. - NORMAL: normal - DELETED: deleted - EXPIRED: expired
extensionStringThe file extension.
creatorIdStringThe unionId of the file creator.
modifierIdStringThe unionId of the file modifier.
createTimeStringThe time when the file was created, in ISO 8601 format. Example: 2022-07-29T14:55Z.
modifiedTimeStringThe time when the file was last modified, in ISO 8601 format. Example: 2022-07-29T14:55Z.
uuidStringThe identifier field.

Response body example

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

{
  "file" : {
    "id" : "file_id",
    "conversationId" : "open_conversation_id",
    "spaceId" : "space_id",
    "parentId" : "parent_id",
    "type" : "file",
    "name" : "file_name",
    "size" : 256,
    "path" : "file_path",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "txt",
    "creatorId" : "creator_id",
    "modifierId" : "modified_id",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "uuid" : "uuid"
  }
}

Error codes

If an error occurs when you call this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error
400paramError.spaceId%sParameter error - spaceId
400paramError.dentryId%sParameter error - dentryId
400paramError.conversationId%sParameter error - conversationId
403permissionDenied%sThe user lacks the permission to add files to the storage space of the target chat
404conversationNotExist%sThe target chat does not exist
500systemError%sSystem error
500unknownErrorUnknown ErrorUnknown error