# 描述扩展上传文件信息

调试工具

接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

# 接口说明

# 接口英文名

describeExtensionUploadInfo

# 功能描述

该接口用于描述扩展上传文件信息。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/tcb/describeextensionuploadinfo?access_token=ACCESS_TOKEN

# 云调用

出入参和HTTPS调用相同，调用方式可查看云调用说明文档
接口方法为: openapi.cloudbase.describeExtensionUploadInfo

# 第三方调用

调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：49、64
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性

类型

必填

说明

access_token

string

是

接口调用凭证，该参数为 URL 参数，非 Body 参数。使用getAccessToken 或者 authorizer_access_token

ExtensionFiles

array<object>

是

待上传的文件列表

	属性	类型	必填	说明
	FileType	string	是	文件类型。枚举值 FUNCTION：函数代码 STATIC：静态托管代码 SMS：短信文件
	FileName	string	是	文件名，长度不超过24

# 返回参数

属性

类型

说明

errcode

number

错误码

errmsg

string

错误信息

FilesData

array<object>

待上传文件的信息数组

属性	类型	说明
CodeUri	string	模板里使用的地址
UploadUrl	string	上传文件的临时地址，含签名
CustomKey	string	自定义密钥。如果为空，则表示不需要加密
MaxSize	number	文件大小限制，单位M，客户端上传前需要主动检查文件大小，超过限制的文件会被删除。

RequestId

string

唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

# 调用示例

示例说明: HTTPS调用

# 请求数据示例


{
  "PostData": {
    "ExtensionFiles": [{
      "FileType":"SMS",
      "FileName":"gongzi.csv"
    }]
  }
}

# 返回数据示例


{
  "Response":{
    "FilesData":[
      {
        "CodeUri":"extension://xxx.zip",
        "UploadUrl":"https://xxx",
        "CustomKey":"",
        "MaxSize":30
      }
    ],
    "RequestId":"83793d78-b90b-4b1e-9454-d7b4f5317f01"
  }
}

示例说明: 云函数调用

# 请求数据示例


const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi({ convertCase: false }).cloudbase.describeExtensionUploadInfo({
        "PostData": {
          "ExtensionFiles": [
            {
              "FileType": 'SMS',
              "FileName": 'gongzi.csv'
            }
          ]
        }
      })
    return result
  } catch (err) {
    return err
  }
}

# 返回数据示例


{
  "Response": {
    "FilesData": [
      {
        "CodeUri": "extension://xxx.zip",
        "UploadUrl": "https://xxx",
        "CustomKey": "",
        "MaxSize": 30
      }
    ],
    "RequestId": "83793d78-b90b-4b1e-9454-d7b4f5317f01"
  },
  "errMsg": "openapi.cloudbase.describeExtensionUploadInfo:ok"
}

# 错误码

错误码	错误码取值	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试