爲了滿足用戶渠道推廣分析和用戶帳號綁定等場景的需要,公衆平臺提供了生成帶參數二維碼的接口。使用該接口可以獲得多個帶不同場景值的二維碼,用戶掃描後,公衆號可以接收到事件推送。
目前有2種類型的二維碼:
1、臨時二維碼,是有過期時間的,最長可以設置爲在二維碼生成後的30天(即2592000秒)後過期,但能夠生成較多數量。臨時二維碼主要用於帳號綁定等不要求二維碼永久保存的業務場景
2、永久二維碼,是無過期時間的,但數量較少(目前爲最多10萬個)。永久二維碼主要用於適用於帳號綁定、用戶來源統計等場景。
用戶掃描帶場景值二維碼時,可能推送以下兩種事件:
如果用戶還未關注公衆號,則用戶可以關注公衆號,關注後微信會將帶場景值關注事件推送給開發者。
如果用戶已經關注公衆號,在用戶掃描後會自動進入會話,微信也會將帶場景值掃描事件推送給開發者。
獲取帶參數的二維碼的過程包括兩步,首先創建二維碼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": 604800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123}}}
或者也可以使用以下POST數據創建字符串形式的二維碼參數:{"expire_seconds": 604800, "action_name": "QR_STR_SCENE", "action_info": {"scene": {"scene_str": "test"}}}
永久二維碼請求說明
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": "test"}}}
參數說明
參數 | 說明 |
---|---|
expire_seconds | 該二維碼有效時間,以秒爲單位。 最大不超過2592000(即30天),此字段如果不填,則默認有效期爲30秒。 |
action_name | 二維碼類型,QR_SCENE爲臨時的整型參數值,QR_STR_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":"gQH47joAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL2taZ2Z3TVRtNzJXV1Brb3ZhYmJJAAIEZ23sUwMEmm
3sUw==","expire_seconds":60,"url":"http://weixin.qq.com/q/kZgfwMTm72WWPkovabbI"}
參數 | 說明 |
---|---|
ticket | 獲取的二維碼ticket,憑藉此ticket可以在有效時間內換取二維碼。 |
expire_seconds | 該二維碼有效時間,以秒爲單位。 最大不超過2592000(即30天)。 |
url | 二維碼圖片解析後的地址,開發者可根據該地址自行生成需要的二維碼圖片 |
通過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。