# 上传资料

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

接口英文名：uploadec

可通过该接口上传文件，用于下单后传给商家进行定制商品发货

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/channels/ec/open/upload?access_token=ACCESS_TOKEN&upload_type=UPLOAD_TYPE&openid=OPENID
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代微信小店商家调用。[第三方服务商调用模式介绍](/doc/store/shop/dev_before/third_party_platforms)

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

- 服务商获得其中之一权限集授权后，可通过使用 [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",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/shop/API/apimgnt/common/api_getaccesstoken)（小程序）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）",
    "枚举": "-"
  },
  {
    "参数名": "upload_type",
    "类型": "number",
    "必填": "是",
    "示例": "",
    "说明": "上传方式",
    "枚举": "枚举值"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "示例": "",
    "说明": "上传资料的用户openid（upload_type=0时必填）",
    "枚举": "-"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "说明": "上传资料的用户openid（upload_type=1时必填）"
  },
  {
    "参数名": "file_url",
    "类型": "string",
    "必填": "否",
    "说明": "上传文件的url，支持图片、CAD、3dMax、压缩包、PDF,Excel、Word等\nupload_type=1时必填，支持<50M大小的文件"
  },
  {
    "参数名": "file",
    "类型": "buffer",
    "必填": "否",
    "说明": "上传的资料文件内容，支持图片、CAD、3dMax、压缩包、PDF、Excel、Word等\nupload_type=0时必填，支持<10M大小的文件"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "media_id",
    "类型": "string",
    "说明": "文件media_id"
  }
]
```

## 4. 枚举信息

### Query.upload_type `Enum`

上传方式

```json
[
  {
    "枚举值": "0",
    "描述": "上传文件二进制"
  },
  {
    "枚举值": "1",
    "描述": "文件url上传"
  }
]
```

## 5. 注意事项

1. 文件最大支持50M
2. 添加HTTP头Content-Type: multipart/form-data

### 支持上传的文件格式：

| 类型    | 格式    | Content-Type                                                           |
|-------|-------|------------------------------------------------------------------------|
| 图片    | .bmp  | image/bmp                                                              |
|   图片    | .jpg  | image/jpeg，image/jpg                                                   |
|  图片     | .jpeg | image/jpeg，image/jpg                                                   |
|  图片     | .png  | image/png，application/x-png                                            |
|  图片     | .svg  | text/xml                                                               |
|  图片     | .webp | image/webp                                                             |
| CAD   | .dwg  | application/acad                                                       |
|  CAD     | .dxf  | application/dxf                                                        |
|  CAD     | .dgn  | image/vnd.dgn                                                          |
|  CAD     | .stl  | model/stl，application/sla                                              |
| 3DMax | .max  | application/octet-stream                                               |
|    3DMax   | .3d   | application/octet-stream                                               |
|   3DMax    | .fbx  | application/octet-stream                                               |
|    3DMax   | .abc  | application/octet-stream                                               |
|   3DMax    | .dae  | application/octet-stream                                               |
| 压缩包   | .zip  | application/zip                                                        |
|      压缩包 | .rar  | application/x-rar-compressed                                           |
| 压缩包      | .7z   | application/x-7z-compressed                                            |
|       压缩包| .gz   | application/gzip，application/x-gzip                                    |
| 普通文件  | .docx | application/vnd.openxmlformats-officedocument.wordprocessingml.documen |
|   普通文件    | .doc  | application/msword                                                     |
| 普通文件      | .xls  | application/vnd.ms-excel                                               |
| 普通文件      | .xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet      |
| 普通文件      | .csv  | text/csv                                                               |
| 普通文件      | .pdf  | application/pdf                                                        |

注：压缩包中只能包含支持的文件类型

## 6. 代码示例

### 6.1 上传文件二进制

请求示例

```bash
curl -F file=@test.png
"https://api.weixin.qq.com/channels/ec/open/upload?access_token=ACCESS_TOKEN&openid=xxxx&upload_type=0"
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "",
    "media_id": ""
}
```

### 6.2 以文件url上传

请求示例

```bash
curl -X POSt -d'{"openid":"xxx","file_url":"xxx"}'
"https://api.weixin.qq.com/channels/ec/open/upload?access_token=ACCESS_TOKEN&upload_type=1"
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "",
    "media_id": ""
}
```

## 7. 错误码

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

```json
[
  {
    "错误码": "-1",
    "错误描述": "系统失败，请重试"
  },
  {
    "错误码": "0",
    "错误描述": "成功"
  },
  {
    "错误码": "10001",
    "错误描述": "无效的mediaid"
  },
  {
    "错误码": "10002",
    "错误描述": "无效的mediaid"
  },
  {
    "错误码": "10003",
    "错误描述": "文件正在上传中，请等待"
  },
  {
    "错误码": "10004",
    "错误描述": "上传文件存在风险，请重新上传"
  },
  {
    "错误码": "10005",
    "错误描述": "订单已取消，禁止下载文件"
  },
  {
    "错误码": "10006",
    "错误描述": "订单已结束，禁止下载文件"
  },
  {
    "错误码": "10007",
    "错误描述": "上传文件格式不支持"
  },
  {
    "错误码": "10008",
    "错误描述": "上传文件的大小超过最大值"
  },
  {
    "错误码": "10009",
    "错误描述": "下载文件次数超过日上限，请第二天再试"
  },
  {
    "错误码": "10010",
    "错误描述": "上传url(file_url)无效，无法下载文件"
  }
]
```

## 8. 适用范围

本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明，均不可调用。
