リソースアップロード情報の取得

この API を呼び出して、ドキュメント内の指定リソースのアップロードアドレスを照会します。

API 呼び出し説明

リソースとは、ドキュメント内の画像やファイルなどの添付を指します。本 API は通常、他プロダクトの添付アップロード API と組み合わせて使用します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/doc/docs/resources/{docId}/uploadInfos/query`
HTTP Method	POST
対応アプリタイプ	appType-社内アプリ
必要な権限	permission-Storage.File.Read-企業ストレージファイル読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	この API を呼び出すためのアクセス認証情報。社内アプリの accessToken を取得 API を呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
docId	String	はい	ドキュメント ID (dentryUuid/documentId/workbookId/baseId)。以下の 2 つの方法で取得できます： - ナレッジベースドキュメントの作成 API を呼び出して取得します。 - ノードリストの取得 API を呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	はい	操作者の unionId。ユーザー詳細の照会 API またはサイレントログインコードでユーザー情報を取得 API を呼び出して取得します。

リクエストボディ

名前	タイプ	必須	説明
size	Long	はい	リソースのサイズ。単位：バイト。
mediaType	String	はい	リソースのタイプ。具体的な値は MIME Types を参照してください。
resourceName	String	はい	リソース名。

リクエスト例

HTTP

POST /v1.0/doc/docs/resources/xxxxx/uploadInfos/query?operatorId=xxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "size" : 200,
  "mediaType" : "image/jpeg",
  "resourceName" : "logo.jpg"
}

Java

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

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント Client を初期化</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_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.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.GetResourceUploadInfoHeaders getResourceUploadInfoHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetResourceUploadInfoHeaders();
        getResourceUploadInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.GetResourceUploadInfoRequest getResourceUploadInfoRequest = new com.aliyun.dingtalkdoc_1_0.models.GetResourceUploadInfoRequest()
                .setOperatorId("xxxxx")
                .setSize(200L)
                .setMediaType("image/jpeg")
                .setResourceName("logo.jpg");
        try {
            client.getResourceUploadInfoWithOptions("xxxxx", getResourceUploadInfoRequest, getResourceUploadInfoHeaders, 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 os
import sys

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__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() -> dingtalkdoc_1_0Client:
        """
        Token を使用してアカウント Client を初期化
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_resource_upload_info_headers = dingtalkdoc__1__0_models.GetResourceUploadInfoHeaders()
        get_resource_upload_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_resource_upload_info_request = dingtalkdoc__1__0_models.GetResourceUploadInfoRequest(
            operator_id='xxxxx',
            size=200,
            media_type='image/jpeg',
            resource_name='logo.jpg'
        )
        try:
            client.get_resource_upload_info_with_options('xxxxx', get_resource_upload_info_request, get_resource_upload_info_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()
        get_resource_upload_info_headers = dingtalkdoc__1__0_models.GetResourceUploadInfoHeaders()
        get_resource_upload_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_resource_upload_info_request = dingtalkdoc__1__0_models.GetResourceUploadInfoRequest(
            operator_id='xxxxx',
            size=200,
            media_type='image/jpeg',
            resource_name='logo.jpg'
        )
        try:
            await client.get_resource_upload_info_with_options_async('xxxxx', get_resource_upload_info_request, get_resource_upload_info_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\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetResourceUploadInfoHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetResourceUploadInfoRequest;
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();
        $getResourceUploadInfoHeaders = new GetResourceUploadInfoHeaders([]);
        $getResourceUploadInfoHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getResourceUploadInfoRequest = new GetResourceUploadInfoRequest([
            "operatorId" => "xxxxx",
            "size" => 200,
            "mediaType" => "image/jpeg",
            "resourceName" => "logo.jpg"
        ]);
        try {
            $client->getResourceUploadInfoWithOptions("xxxxx", $getResourceUploadInfoRequest, $getResourceUploadInfoHeaders, 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 (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Token を使用してアカウント Client を初期化
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_1_0.Client{}
  _result, _err = dingtalkdoc_1_0.NewClient(config)
  return _result, _err
}

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

  getResourceUploadInfoHeaders := &dingtalkdoc_1_0.GetResourceUploadInfoHeaders{}
  getResourceUploadInfoHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getResourceUploadInfoRequest := &dingtalkdoc_1_0.GetResourceUploadInfoRequest{
    OperatorId: tea.String("xxxxx"),
    Size: tea.Int64(200),
    MediaType: tea.String("image/jpeg"),
    ResourceName: tea.String("logo.jpg"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetResourceUploadInfoWithOptions(tea.String("xxxxx"), getResourceUploadInfoRequest, getResourceUploadInfoHeaders, &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

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Token を使用してアカウント Client を初期化
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdoc_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let getResourceUploadInfoHeaders = new dingtalkdoc_1_0.GetResourceUploadInfoHeaders({ });
    getResourceUploadInfoHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let getResourceUploadInfoRequest = new dingtalkdoc_1_0.GetResourceUploadInfoRequest({
      operatorId: 'xxxxx',
      size: 200,
      mediaType: 'image/jpeg',
      resourceName: 'logo.jpg',
    });
    try {
      await client.getResourceUploadInfoWithOptions('xxxxx', getResourceUploadInfoRequest, getResourceUploadInfoHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message 属性が含まれており、開発時の問題特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Token を使用してアカウント Client を初期化</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetResourceUploadInfoHeaders getResourceUploadInfoHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetResourceUploadInfoHeaders();
            getResourceUploadInfoHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetResourceUploadInfoRequest getResourceUploadInfoRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetResourceUploadInfoRequest
            {
                OperatorId = "xxxxx",
                Size = 200,
                MediaType = "image/jpeg",
                ResourceName = "logo.jpg",
            };
            try
            {
                client.GetResourceUploadInfoWithOptions("xxxxx", getResourceUploadInfoRequest, getResourceUploadInfoHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
success	Boolean	成功したかどうか。
result	Object	結果。
uploadUrl	String	アップロード URL。
resourceId	String	リソース ID。
resourceUrl	String	リソースパス。

レスポンスボディ例

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

{
  "success" : true,
  "result" : {
    "uploadUrl" : "https://xxx.com?Expires=xxx&Signature=xxx",
    "resourceId" : "6c6a466c-6a52-4aa0-a80f-13896e635145",
    "resourceUrl" : "/core/api/resources/img/xxx"
  }
}

エラーコード

この API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を確認してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	%s	パラメータエラー
403	permissionDenied	%s	権限なし
404	docNotExist	%s	ドキュメントが存在しません
500	systemError	%s	サービスがビジー状態です。後で再試行してください
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストがタイムアウトしました

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リソースアップロード情報の取得

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード