微信公众号开发之新增临时素材一、新增临时素材公众号经常有需要用到一些临时性的多媒体素材的场景,例如在使用接口特别是发送消息时,对多媒体文件、多媒体消息的获取和调用等操作,是通过media_id来进行的素材管理接口对所有认证的订阅。

一、新增临时素材
公众号经常有需要用到一些临时性的多媒体素材的场景,例如在使用接口特别是发送消息时,对多媒体文件、多媒体消息的获取和调用等操作,是通过media_id来进行的。素材管理接口对所有认证的订阅号和服务号开放。通过本接口,公众号可以新增临时素材(即上传临时多媒体文件)。
注意点:
1、临时素材media_id是可复用的。
2、媒体文件在微信后台保存时间为3天,即3天后media_id失效。
3、上传临时素材的格式、大小限制与公众平台官网一致。
图片(image): 2M,支持PNG\JPEG\JPG\GIF格式
语音(voice):2M,播放长度不超过60s,支持AMR\MP3格式
视频(video):10MB,支持MP4格式
缩略图(thumb):64KB,支持JPG格式
4、需使用https调用本接口。
接口调用请求说明
http请求方式:POST/FORM,使用https https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE 调用示例(使用curl命令,用FORM表单方式上传一个多媒体文件): curl -F media=@test.jpg "https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE"
参数说明
参数是否必须说明access_token是调用接口凭证type是媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb)media是form-data中媒体文件标识,有filename、filelength、content-type等信息
返回说明
正确情况下的返回JSON数据包结果如下:
{"type":"TYPE","media_id":"MEDIA_ID","created_at":123456789}
参数描述type媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb,主要用于视频与音乐格式的缩略图)media_id媒体文件上传后,获取标识created_at媒体文件上传时间戳
错误情况下的返回JSON数据包示例如下(示例为无效媒体类型错误):
{"errcode":40004,"errmsg":"invalid media type"}
根据上面的接口,我们定义了一个上传临时素材的方法,包含文件目录和文件类型这两个参数,我们这里依然采用RestTemplate工具类进行文件上传
/*** 上传临时素菜* 1、临时素材media_id是可复用的。* 2、媒体文件在微信后台保存时间为3天,即3天后media_id失效。* 3、上传临时素材的格式、大小限制与公众平台官网一致。* @param filePath* @param type* @return*/public String uploadFile(String filePath,String type) {String accessToken = accessTokenUtil.getAccessToken();if (accessToken != null) {String url = URIConstant.MEDIA_UPLOAD_URL.replace("ACCESS_TOKEN", accessToken).replace("TYPE", type);log.info("MEDIA_UPLOAD_URL:{}",url);//设置请求体,注意是LinkedMultiValueMapMultiValueMap<String, Object> form = new LinkedMultiValueMap<>();FileSystemResource fileSystemResource = new FileSystemResource(filePath);form.add("media", fileSystemResource);//设置请求头HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.MULTIPART_FORM_DATA);//用HttpEntity封装整个请求报文HttpEntity<MultiValueMap<String, Object>> data = new HttpEntity<>(form, headers);try{//这里RestTemplate请求返回的字符串直接转换成JSONObject会报异常,后续深入找一下原因String resultString = restTemplate.postForObject(url, data, String.class);log.info("上传返回的信息是:{}",resultString);if(!StringUtils.isEmpty(resultString)){JSONObject jsonObject = JSONObject.parseObject(resultString);return jsonObject.getString("media_id");}}catch (Exception e){log.error(e.getMessage());}}return null;}
我们在swagger中新建一个Controller用以提交我们的上传请求,并测试我们的代码是否正确
@ApiOperation(value = "上传临时素材")@RequestMapping(value = "/uploadFile", method = RequestMethod.POST)@ApiImplicitParams({@ApiImplicitParam(name="filePath",value="文件位置", paramType="query",dataType="String"),@ApiImplicitParam(name="type",value="媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb)", paramType="query",dataType="String"),})public Object upload(String filePath, String type) throws Exception{String result = uploadUtil.uploadFile(filePath,type);return result;}
启动我们的项目,在swagger中输入一个有效的文件路径(这里假如是图片类型),type设置为image
可以看到,我们成功上传了临时文件,并获取到了该文件的media_id(这个后续很重要!!!)
二、获取临时素材
临时素材主要分为三类(图片、音频,视频),图片和音频文件支持下载到本地,视频文件支持获取视频的URL地址
(1)获取临时图片
/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 1、如果是图片,则下载图片*/public ResponseEntity<byte[]> getImage(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String fileName = mediaId".jpg";HttpHeaders headers = new HttpHeaders();try {fileName = new String(fileName.getBytes("GBK"), "ISO-8859-1");} catch (UnsupportedEncodingException e) {e.printStackTrace();}headers.setContentDispositionFormData("attachment", fileName);// 文件名称ResponseEntity<byte[]> responseEntity = restTemplate.exchange(url, HttpMethod.GET, new HttpEntity<>(headers), byte[].class);return responseEntity;}return null;}
(2)获取临时音频
/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 1、如果是声音,则下载声音*/public ResponseEntity<byte[]> getVoice(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String fileName = mediaId".speex";HttpHeaders headers = new HttpHeaders();try {fileName = new String(fileName.getBytes("GBK"), "ISO-8859-1");} catch (UnsupportedEncodingException e) {e.printStackTrace();}headers.setContentDispositionFormData("attachment", fileName);// 文件名称ResponseEntity<byte[]> responseEntity = restTemplate.exchange(url, HttpMethod.GET, new HttpEntity<>(headers), byte[].class);return responseEntity;}return null;}
(3)获取视频素材地址
/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 2、如果是视频,则返回视频的地址*/public String getVedio(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String responseString = restTemplate.getForObject(url,String.class);return responseString;}return null;}
三、测试
这里我们仅以上传临时图片素材并下载临时图片素材为例,我们在我们的Controller中新增一个根据media_id获取临时图片类型素材的方法
我们把我们刚才上传临时素材成功返回的media_id传给我们的方法
可以看到我们的swagger返回带有Download file的超级链接,点击即可下载我们的图片,当然我们可以直接在浏览器直接输入我们的完整请求地址
package com.xu.wemall.components.weixin;import com.alibaba.fastjson.JSONObject;import com.xu.wemall.commons.constants.URIConstant;import lombok.extern.slf4j.Slf4j;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.core.io.FileSystemResource;import org.springframework.http.*;import org.springframework.stereotype.Component;import org.springframework.util.LinkedMultiValueMap;import org.springframework.util.MultiValueMap;import org.springframework.util.StringUtils;import org.springframework.web.client.RestTemplate;import java.io.UnsupportedEncodingException;/** * 功能:临时素材工具类 */@Slf4j@Componentpublic class UploadUtil {@Autowiredprivate RestTemplate restTemplate;@Autowiredprivate AccessTokenUtil accessTokenUtil;/*** 上传临时素菜* 1、临时素材media_id是可复用的。* 2、媒体文件在微信后台保存时间为3天,即3天后media_id失效。* 3、上传临时素材的格式、大小限制与公众平台官网一致。* @param filePath* @param type* @return*/public String uploadFile(String filePath,String type) {String accessToken = accessTokenUtil.getAccessToken();if (accessToken != null) {String url = URIConstant.MEDIA_UPLOAD_URL.replace("ACCESS_TOKEN", accessToken).replace("TYPE", type);log.info("MEDIA_UPLOAD_URL:{}",url);//设置请求体,注意是LinkedMultiValueMapMultiValueMap<String, Object> form = new LinkedMultiValueMap<>();FileSystemResource fileSystemResource = new FileSystemResource(filePath);form.add("media", fileSystemResource);//设置请求头HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.MULTIPART_FORM_DATA);//用HttpEntity封装整个请求报文HttpEntity<MultiValueMap<String, Object>> data = new HttpEntity<>(form, headers);try{//这里RestTemplate请求返回的字符串直接转换成JSONObject会报异常,后续深入找一下原因String resultString = restTemplate.postForObject(url, data, String.class);log.info("上传返回的信息是:{}",resultString);if(!StringUtils.isEmpty(resultString)){JSONObject jsonObject = JSONObject.parseObject(resultString);return jsonObject.getString("media_id");}}catch (Exception e){log.error(e.getMessage());}}return null;}/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 1、如果是图片,则下载图片*/public ResponseEntity<byte[]> getImage(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String fileName = mediaId".jpg";HttpHeaders headers = new HttpHeaders();try {fileName = new String(fileName.getBytes("GBK"), "ISO-8859-1");} catch (UnsupportedEncodingException e) {e.printStackTrace();}headers.setContentDispositionFormData("attachment", fileName);// 文件名称ResponseEntity<byte[]> responseEntity = restTemplate.exchange(url, HttpMethod.GET, new HttpEntity<>(headers), byte[].class);return responseEntity;}return null;}/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 1、如果是声音,则下载声音*/public ResponseEntity<byte[]> getVoice(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String fileName = mediaId".speex";HttpHeaders headers = new HttpHeaders();try {fileName = new String(fileName.getBytes("GBK"), "ISO-8859-1");} catch (UnsupportedEncodingException e) {e.printStackTrace();}headers.setContentDispositionFormData("attachment", fileName);// 文件名称ResponseEntity<byte[]> responseEntity = restTemplate.exchange(url, HttpMethod.GET, new HttpEntity<>(headers), byte[].class);return responseEntity;}return null;}/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 2、如果是视频,则返回视频的地址*/public String getVedio(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String responseString = restTemplate.getForObject(url,String.class);return responseString;}return null;}}
点击这个Download File,我们成功的下载到这个上传的临时图片
试着打开这个文件,我们可以看到,这个确实是我们上传的图片
这里贴出完整的代码,自行修改以获得其他类型的临时文件,不做赘述
UploadUtil.java
package com.xu.wemall.components.weixin;import com.alibaba.fastjson.JSONObject;import com.xu.wemall.commons.constants.URIConstant;import lombok.extern.slf4j.Slf4j;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.core.io.FileSystemResource;import org.springframework.http.*;import org.springframework.stereotype.Component;import org.springframework.util.LinkedMultiValueMap;import org.springframework.util.MultiValueMap;import org.springframework.util.StringUtils;import org.springframework.web.client.RestTemplate;import java.io.UnsupportedEncodingException;/** * 功能:临时素材工具类 */@Slf4j@Componentpublic class UploadUtil {@Autowiredprivate RestTemplate restTemplate;@Autowiredprivate AccessTokenUtil accessTokenUtil;/*** 上传临时素菜* 1、临时素材media_id是可复用的。* 2、媒体文件在微信后台保存时间为3天,即3天后media_id失效。* 3、上传临时素材的格式、大小限制与公众平台官网一致。* @param filePath* @param type* @return*/public String uploadFile(String filePath,String type) {String accessToken = accessTokenUtil.getAccessToken();if (accessToken != null) {String url = URIConstant.MEDIA_UPLOAD_URL.replace("ACCESS_TOKEN", accessToken).replace("TYPE", type);log.info("MEDIA_UPLOAD_URL:{}",url);//设置请求体,注意是LinkedMultiValueMapMultiValueMap<String, Object> form = new LinkedMultiValueMap<>();FileSystemResource fileSystemResource = new FileSystemResource(filePath);form.add("media", fileSystemResource);//设置请求头HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.MULTIPART_FORM_DATA);//用HttpEntity封装整个请求报文HttpEntity<MultiValueMap<String, Object>> data = new HttpEntity<>(form, headers);try{//这里RestTemplate请求返回的字符串直接转换成JSONObject会报异常,后续深入找一下原因String resultString = restTemplate.postForObject(url, data, String.class);log.info("上传返回的信息是:{}",resultString);if(!StringUtils.isEmpty(resultString)){JSONObject jsonObject = JSONObject.parseObject(resultString);return jsonObject.getString("media_id");}}catch (Exception e){log.error(e.getMessage());}}return null;}/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 1、如果是图片,则下载图片*/public ResponseEntity<byte[]> getImage(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String fileName = mediaId".jpg";HttpHeaders headers = new HttpHeaders();try {fileName = new String(fileName.getBytes("GBK"), "ISO-8859-1");} catch (UnsupportedEncodingException e) {e.printStackTrace();}headers.setContentDispositionFormData("attachment", fileName);// 文件名称ResponseEntity<byte[]> responseEntity = restTemplate.exchange(url, HttpMethod.GET, new HttpEntity<>(headers), byte[].class);return responseEntity;}return null;}/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 1、如果是声音,则下载声音*/public ResponseEntity<byte[]> getVoice(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String fileName = mediaId".speex";HttpHeaders headers = new HttpHeaders();try {fileName = new String(fileName.getBytes("GBK"), "ISO-8859-1");} catch (UnsupportedEncodingException e) {e.printStackTrace();}headers.setContentDispositionFormData("attachment", fileName);// 文件名称ResponseEntity<byte[]> responseEntity = restTemplate.exchange(url, HttpMethod.GET, new HttpEntity<>(headers), byte[].class);return responseEntity;}return null;}/*** 公众号可以使用本接口获取临时素材(即下载临时的多媒体文件)* 2、如果是视频,则返回视频的地址*/public String getVedio(String mediaId){String accessToken = accessTokenUtil.getAccessToken();if(accessToken != null) {String url = URIConstant.MEDIA_GET_URL.replace("ACCESS_TOKEN", accessToken).replace("MEDIA_ID", mediaId);log.info("MEDIA_GET_URL:{}", url);String responseString = restTemplate.getForObject(url,String.class);return responseString;}return null;}}
谢谢各位,我们下回继续再说!
