Skip to main content
Call this API to send a file to a specified user as an app.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/convFile/apps/conversations/files/send
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Permissions requiredpermission-ConvFile.File.Send-Group file sending permission

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it through one of the following methods: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an organization authorized to a third-party app API.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unionId of the user who receives the file. To obtain this value, call the Query user details API.

Request body

NameTypeRequiredDescription
spaceIdStringYesThe ID of the space where the file resides. Call the Add space API to obtain the value of the id parameter.
dentryIdStringYesThe ID of the file. Call the Get the list of files or folders API to obtain the value of the id parameter.

Request example

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

{
  "spaceId" : "864xxxxx",
  "dentryId" : "674xxxxx"
}
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 with 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.SendByAppHeaders sendByAppHeaders = new com.aliyun.dingtalkconv_file_1_0.models.SendByAppHeaders();
        sendByAppHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkconv_file_1_0.models.SendByAppRequest sendByAppRequest = new com.aliyun.dingtalkconv_file_1_0.models.SendByAppRequest()
                .setUnionId("cHtUYxxxxx")
                .setSpaceId("864xxxxx")
                .setDentryId("674xxxxx");
        try {
            client.sendByAppWithOptions(sendByAppRequest, sendByAppHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err contains the code and message attributes, which help developers 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)) {
                // The err contains the code and message attributes, which help developers locate the issue
            }

        }        
    }
}
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 with 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_by_app_headers = dingtalkconv_file__1__0_models.SendByAppHeaders()
        send_by_app_headers.x_acs_dingtalk_access_token = '<your access token>'
        send_by_app_request = dingtalkconv_file__1__0_models.SendByAppRequest(
            union_id='cHtUYxxxxx',
            space_id='864xxxxx',
            dentry_id='674xxxxx'
        )
        try:
            client.send_by_app_with_options(send_by_app_request, send_by_app_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains the code and message attributes, which help developers locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        send_by_app_headers = dingtalkconv_file__1__0_models.SendByAppHeaders()
        send_by_app_headers.x_acs_dingtalk_access_token = '<your access token>'
        send_by_app_request = dingtalkconv_file__1__0_models.SendByAppRequest(
            union_id='cHtUYxxxxx',
            space_id='864xxxxx',
            dentry_id='674xxxxx'
        )
        try:
            await client.send_by_app_with_options_async(send_by_app_request, send_by_app_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains the code and message attributes, which help developers 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\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\SendByAppHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Models\SendByAppRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $sendByAppHeaders = new SendByAppHeaders([]);
        $sendByAppHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $sendByAppRequest = new SendByAppRequest([
            "unionId" => "cHtUYxxxxx",
            "spaceId" => "864xxxxx",
            "dentryId" => "674xxxxx"
        ]);
        try {
            $client->sendByAppWithOptions($sendByAppRequest, $sendByAppHeaders, 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)) {
                // The err contains the code and message attributes, which help developers 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 (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/service"
  dingtalkconvfile_1_0  "github.com/alibabacloud-go/dingtalk/convFile_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account Client with 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
  }

  sendByAppHeaders := &dingtalkconvfile_1_0.SendByAppHeaders{}
  sendByAppHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  sendByAppRequest := &dingtalkconvfile_1_0.SendByAppRequest{
    UnionId: tea.String("cHtUYxxxxx"),
    SpaceId: tea.String("864xxxxx"),
    DentryId: tea.String("674xxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SendByAppWithOptions(sendByAppRequest, sendByAppHeaders, &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)) {
      // The err contains the code and message attributes, which help developers locate the issue
    }

  }
  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 with 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 sendByAppHeaders = new $dingtalkconvFile_1_0.SendByAppHeaders({ });
    sendByAppHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let sendByAppRequest = new $dingtalkconvFile_1_0.SendByAppRequest({
      unionId: "cHtUYxxxxx",
      spaceId: "864xxxxx",
      dentryId: "674xxxxx",
    });
    try {
      await client.sendByAppWithOptions(sendByAppRequest, sendByAppHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // The err contains the code and message attributes, which help developers locate the issue
      }

    }    
  }

}

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 with 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.SendByAppHeaders sendByAppHeaders = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendByAppHeaders();
            sendByAppHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendByAppRequest sendByAppRequest = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendByAppRequest
            {
                UnionId = "cHtUYxxxxx",
                SpaceId = "864xxxxx",
                DentryId = "674xxxxx",
            };
            try
            {
                client.SendByAppWithOptions(sendByAppRequest, sendByAppHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains the code and message attributes, which help developers 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))
                {
                    // The err contains the code and message attributes, which help developers locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
fileObjectThe information about the file sent to the target chat.
idStringThe file ID.
conversationIdStringThe ID of the chat where the file resides.
spaceIdStringThe ID of the space where the file resides.
parentIdStringThe ID of the parent folder where the file resides. For the root folder, this parameter is 0.
typeStringThe file type. - FILE: File - FOLDER: Folder This API can only send files.
nameStringThe file name.
sizeLongThe file size, in bytes.
pathStringThe file path.
versionLongThe file version.
statusStringThe file status. - NORMAL: Normal - DELETED: Deleted - EXPIRED: Expired
extensionStringThe file extension.
creatorIdStringThe unionId of the creator.
modifierIdStringThe unionId of the modifier.
createTimeStringThe creation time in ISO 8601 format. For example, 2022-07-29T14:55Z.
modifiedTimeStringThe modification time in ISO 8601 format. For example, 2022-07-29T14:55Z.
uuidStringThe business uuid. This API does not return this field.

Response body example

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

{
  "file" : {
    "id" : "674xxxxx",
    "conversationId" : "cidB1xxxxx",
    "spaceId" : "864xxxxx",
    "parentId" : "0",
    "type" : "FILE",
    "name" : "TestFile.xls",
    "size" : 256,
    "path" : "/TestFile.xls",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "xls",
    "creatorId" : "cHtUYxxxxx",
    "modifierId" : "cHtUYxxxxx",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z"
  }
}

Error codes

If an error is returned when you call this API, locate 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
400permissionDenied%sNo permission
404spaceNotExist%sSpace does not exist
404dentryNotExist%sFile does not exist
500systemError%sSystem error
500unknownErrorUnknown ErrorUnknown error