通過本接口上傳圖片后可獲得圖片URL地址。圖片URL可在微信支付營銷相關的API使用,包括商家券、代金券、支付有禮等。
# 接口說明
支持商戶:
【普通服務商】
請求方式:
【POST】/v3/marketing/favor/media/image-upload
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 字段說明
# 請求參數(shù)
- file 必填 message將媒體圖片進行二進制轉(zhuǎn)換,得到的媒體圖片二進制內(nèi)容,在請求body中上傳此二進制內(nèi)容。媒體圖片只支持JPG、BMP、PNG格式,文件大小不能超過2M。
- meta 必填 Object媒體文件元信息,使用json表示,包含兩個對象:filename、sha256。
- 屬性
Body 包體參數(shù)
請求示例
示例代碼
JAVA詳細請求示例見:wechatpay-apache-httpclient (opens new window)
PHP詳細請求示例見:wechatpay-guzzle-middleware (opens new window)
# 應答字段
- media_url 必填 string(256)微信返回的媒體文件標識URL。有效期為永久
200OK
應答示例
200 OK
# 請求步驟
# 圖片上傳步驟
# 1. 創(chuàng)建一個POST的方法請求/upload URI
例如: POST https://api.mch.weixin.qq.com/v3/marketing/favor/media/image-upload HTTP/1.1
# 2. 將文件的數(shù)據(jù)添加到請求主體
2.1. 圖片文件file參數(shù)的獲取方式說明:
媒體圖片二進制內(nèi)容,放在請求HTTP的body中。
2.2. 媒體文件元信息meta參數(shù)的獲取方式說明:
媒體文件元信息,使用json表示,包含兩個對象:filename、sha256。
- filename參數(shù)獲取方式說明:
商戶上傳的媒體圖片的名稱,商戶自定義,必須以JPG、BMP、PNG為后綴。
- sha256參數(shù)獲取方式說明:
圖片文件的文件摘要,即對圖片文件的二進制內(nèi)容進行sha256計算得到的值。
2.3. 簽名計算說明:
簽名生成
參與簽名計算的請求主體為meta的json串:
{ "filename": "filea.jpg", "sha256": "hjkahkjsjkfsjk78687dhjahdajhk" }
待簽名串示例:
1POST2/v3/marketing/favor/media/image-upload31566987169 //時間戳412ced2db6f0193dda91ba86224ea1cd8 //隨機數(shù)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的內(nèi)容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即為媒體圖片的二進制內(nèi)容12--boundary--
注意
請求包體每行結(jié)尾都需要包含\r\n(空行也需要)。
# 5.發(fā)送請求
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--
# 錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 圖片文件為空 | 商戶更換文件后,重新調(diào)用 |
403 | REQUEST_BLOCKED | 未知圖片類型 | 圖片類型必須為JPG、BMP、PNG |
403 | REQUEST_BLOCKED | 圖片meta信息不一致 | 請檢查meta信息是否正確 |
403 | REQUEST_BLOCKED | 簽名信息不匹配 | 請檢查簽名信息 |