# 申请分片上传
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:applyUpload
上传大文件时需使用分片上传方式,分为 3 个步骤:
- 申请分片上传,确定文件名、格式类型,返回
upload_id,唯一标识本次分片上传。 - 上传分片,多次调用上传文件分片,需要携带
part_number和upload_id,其中part_number为分片的编号,支持乱序上传。当传入part_number和upload_id都相同的时候,后发起上传请求的分片将覆盖之前的分片。 - 确认分片上传,当上传完所有分片后,需要完成整个文件的合并。请求体中需要给出每一个分片的
part_number和etag,用来校验分片的准确性,最后返回文件的media_id。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/sec/vod/applyupload?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:153
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| media_name | string | 是 | 我的演艺 - 第1集 | 文件名,需按照“剧目名 - 对应剧集数”格式命名文件 |
| media_type | string | 是 | MP4 | 视频格式,支持:MP4,TS,MOV,MXF,MPG,FLV,WMV,AVI,M4V,F4V,MPEG,3GP,ASF,MKV |
| cover_type | string | 否 | JPG | 封面图图片格式,支持:JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF |
| source_context | string | 否 | - | 来源上下文,会在上传完成事件中透传给开发者。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| upload_id | string | 本次分片上传的唯一标识 |
# 4. 注意事项
- 如果填写了 cover_type,表明本次分片上传除上传媒体文件外还需要上传封面图片,不填写 cover_type 则默认截取视频首帧作为封面图片。
- Content-Type 需要指定为 application/json
# 5. 代码示例
请求示例
{
"media_name": "我的演艺 - 第1集",
"media_type": "MP4",
"cover_type": "JPG"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"upload_id": "123456"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -2 | 初始化未完成,请稍后再试 |
| -1 | 系统错误 |
| 43002 | HTTP请求必须使用POST方法 |
| 44002 | POST内容为空 |
| 47001 | 输入格式错误 |
| 47003 | 参数不符合要求 |
| 10090001 | 视频类型不支持 |
| 10090002 | 图片类型不支持 |
| 10090003 | 图片URL无效 |
| 10090005 | resource_type无效 |
| 10090038 | 被授权账号没有【文娱-微短剧】类目 |
| 10090039 | 已经被解除授权 |
| 10090040 | 剧集已经被占用 |
| 10090041 | 剧目名称不符合规范 |
| 10090042 | 剧集名称不符合规范 |
| 10090043 | 不存在授权关系 |
| 10093011 | 操作失败 |
| 10093014 | 参数错误(包括参数格式、类型等错误) |
| 10093023 | 操作过于频繁 |
| 10093030 | 资源不存在 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。