图片上传(营销专用)
更新时间:2023.08.23通过本接口上传图片后可获得图片URL地址。图片URL可在微信支付营销相关的API使用,包括商家券、代金券、支付有礼等。
# 接口说明
支持商户:
【普通服务商】
请求方式:
【POST】/v3/marketing/favor/media/image-upload
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看
# 字段说明
# 请求参数
- file 必填将媒体图片进行二进制转换,得到的媒体图片二进制内容,在请求body中上传此二进制内容。媒体图片只支持JPG、BMP、PNG格式,文件大小不能超过2M。
- meta 必填媒体文件元信息,使用json表示,包含两个对象:filename、sha256。
- 属性
Body 包体参数
请求示例
示例代码
JAVA详细请求示例见:wechatpay-apache-httpclient (opens new window)
PHP详细请求示例见:wechatpay-guzzle-middleware (opens new window)
# 应答字段
- media_url 必填微信返回的媒体文件标识URL。有效期为永久
200OK
应答示例
200 OK
# 请求步骤
# 图片上传步骤
# 1. 创建一个POST的方法请求/upload URI
例如: POST https://api.mch.weixin.qq.com/v3/marketing/favor/media/image-upload HTTP/1.1
# 2. 将文件的数据添加到请求主体
2.1. 图片文件file参数的获取方式说明:
媒体图片二进制内容,放在请求HTTP的body中。
2.2. 媒体文件元信息meta参数的获取方式说明:
媒体文件元信息,使用json表示,包含两个对象:filename、sha256。
- filename参数获取方式说明:
商户上传的媒体图片的名称,商户自定义,必须以JPG、BMP、PNG为后缀。
- sha256参数获取方式说明:
图片文件的文件摘要,即对图片文件的二进制内容进行sha256计算得到的值。
2.3. 签名计算说明:
签名生成
参与签名计算的请求主体为meta的json串:
{ "filename": "filea.jpg", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk" }
待签名串示例:
1POST2/v3/marketing/favor/media/image-upload31566987169 //时间戳412ced2db6f0193dda91ba86224ea1cd8 //随机数5{"filename":"filea.jpg","sha256":"hjkahkjsjkfsjk78687dhjahdajhk"}
# 3. 添加HTTP头
1Content-Type:multipart/form-data.设置为要上载的对象的MIME媒体类型。2Authorization: WECHATPAY2-SHA256-RSA2048 mchid="1900231671",3nonce_str="PCHK6HSOEDTACETP6P3AL7DWPHTBKIAT",timestamp="1567067659",4serial_no="1FB89742D19F2BD30B69948D16DECA0FCB4481EB",5signature="PB6M7+3JL7TSCl5zqD1sdWVypOIEQsD4dgOU+vPiVM6GMRo2qYSWKf8u46i9ZJFhyZTBdZ7SFR+BjDZh6689hFgN8LZL+QWTvq3cse/FEUFYyOLN7L/2IZX4GA4cWInuJ2MpOhZRMpm+emrcn42gTMKAPNQ7dBLO7ux6MoSuQp697PW+p1ogmkER68exTVUXYqA5P3vITlWNr++RDy2+ExvB7qVISOKW0vBkxUxN9e7hwUbDwGln170ZXomoO1KpQSbw3f1u8WUCx/IlWJhJIun7rUMtVT+kfijNUqcILtSfE4hWKKVaZn9j5CX8M7aKbbDOFy3SvbSJ3WQgRnRbgog5w=="9Content-Type: multipart/form-data;boundary=boundary
# 4. 添加body
1// 以下为body的内容2--boundary // boundary为商户自定义的一个字符串3Content-Disposition: form-data; name="meta";4Content-Type: application/json5//此处必须有一个空行6{ "filename": "filea.jpg", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk" }7--boundary8Content-Disposition: form-data; name="file"; filename="filea.jpg";9Content-Type: image/jpg10//此处必须有一个空行11pic1 //pic1即为媒体图片的二进制内容12--boundary--
注意
请求包体每行结尾都需要包含\r\n(空行也需要)。
# 5.发送请求
1POST /v3/marketing/favor/media/image-upload HTTP/1.12Host: api.mch.weixin.qq.com3Authorization: WECHATPAY2-SHA256-RSA2048 4mchid="1900231671",nonce_str="PCHK6HSOEDTACETP6P3AL7DWPHTBKIAT",5timestamp="1567067659",6serial_no="1FB89742D19F2BD30B69948D16DECA0FCB4481EB",7signature="PB6M7+3JL7TSCl5zqD1sdWVypOIEQsD4dgOU+vPiVM6GMRo2qYSWKf8u46i9ZJFhyZTBdZ78SFR+BjDZh689hFgN8LZL+QWTvq3cse/FEUFYyOLN7L/2IZX4GA4cWInuJ2MpOhZRMpm+emrcn42gTMKAPN9Q7dBLO7ux6MoSuQp69PW+p1ogmkER68exTVUXYqA5P3vITlWNr++RDy2+ExvB7qVISOKW0vBkxUxN9e107hwUbDwGln170ZXomoO1KpQSbw3f1uWUCx/IlWJhJIun7rUMtVT+kfijNUqcILtSfE4hWKKVaZn9j5CX8M117aKbbDOFy3SvbSJ3WQgRnRbgog5w=="12Content-Type: multipart/form-data;boundary=boundary1314--boundary 15Content-Disposition: form-data; name="meta";16Content-Type: application/json1718{ "filename": "filea.jpg", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk" }19--boundary20Content-Disposition: form-data; name="file"; filename="filea.jpg";21Content-Type: image/jpg2223pic124--boundary--
# 错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 图片文件为空 | 商户更换文件后,重新调用 |
403 | REQUEST_BLOCKED | 未知图片类型 | 图片类型必须为JPG、BMP、PNG |
403 | REQUEST_BLOCKED | 图片meta信息不一致 | 请检查meta信息是否正确 |
403 | REQUEST_BLOCKED | 签名信息不匹配 | 请检查签名信息 |
文档是否有帮助