cloudbase.describeExtensionUploadInfo

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

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

描述扩展上传文件信息

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性 类型 默认值 必填 说明
access_token / cloudbase_access_token string 接口调用凭证
ExtensionFiles Array.<Object> 待上传的文件列表

ExtensionFiles 的结构

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

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
FilesData Array.<Object> 待上传文件的信息数组
RequestId string 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

errcode 的合法值

说明 最低版本
0 请求成功
-1 系统繁忙,此时请开发者稍候再试
-501007 参数有误,具体原因参考 errmsg

FilesData 的结构

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

请求数据示例

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

云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

openapi.cloudbase.describeExtensionUploadInfo

需在 config.json 中配置 cloudbase.describeExtensionUploadInfo API 的权限,详情

请求参数

属性 类型 默认值 必填 说明
ExtensionFiles Array.<Object> 待上传的文件列表

ExtensionFiles 的结构

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

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errCode number 错误码
errMsg string 错误信息
FilesData Array.<Object> 待上传文件的信息数组
RequestId string 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

errCode 的合法值

说明 最低版本
0 成功

FilesData 的结构

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

异常

Object

抛出的异常

属性 类型 说明
errCode number 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本
-1 系统繁忙,此时请开发者稍候再试
-501007 参数有误,具体原因参考 errmsg

请求数据示例

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