# 描述扩展上传文件信息

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：describeExtensionUploadInfo

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：cloudbase.describeExtensionUploadInfo

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：49

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "ExtensionFiles",
    "类型": "objarray",
    "必填": "是",
    "说明": "待上传的文件列表"
  }
]
```

">

### Body.ExtensionFiles(Array) `Object Payload`

待上传的文件列表

```json
[
  {
    "参数名": "FileType",
    "类型": "string",
    "必填": "是",
    "说明": "文件类型。枚举值\nFUNCTION：函数代码\nSTATIC：静态托管代码\nSMS：短信文件"
  },
  {
    "参数名": "FileName",
    "类型": "string",
    "必填": "是",
    "说明": "文件名，长度不超过24"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "FilesData",
    "类型": "objarray",
    "说明": "待上传文件的信息数组"
  },
  {
    "参数名": "RequestId",
    "类型": "string",
    "说明": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。"
  }
]
```

">

### Res.FilesData(Array) `Object Payload`

待上传文件的信息数组

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

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

### 5.1 HTTPS调用

请求示例

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

返回示例

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

### 5.2 云函数调用

请求示例

```js
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
  }
}
```

返回示例

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

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "小游戏": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。