发送文件到指定会话 - DingTalk Help Center

调用本接口，发送文件到指定会话。

请求

基本信息

字段	值
HTTP URL	https://api.dingtalk.io/v1.0/convFile/conversations/files/send
HTTP Method	POST
支持的应用类型	appType-企业内部应用
权限要求	permission-ConvFile.File.Send-群文件发送权限

请求头

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证，通过调用获取企业内部应用的accessToken接口获取。

查询参数

名称	类型	是否必填	描述
unionId	String	是	操作人的unionId，可调用查询用户详情接口获取。

请求体

名称	类型	是否必填	描述
spaceId	String	是	空间ID，调用添加空间接口获取id参数值。
dentryId	String	是	文件ID，调用获取文件或文件夹列表接口获取id参数值。
openConversationId	String	是	目标会话的openConversationId，调用创建群接口获取openConversationId参数值。

请求示例

HTTP

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

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @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.SendHeaders sendHeaders = new com.aliyun.dingtalkconv_file_1_0.models.SendHeaders();
        sendHeaders.xAcsDingtalkAccessToken = "<your access token>";
        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 中含有 code 和 message 属性，可帮助开发定位问题
            }

        } 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 中含有 code 和 message 属性，可帮助开发定位问题
            }

        }        
    }
}

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:
        """
        使用 Token 初始化账号Client
        @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 = '<your 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 中含有 code 和 message 属性，可帮助开发定位问题
                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 = '<your 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 中含有 code 和 message 属性，可帮助开发定位问题
                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\SendHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Models\SendRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @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();
        $sendHeaders = new SendHeaders([]);
        $sendHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $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 中含有 code 和 message 属性，可帮助开发定位问题
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

// 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"
)

/**
 * 使用 Token 初始化账号Client
 * @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("<your access token>")
  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 中含有 code 和 message 属性，可帮助开发定位问题
    }

  }
  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 {

  /**
   * 使用 Token 初始化账号Client
   * @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 sendHeaders = new $dingtalkconvFile_1_0.SendHeaders({ });
    sendHeaders.xAcsDingtalkAccessToken = "<your access token>";
    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 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

Client.main(process.argv.slice(2));

// 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 
    {

        /**
         * 使用 Token 初始化账号Client
         * @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 = "<your access token>";
            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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
            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 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称	类型	描述
file	Object	发送到目标会话的文件信息。
id	String	文件ID。
conversationId	String	文件所在的会话ID。
spaceId	String	文件所在空间ID。
parentId	String	文件的父目录ID，根目录ID值为0。
type	String	文件类型。 - FILE：文件 - FOLDER：文件夹
name	String	文件名称。
size	Long	文件大小，单位Byte。
path	String	文件路径。
version	Long	文件版本号。
status	String	文件状态。 - NORMAL：正常 - DELETED：已删除 - EXPIRED：已过期
extension	String	文件后缀。
creatorId	String	文件的创建者unionId。
modifierId	String	文件的修改者unionId。
createTime	String	文件的创建时间，iso8601格式，例如：2022-07-29T14:55Z。
modifiedTime	String	文件的修改时间，iso8601格式，例如：2022-07-29T14:55Z。
uuid	String	标识字段。

响应体示例

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

{
  "file" : {
    "id" : "897xxxxx",
    "conversationId" : "cid+vIrzxxxxx",
    "spaceId" : "865xxxxx",
    "parentId" : "parent_id",
    "type" : "FILE",
    "name" : "测试文件.txt",
    "size" : 256,
    "path" : "./测试文件.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"
  }
}

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

HttpCode	错误码	错误信息	说明
400	paramError	%s	参数错误
400	paramError.spaceId	%s	参数错误-spaceId
400	paramError.dentryId	%s	参数错误-dentryId
400	paramError.conversationId	%s	参数错误-conversationId
400	folderNotSupport	%s	不支持发送文件夹
403	permissionDenied	%s	用户缺少待发送文件的拷贝权限或者用户缺少目标会话存储空间添加文件的权限
404	conversationNotExist	%s	目标会话不存在
500	systemError	%s	系统错误
500	unknownError	Unknown Error	未知错误

​请求

​基本信息

​请求头

​查询参数

​请求体

​请求示例

​响应

​响应体

​响应体示例

​错误码

请求

基本信息

请求头

查询参数

请求体

请求示例

响应

响应体

响应体示例

错误码