> ## Documentation Index > Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt > Use this file to discover all available pages before exploring further. # Send a file to a specified chat > Call this API to send a file to a specified chat for members to view and download. Call this API to send a file to a specified chat. ## Request ### Basic information | Field | Value | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | HTTP URL | [https://api.dingtalk.io/v1.0/convFile/conversations/files/send](https://api.dingtalk.io/v1.0/convFile/conversations/files/send) | | HTTP Method | POST | | Supported app type | appType-Internal app | | Permissions required | permission-ConvFile.File.Send-Group file send permission | ### Request headers | Name | Type | Required | Description | | --------------------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | Yes | The access credential used to call this API. Obtain it by calling the [Obtain the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app#) API. | ### Query parameters | Name | Type | Required | Description | | ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------- | | unionId | String | Yes | The unionId of the operator. Obtain it by calling the [Query user details](/open/development/query-user-details#) API. | ### Request body | Name | Type | Required | Description | | ------------------ | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | spaceId | String | Yes | The space ID. Obtain the value of the id parameter by calling the [Add a space](/open/development/add-space#) API. | | dentryId | String | Yes | The file ID. Obtain the value of the id parameter by calling the [Obtain the list of files or folders](https://open.dingtalk.com/document/development/obtain-the-file-list-storage#) API. | | openConversationId | String | Yes | The openConversationId of the target chat. Obtain the value of the openConversationId parameter by calling the [Create a group](https://open.dingtalk.com/document/development/create-group-session#) API. | ### Request example HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} POST /v1.0/convFile/conversations/files/send?unionId=chyxxxxx HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:xxxxx Content-Type:application/json { "spaceId" : "865xxxxx", "dentryId" : "897xxxxx", "openConversationId" : "cid+vIrzxxxxx" } ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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 args = java.util.Arrays.asList(args_); com.aliyun.dingtalkconv_file_1_0.Client client = Sample.createClient(); com.aliyun.dingtalkconv_file_1_0.models.SendHeaders sendHeaders = new com.aliyun.dingtalkconv_file_1_0.models.SendHeaders(); sendHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkconv_file_1_0.models.SendRequest sendRequest = new com.aliyun.dingtalkconv_file_1_0.models.SendRequest() .setUnionId("chyxxxxx") .setSpaceId("865xxxxx") .setDentryId("897xxxxx") .setOpenConversationId("cid+vIrzxxxxx"); try { client.sendWithOptions(sendRequest, sendHeaders, 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 that help troubleshoot 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 the code and message attributes that help troubleshoot the issue } } } } ``` Python ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # -*- 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_headers = dingtalkconv_file__1__0_models.SendHeaders() send_headers.x_acs_dingtalk_access_token = '' send_request = dingtalkconv_file__1__0_models.SendRequest( union_id='chyxxxxx', space_id='865xxxxx', dentry_id='897xxxxx', open_conversation_id='cid+vIrzxxxxx' ) try: client.send_with_options(send_request, send_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 that help troubleshoot the issue pass @staticmethod async def main_async( args: List[str], ) -> None: client = Sample.create_client() send_headers = dingtalkconv_file__1__0_models.SendHeaders() send_headers.x_acs_dingtalk_access_token = '' send_request = dingtalkconv_file__1__0_models.SendRequest( union_id='chyxxxxx', space_id='865xxxxx', dentry_id='897xxxxx', open_conversation_id='cid+vIrzxxxxx' ) try: await client.send_with_options_async(send_request, send_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 that help troubleshoot the issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $sendHeaders = new SendHeaders([]); $sendHeaders->xAcsDingtalkAccessToken = ""; $sendRequest = new SendRequest([ "unionId" => "chyxxxxx", "spaceId" => "865xxxxx", "dentryId" => "897xxxxx", "openConversationId" => "cid+vIrzxxxxx" ]); try { $client->sendWithOptions($sendRequest, $sendHeaders, 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 that help troubleshoot 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 ```go theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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 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 } sendHeaders := &dingtalkconvfile_1_0.SendHeaders{} sendHeaders.XAcsDingtalkAccessToken = tea.String("") sendRequest := &dingtalkconvfile_1_0.SendRequest{ UnionId: tea.String("chyxxxxx"), SpaceId: tea.String("865xxxxx"), DentryId: tea.String("897xxxxx"), OpenConversationId: tea.String("cid+vIrzxxxxx"), } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.SendWithOptions(sendRequest, sendHeaders, &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 that help troubleshoot the issue } } return _err } func main() { err := _main(tea.StringSlice(os.Args[1:])) if err != nil { panic(err) } } ``` Node.js ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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 { let client = Client.createClient(); let sendHeaders = new $dingtalkconvFile_1_0.SendHeaders({ }); sendHeaders.xAcsDingtalkAccessToken = ""; let sendRequest = new $dingtalkconvFile_1_0.SendRequest({ unionId: "chyxxxxx", spaceId: "865xxxxx", dentryId: "897xxxxx", openConversationId: "cid+vIrzxxxxx", }); try { await client.sendWithOptions(sendRequest, sendHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err contains the code and message attributes that help troubleshoot the issue } } } } Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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.SendHeaders sendHeaders = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendHeaders(); sendHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendRequest sendRequest = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendRequest { UnionId = "chyxxxxx", SpaceId = "865xxxxx", DentryId = "897xxxxx", OpenConversationId = "cid+vIrzxxxxx", }; try { client.SendWithOptions(sendRequest, sendHeaders, 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 that help troubleshoot the issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err contains the code and message attributes that help troubleshoot the issue } } } } } ``` ## Response ### Response body | Name | Type | Description | | -------------- | ------ | ------------------------------------------------------------------------------------- | | file | Object | Information about the file sent to the target chat. | | id | String | The file ID. | | conversationId | String | The ID of the chat that the file belongs to. | | spaceId | String | The ID of the space that the file belongs to. | | parentId | String | The ID of the parent folder of the file. The root folder ID is 0. | | type | String | The file type. - **FILE**: file - **FOLDER**: folder | | name | String | The file name. | | size | Long | The file size, in bytes. | | path | String | The file path. | | version | Long | The file version number. | | status | String | The file status. - **NORMAL**: normal - **DELETED**: deleted - **EXPIRED**: expired | | extension | String | The file extension. | | creatorId | String | The unionId of the file creator. | | modifierId | String | The unionId of the file modifier. | | createTime | String | The creation time of the file, in ISO 8601 format. Example: 2022-07-29T14:55Z. | | modifiedTime | String | The last modified time of the file, in ISO 8601 format. Example: 2022-07-29T14:55Z. | | uuid | String | The identifier field. | ### Response body example ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "file" : { "id" : "897xxxxx", "conversationId" : "cid+vIrzxxxxx", "spaceId" : "865xxxxx", "parentId" : "parent_id", "type" : "FILE", "name" : "TestFile.txt", "size" : 256, "path" : "./TestFile.txt", "version" : 1, "status" : "NORMAL", "extension" : "txt", "creatorId" : "chyxxxxx", "modifierId" : "chyxxxxx", "createTime" : "2022-01-01T10:00:00Z", "modifiedTime" : "2022-01-01T10:00:00Z", "uuid" : "123xxxxx" } } ``` ### Error codes If the API call returns an error, refer to the [Global error codes](/open/development/server-api-error-codes-1) document to find a solution based on the error message. | HttpCode | Error code | Error message | Description | | -------- | ------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | 400 | paramError | %s | Parameter error | | 400 | paramError.spaceId | %s | Parameter error - spaceId | | 400 | paramError.dentryId | %s | Parameter error - dentryId | | 400 | paramError.conversationId | %s | Parameter error - conversationId | | 400 | folderNotSupport | %s | Sending a folder is not supported | | 403 | permissionDenied | %s | The user does not have permission to copy the file to be sent, or the user does not have permission to add files to the storage space of the target chat | | 404 | conversationNotExist | %s | The target chat does not exist | | 500 | systemError | %s | System error | | 500 | unknownError | Unknown Error | Unknown error |