您的位置: 首页  >  文章  >  生成带参数的二维码接口实例

生成带参数的二维码接口实例

分类: 文章 • 2024-09-20 20:52:16

1.生成带参数的二维码接口介绍

为了满足用户渠道推广分析的需要，公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码，用户扫描后，公众号可以接收到事件推送。

目前有2种类型的二维码，分别是临时二维码和永久二维码，前者有过期时间，最大为1800秒，但能够生成较多数量，后者无过期时间，数量较少（目前参数只支持1--100000）。两种二维码分别适用于帐号绑定、用户来源统计等场景。

用户扫描带场景值二维码时，可能推送以下两种事件：

  1. 如果用户还未关注公众号，则用户可以关注公众号，关注后微信会将带场景值关注事件推送给开发者。
  2. 如果用户已经关注公众号，在用户扫描后会自动进入会话，微信也会将带场景值扫描事件推送给开发者。

获取带参数的二维码的过程包括两步，首先创建二维码ticket，然后凭借ticket到指定URL换取二维码。

创建二维码ticket

每次创建二维码ticket需要提供一个开发者自行设定的参数（scene_id），分别介绍临时二维码和永久二维码的创建二维码ticket过程。

临时二维码请求说明

http请求方式: POST
URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
POST数据格式：json
POST数据例子：{"expire_seconds": 1800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123}}}

永久二维码请求说明

http请求方式: POST
URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
POST数据格式：json
POST数据例子：{"action_name": "QR_LIMIT_SCENE", "action_info": {"scene": {"scene_id": 123}}}
或者也可以使用以下POST数据创建字符串形式的二维码参数：
{"action_name": "QR_LIMIT_STR_SCENE", "action_info": {"scene": {"scene_str": "123"}}}

参数说明

参数 说明
expire_seconds 该二维码有效时间，以秒为单位。 最大不超过1800。
action_name 二维码类型，QR_SCENE为临时,QR_LIMIT_SCENE为永久,QR_LIMIT_STR_SCENE为永久的字符串参数值
action_info 二维码详细信息
scene_id 场景值ID，临时二维码时为32位非0整型，永久二维码时最大值为100000（目前参数只支持1--100000）
scene_str 场景值ID（字符串形式的ID），字符串类型，长度限制为1到64，仅永久二维码支持此字段

返回说明

正确的Json返回结果:

{"ticket":"gQH47joAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2taZ2Z3TVRtNzJXV1Brb3ZhYmJJAAIEZ23sUwMEmm3sUw==","expire_seconds":60,"url":"http:\/\/weixin.qq.com\/q\/kZgfwMTm72WWPkovabbI"}
参数 说明
ticket 获取的二维码ticket，凭借此ticket可以在有效时间内换取二维码。
expire_seconds 二维码的有效时间，以秒为单位。最大不超过1800。
url 二维码图片解析后的地址，开发者可根据该地址自行生成需要的二维码图片

错误的Json返回示例:

{"errcode":40013,"errmsg":"invalid appid"}

全局返回码说明

使用网页调试工具调试该接口

通过ticket换取二维码

获取二维码ticket后，开发者可用ticket换取二维码图片。请注意，本接口无须登录态即可调用。

请求说明

HTTP GET请求（请使用https协议）
https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=TICKET
提醒：TICKET记得进行UrlEncode

返回说明

ticket正确情况下，http 返回码是200，是一张图片，可以直接展示或者下载。

HTTP头（示例）如下：
Accept-Ranges:bytes
Cache-control:max-age=604800
Connection:keep-alive
Content-Length:28026
Content-Type:image/jpg
Date:Wed, 16 Oct 2013 06:37:10 GMT
Expires:Wed, 23 Oct 2013 14:37:10 +0800
Server:nginx/1.4.1

错误情况下（如ticket非法）返回HTTP错误码404

扫描带参数二维码事件

用户扫描带场景值二维码时，可能推送以下两种事件：

  1. 如果用户还未关注公众号，则用户可以关注公众号，关注后微信会将带场景值关注事件推送给开发者。
  2. 如果用户已经关注公众号，则微信会将带场景值扫描事件推送给开发者。

1. 用户未关注时，进行关注后的事件推送

推送XML数据包示例：

<xml><ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[FromUser]]></FromUserName>
<CreateTime>123456789</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[subscribe]]></Event>
<EventKey><![CDATA[qrscene_123123]]></EventKey>
<Ticket><![CDATA[TICKET]]></Ticket>
</xml>

参数说明：

参数 描述
ToUserName 开发者微信号
FromUserName 发送方帐号（一个OpenID）
CreateTime 消息创建时间 （整型）
MsgType 消息类型，event
Event 事件类型，subscribe
EventKey 事件KEY值，qrscene_为前缀，后面为二维码的参数值
Ticket 二维码的ticket，可用来换取二维码图片

2. 用户已关注时的事件推送

推送XML数据包示例：

<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[FromUser]]></FromUserName>
<CreateTime>123456789</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[SCAN]]></Event>
<EventKey><![CDATA[SCENE_VALUE]]></EventKey>
<Ticket><![CDATA[TICKET]]></Ticket>
</xml>

参数说明：

参数 描述
ToUserName 开发者微信号
FromUserName 发送方帐号（一个OpenID）
CreateTime 消息创建时间 （整型）
MsgType 消息类型，event
Event 事件类型，SCAN
EventKey 事件KEY值，是一个32位无符号整数，即创建二维码时的二维码scene_id
Ticket 二维码的ticket，可用来换取二维码图片

2.公众号设置

设置url服务器为微信推送的地址
生成带参数的二维码接口实例

3.代码实现

3.1微信推送





[java] view plain copy
  1. @Controller  
  2. @RequestMapping("/weixin/callback")  
  3. public class WeiXinCallBackAttentionController {  
  4.       
  5.     /** 
  6.      * 微信验证回调 
  7.      * @param request 
  8.      * @param response 
  9.      *  
  10.      *  
  11.      * <xml><ToUserName><![CDATA[gh_2a5540516edb]]></ToUserName> 
  12.         <FromUserName><![CDATA[odwP2jt6aTBu_Dl1ypoUJ8pN9UOs]]></FromUserName> 
  13.         <CreateTime>1425633941</CreateTime> 
  14.         <MsgType><![CDATA[event]]></MsgType> 
  15.         <Event><![CDATA[SCAN]]></Event> 
  16.         <EventKey><![CDATA[0]]></EventKey> 
  17.         <Ticket><![CDATA[gQGK8DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2RIVlBsRVBsdEhITk9jQzRaMXV6AAIEgXL5VAMECAcAAA==]]></Ticket> 
  18.         </xml> 
  19.      */  
  20.     @RequestMapping(value="/init",method={RequestMethod.GET,RequestMethod.POST} )  
  21.     public void init(@RequestBody(required=false) String body,HttpServletRequest request,HttpServletResponse response){  
  22.           
  23.         System.out.println(body.toString());  
  24.         System.out.println("================================微信URL回调测试=========================");  
  25.         SAXReader saxReader = new SAXReader();  
  26.         Document document;  
  27.         try {  
  28.             try {  
  29.                 document = saxReader.read(new ByteArrayInputStream(body.toString().getBytes("UTF-8")));  
  30.                 Element rootElt = document.getRootElement();  
  31.                 System.out.println("FromUserName==="+rootElt.elementText("FromUserName"));  
  32.             } catch (UnsupportedEncodingException e) {  
  33.                 // TODO Auto-generated catch block  
  34.                 e.printStackTrace();  
  35.             }  
  36.               
  37.         } catch (DocumentException e) {  
  38.             // TODO Auto-generated catch block  
  39.             e.printStackTrace();  
  40.         }  
  41.     /*   
  42.      * 微信回调验证 
  43.      *  
  44.      * String signature = request.getParameter("signature"); 
  45.         String timestamp = request.getParameter("timestamp"); 
  46.         String nonce = request.getParameter("nonce"); 
  47.         String echostr = request.getParameter("echostr"); 
  48.          
  49.         String token = "dmx"; 
  50.          
  51.         PrintWriter out; 
  52.         try { 
  53.             out = response.getWriter(); 
  54.             out.println(echostr); 
  55.             out.close(); 
  56.             response.flushBuffer(); 
  57.         } catch (IOException e) { 
  58.             // TODO Auto-generated catch block 
  59.             e.printStackTrace(); 
  60.         }*/  
  61.           
  62.           
  63. }  
  64.           
  65. }  




3.2微信生成带参数的临时二维码，用于扫码关注公众账号

[java] view plain copy
  1. @Controller  
  2. @RequestMapping("/attention")  
  3. public class WeiXinAttentionController {  
  4.       
  5.       
  6.   
  7.   
  8.     @RequestMapping(value = "/weixinAttention", method = RequestMethod.POST)  
  9.     @ResponseBody  
  10.     public Object init(@RequestBody String body, HttpServletRequest request,HttpServletResponse response) {  
  11.         try{  
  12.               
  13.             KeyStore keyStore = KeyStore.getInstance("PKCS12");  
  14.             FileInputStream instream = new FileInputStream(new File(  
  15.                     CustomizedPropertyPlaceholderConfigurer.getContextProperty("wx.cert").toString()));  
  16.             try {  
  17.                 keyStore.load(instream, "见邮件".toCharArray());  
  18.             }finally {  
  19.                 instream.close();  
  20.             }  
  21.   
  22.             // Trust own CA and all self-signed certs  
  23.             SSLContext sslcontext = SSLContexts.custom().loadKeyMaterial(keyStore,  
  24.                     "<span style="font-family: Arial, Helvetica, sans-serif;">见邮件</span><span style="font-family: Arial, Helvetica, sans-serif;">".toCharArray()).build();</span>  
  25.             // Allow TLSv1 protocol only  
  26.             SSLConnectionSocketFactory sslsf = new SSLConnectionSocketFactory(  
  27.                     sslcontext, new String[] { "TLSv1" }, null,  
  28.                     SSLConnectionSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);  
  29.             CloseableHttpClient httpclient = HttpClients.custom()  
  30.                     .setSSLSocketFactory(sslsf).build();  
  31.             // HttpGet httpget = new  
  32.             // HttpGet("https://api.mch.weixin.qq.com/secapi/pay/refund");  
  33.             JSONObject bodyXml = JSONObject.fromObject(body);  
  34.             HttpPost httppost = new HttpPost("https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token="+bodyXml.get("accessToken"));  
  35.               
  36.             Map<String,Map<String,Integer>> sceneMap = new HashMap<String,Map<String,Integer>>();  
  37.             Map<String,Integer> sceneIdMap = new HashMap<String, Integer>();  
  38.             sceneIdMap.put("scene_id", (Integer) bodyXml.get("sceneId"));  
  39.             sceneMap.put("scene", sceneIdMap);  
  40.               
  41.             JSONObject attentionXml = new JSONObject();  
  42.             attentionXml.put("expire_seconds", Integer.valueOf(bodyXml.get("expireSeconds").toString()));  
  43.             attentionXml.put("action_name", weixinActionName.ACTION_NAME_TEMPORARY);  
  44.             attentionXml.put("action_info", sceneMap);  
  45.             System.out.println("atten====="+attentionXml.toString());  
  46.             try {  
  47.   
  48.                 StringEntity se = new StringEntity(attentionXml.toString());  
  49.                   
  50.                 httppost.setEntity(se);  
  51.   
  52.                 System.out.println("executing request" + httppost.getRequestLine());  
  53.   
  54.                 CloseableHttpResponse responseEntry = httpclient.execute(httppost);  
  55.                 try {  
  56.                     HttpEntity entity = responseEntry.getEntity();  
  57.   
  58.                     System.out.println("----------------------------------------");  
  59.                     System.out.println(responseEntry.getStatusLine());  
  60.                     if (entity != null) {  
  61.                         System.out.println("Response content length: "  
  62.                                 + entity.getContentLength());  
  63.                         JSONObject result = null ;  
  64.                         System.out.println("Response content length: "  
  65.                                 + entity.getContentLength());  
  66.                     BufferedReader bufferedReader = new BufferedReader(  
  67.                                 new InputStreamReader(entity.getContent()));  
  68.                         String text;  
  69.                         while ((text = bufferedReader.readLine()) != null) {  
  70.                             System.out.println("text======="+text);  
  71.                             result = JSONObject.fromObject(text);  
  72.                         }  
  73. //此url位生成临时二维码url,扫码后可进行公众账号关注  
  74.                         String resultUrl = result.getString("url");  
  75. //                      JSONObject result = new JSONObject();  
  76.                         if(!StringUtils.isEmpty(resultUrl)){  
  77.                             result.put("attentionUrl", resultUrl);  
  78.                             result.put("expireSeconds", result.getString("expire_seconds"));  
  79.                         }else{  
  80.                             result.put("status", "error");  
  81.                             result.put("errcode", result.getString("errcode"));  
  82.                             result.put("errmsg", result.getString("errmsg"));  
  83.                         }  
  84.                           
  85.                         return result;  
  86.   
  87.                     }  
  88.                     EntityUtils.consume(entity);  
  89.                 }  
  90.                 finally {  
  91.                     responseEntry.close();  
  92.                 }  
  93.             }  
  94.             finally {  
  95.                 httpclient.close();  
  96.             }  
  97.             return null;          
  98.         }catch(Exception e){  
  99.             e.printStackTrace();  
  100.             JSONObject result = new JSONObject();  
  101.             result.put("status","error");  
  102.             result.put("msg",e.getMessage());  
  103.             return result;  
  104.         }  
  105.     }  
  106. } 

相关推荐