指定したチャットへファイルを送信

本インターフェースを呼び出して、指定したチャットへファイルを送信します。

リクエスト

基本情報

フィールド	値
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	はい	本インターフェースを呼び出す際のアクセス認証情報です。社内アプリの access_token を取得インターフェースを呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
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 {

    /**
     * トークンを使用してアカウント 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:
        """
        トークンを使用してアカウント 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 {

    /**
     * トークンを使用してアカウント 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"
)

/**
 * トークンを使用してアカウント 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 {

  /**
   * トークンを使用してアカウント 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 
    {

        /**
         * トークンを使用してアカウント 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	不明なエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

指定したチャットへファイルを送信

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード