為了滿足用戶渠道推廣分析的需要,公眾平台提供了生成帶二維碼的接口。使用該接口可以獲得多個帶不同場景值的二維碼,用戶掃描后,公眾號可以接收到事件推送。目前有兩種類型的二維碼,分別是臨時二維碼和永久二維碼,前者有過期時間,最大為1800秒,但能夠生成較多數量,后者無過期時間,數量較少(目前參數只支持1到100000)。兩種二維碼分別適用於賬號綁定、用戶來源統計等場景。
用戶掃描帶場景值二維碼時,可能推送以下兩種事件:
1. 如果用戶還未關注公眾號,則用戶可以關注公眾號,關注后微信會將帶場景值關注事件推送給開發者(例如為特定活動准備的二維碼,與會者掃描后關注微信賬號,與此同時微信賬號可以將活動相關的信息推送給用戶);
2. 如果用戶已經關注公眾號,在用戶掃描后會自動進入會話,微信也會將帶場景值掃描事件推送給開發者(上例同樣適用)。
獲取帶參數的二維碼的過程包括兩步,首先創建二維碼ticket,然后憑借ticket到指定URL換取二維碼。
創建二維碼ticket
每次創建二維碼ticket需要提供一個開發者自行設定的參數(scene_id),分別介紹臨時二維碼和永久二維碼的創建二維碼ticket過程。
臨時二維碼請求說明:
1 http請求方式: POST 2 URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN 3 POST數據格式:json 4 POST數據例子:{"expire_seconds": 1800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123}}}
永久二維碼請求說明
1 http請求方式: POST 2 URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN 3 POST數據格式:json 4 POST數據例子:{"action_name": "QR_LIMIT_SCENE", "action_info": {"scene": {"scene_id": 123}}}
請求JSON數據參數的具體說明如下:
正確的Json返回結果示例如下:
1 {"ticket":"gQH47joAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2taZ2Z3TVRtNzJXV1Brb3ZhYmJJAAIEZ23sUwMEmm3sUw==","expire_seconds":60,"url":"http:\/\/weixin.qq.com\/q\/kZgfwMTm72WWPkovabbI"}
返回Json數據的格式說明如下:
錯誤的Json返回示例如下:
1 {"errcode":40013,"errmsg":"invalid appid"}
下面我們構造一個Visualforce Page來生成ticket。
Visualforce Page代碼如下:
1 <apex:page standardstylesheets="false" showHeader="false" sidebar="false" controller="WeChatQRCodeGeneratorController" > 2 <apex:form > 3 <font face="微軟雅黑"><strong>第一步,創建二維碼Ticket</strong><br /><br /> 4 請輸入授權AccessToken:<apex:inputText size="100" value="{!accessToken}" id="accessToken"/><br /><br /> 5 <apex:commandButton value="生成創建二維碼Ticket" action="{!send}" id="send" /><br /> 6 </font> 7 </apex:form> 8 {!msg} 9 </apex:page>
上面代碼第4行放置了一個apex:inputText控件,相當於HTML的文本框,value的值指定了accessToken,這個必須是WeChatQRCodeGeneratorController類里一個有Getter Setter的公開屬性,如過該屬性有默認值則文本框會顯示這個默認值,如果用戶修改了文本框的內容,accessToken屬性的值也會自動改變。第5行放置了一個apex:commandButton控件,相當於HTML的按鈕,點擊這個按鈕將觸發action處指定的方法send。最后第8行直接顯示msg變量,該變量會用來顯示微信接口返回的Json。畫面顯示效果如下:
WeChatQRCodeGeneratorController類的代碼如下:
1 public class WeChatQRCodeGeneratorController { 2 public String msg { get; set; } 3 public String accessToken { get; set; } 4 public void send() { 5 Http h = new Http(); 6 HttpRequest req = new HttpRequest(); 7 req.setMethod('POST'); 8 req.setHeader('Accept-Encoding','gzip,deflate'); 9 req.setHeader('Content-Type','text/xml;charset=UTF-8'); 10 req.setHeader('User-Agent','Jakarta Commons-HttpClient/3.1'); 11 12 String json = '{"expire_seconds": 1800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 12345}}}'; 13 14 req.setBody(json); 15 req.setEndpoint('https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=' + accessToken); 16 String bodyRes = ''; 17 18 try{ 19 HttpResponse res = h.send(req); 20 bodyRes = res.getBody(); 21 } 22 catch(System.CalloutException e) { 23 System.debug('Callout error: '+ e); 24 ApexPages.addMessage(new ApexPages.Message(ApexPages.Severity.FATAL, e.getMessage())); 25 } 26 msg = bodyRes; 27 } 28 }
完成后保存代碼,輸入正確有效的Access Token,點擊“生成創建二維碼Ticket”按鈕將會得到如下圖所示的用來換取二維碼的票據。其實返回的json里最后一個參數url的值即是二維碼的值,可以拿這個結果通過在線二維碼生成器生成二維碼:
通過ticket換取二維碼
獲取二維碼ticket后,開發者可用ticket換取二維碼圖片,本接口無需登錄即可調用,接口請求說明如下:
1 HTTP GET請求(請使用https協議) 2 https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=TICKET
返回說明:
ticket正確情況下,http 返回碼是200,是一張圖片,可以直接展示或者下載。
1 HTTP頭(示例)如下: 2 Accept-Ranges:bytes 3 Cache-control:max-age=604800 4 Connection:keep-alive 5 Content-Length:28026 6 Content-Type:image/jpg 7 Date:Wed, 16 Oct 2013 06:37:10 GMT 8 Expires:Wed, 23 Oct 2013 14:37:10 +0800 9 Server:nginx/1.4.1
錯誤情況下(如ticket非法)返回HTTP錯誤碼404。
利用前面返回的票據調用該接口示例如下:
1 https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQH97zoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2YweHpqY1hrX255RGdnckl0V0otAAIENIwAVAMECAcAAA==
直接在瀏覽器訪問該接口將返回如下圖所示的二維碼圖片,掃描該二維碼圖片將直接關注相應公眾賬號: