为了满足用户渠道推广分析的需要,公众平台提供了生成带参数二维码的接口。使用该接口可以获得多个带不同场景值的二维码,用户扫描后,公众号可以接收到事件推送。
目前有2种类型的二维码,分别是临时二维码和永久二维码,前者有过期时间,最大为1800秒,但能够生成较多数量,后者无过期时间,数量较少(目前参数只支持1--100000)。两种二维码分别适用于帐号绑定、用户来源统计等场景。
用户扫描带场景值二维码时,可能推送以下两种事件:
- 如果用户还未关注公众号,则用户可以关注公众号,关注后微信会将带场景值关注事件推送给开发者。
- 如果用户已经关注公众号,在用户扫描后会自动进入会话,微信也会将带场景值扫描事件推送给开发者。
获取带参数的二维码的过程包括两步,首先创建二维码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}}}
参数说明
参数 | 说明 |
---|---|
expire_seconds | 该二维码有效时间,以秒为单位。 最大不超过1800。 |
action_name | 二维码类型,QR_SCENE为临时,QR_LIMIT_SCENE为永久 |
action_info | 二维码详细信息 |
scene_id | 场景值ID,临时二维码时为32位非0整型,永久二维码时最大值为100000(目前参数只支持1--100000) |
返回说明
正确的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。
C#代码示例:
//生成二维码
public void CreateTicket()
{
string access_token="";
string strUrl = string.Format("https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token={0}", access_token);
string jsonData = "";
System.Web.Script.Serialization.JavaScriptSerializer ser = new System.Web.Script.Serialization.JavaScriptSerializer();
WeChat_Ticket_List ticketList = new WeChat_Ticket_List();
ticketList.action_name = "QR_LIMIT_SCENE";
WeChat_Ticket_ActionInfo action_info = new WeChat_Ticket_ActionInfo();
WeChat_Ticket_Scene scene = new WeChat_Ticket_Scene();
byte[] data = null;
HttpWebResponse response = null;
string responseContent = "";
long result = 0;
WECHAT_TICKET_BLL ticketBll = new WECHAT_TICKET_BLL();
WECHAT_TICKET_Entity model = new WECHAT_TICKET_Entity();
//生产参数为1-1000的二维码
for (int i =1; i <=1000; i++)
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(strUrl);
request.Method = "POST";
request.ContentType = "application/json";
Stream writer = null;
scene.scene_id = i + "";
action_info.scene = scene;
ticketList.action_info = action_info;
jsonData = ser.Serialize(ticketList);
data = Encoding.UTF8.GetBytes(jsonData.ToString());
writer = request.GetRequestStream();
writer.Write(data, 0, data.Length);
writer.Close();
response = (HttpWebResponse)request.GetResponse();
StreamReader reader = new StreamReader(response.GetResponseStream());
responseContent = reader.ReadToEnd();
WeChat_Ticket_Entity entity = ser.Deserialize<WeChat_Ticket_Entity>(responseContent);
if (entity != null)
{
//保存获取到的ticket信息
}
}
}
//获取二维码图片,保存到本地文件夹中
public void GetTicktPic()
{
string original_id = ConfigurationManager.AppSettings["ORIGINAL_ID"].ToString();
WECHAT_TICKET_BLL ticketBll = new WECHAT_TICKET_BLL();
DataSet ds = ticketBll.GetList(" order_id>=1 and order_id<=1000 ");
WECHAT_TICKET_Entity model = new WECHAT_TICKET_Entity();
string strUrl = null, responseContent = "", fileName = "", ticket = null,
urlTemplate = "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket={0}" ;
bool result = true;
WebClient c = new WebClient();
if (ds != null && ds.Tables.Count > 0)
{
DataTable dt = ds.Tables[0];
for (int i = 0; i < dt.Rows.Count; i++)
{
DataRow row = dt.Rows[i];
try
{
ticket = row["ticket"].ToString();
strUrl = string.Format(urlTemplate, ticket);
fileName = "";
fileName = "image/" + row["order_ID"].ToString() + ".jpg";
c.DownloadFile(strUrl, fileName);
WECHAT_TICKET_Entity ticketEntity = new WECHAT_TICKET_Entity();
ticketEntity.TICKET = ticket;
ticketEntity.ORIGINAL_ID = original_id;
ticketEntity.LAST_EDIT_BY = "GetTicktPic";
result = ticketBll.UpdateTicketInvalid(ticketEntity);
}
catch (Exception ex)
{
WECHAT_TICKET_Entity ticketEntity = new WECHAT_TICKET_Entity();
ticketEntity.TICKET = ticket;
ticketEntity.ORIGINAL_ID = original_id;
ticketEntity.LAST_EDIT_BY = "GetTicktPic";
result = ticketBll.UpdateTicketInvalid(ticketEntity);
c = new WebClient();
c.DownloadFile(strUrl, fileName);
}
}
}
}