最近公司在做微信开发,其实就是接口开发,网上找了很多资料,当然园友也写了很多教程,但都是理论说了一大堆,实用指导或代码很少。如果你自己仔细研究下,其实就那么点东西,C#实现起来也很简单,原本不想写这篇文章的,但是本人当时摸索走了很多弯路,这边总结下,希望初次接触微信公众平台的朋友别像当时的我一样。
自己动手,丰衣足食。
服务号和订阅号
服务号是公司申请的微信公共账号,订阅号是个人申请的,我个人也申请了一个,不过没怎么用。
服务号
- 1个月(30天)内仅可以发送1条群发消息。
- 发给订阅用户(粉丝)的消息,会显示在对方的聊天列表中。
- 在发送消息给用户时,用户将收到即时的消息提醒。
- 服务号会在订阅用户(粉丝)的通讯录中。
- 可申请自定义菜单。
订阅号
- 每天(24小时内)可以发送1条群发消息。
- 发给订阅用户(粉丝)的消息,将会显示在对方的订阅号文件夹中。
- 在发送消息给订阅用户(粉丝)时,订阅用户不会收到即时消息提醒。
- 在订阅用户(粉丝)的通讯录中,订阅号将被放入订阅号文件夹中。
- 订阅号不支持申请自定义菜单。
URL配置
启用开发模式需要先成为开发者,而且编辑模式和开发模式只能选择一个,进入微信公众平台-开发模式,如下:
需要填写url和token,当时本人填写这个的时候花了好久,我本以为填写个服务器的url就可以了(80端口),但是不行,主要是没有仔细的阅读提示信息,所以总是提示
从上面可以看出,点击提交后微信会向我们填写的服务器发送几个参数,然后需要原样返回出来,所以在提交url的时候,先在服务器创建接口测试返回echostr参数内容。代码:
- //成为开发者url测试,返回echoStr
- public void InterfaceTest()
- {
- string token = "填写的token";
- if (string.IsNullOrEmpty(token))
- {
- return;
- }
- string echoString = HttpContext.Current.Request.QueryString["echoStr"];
- string signature = HttpContext.Current.Request.QueryString["signature"];
- string timestamp = HttpContext.Current.Request.QueryString["timestamp"];
- string nonce = HttpContext.Current.Request.QueryString["nonce"];
- if (!string.IsNullOrEmpty(echoString))
- {
- HttpContext.Current.Response.Write(echoString);
- HttpContext.Current.Response.End();
- }
- }
在一般处理程序ashx的ProcessRequest的方法内调用上面的方法,url填写的就是这个ashx的服务器地址,token是一个服务器标示,可以随便输入,代码中的token要和申请填写的一致,成为开发者才能做开发。
#p#
创建菜单
我们添加一些微信服务号,聊天窗口下面有些菜单,这个可以在编辑模式简单配置,也可以在开发模式代码配置。微信公众平台开发者文档:http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口,可以看到创建菜单的一些要点,下面的使用网页调试工具调试该接口,只是调试接口是否可用,并不是直接创建菜单的,菜单分为两种:
- click: 用户点击click类型按钮后,微信服务器会通过消息接口推送消息类型为event 的结构给开发者(参考消息接口指南),并且带上按钮中开发者填写的key值,开发者可以通过自定义的key值与用户进行交互。
- view: 用户点击view类型按钮后,微信客户端将会打开开发者在按钮中填写的url值 (即网页链接),达到打开网页的目的,建议与网页授权获取用户基本信息接口结合,获得用户的登入个人信息。
click菜单需要填一个key,这个是在我们菜单点击事件的时候会用到,view只是一个菜单超链接。菜单数据是json格式,官网是php示例,其实C#实现起来也很简单,就是post发送一个json数据,示例代码:
- public partial class createMenu : System.Web.UI.Page
- {
- protected void Page_Load(object sender, EventArgs e)
- {
- FileStream fs1 = new FileStream(Server.MapPath(".")+"\\menu.txt", FileMode.Open);
- StreamReader sr = new StreamReader(fs1, Encoding.GetEncoding("GBK"));
- string menu = sr.ReadToEnd();
- sr.Close();
- fs1.Close();
- GetPage("https://api.weixin.qq.com/cgi-bin/menu/create?access_token=access_token", menu);
- }
- public string GetPage(string posturl, string postData)
- {
- Stream outstream = null;
- Stream instream = null;
- StreamReader sr = null;
- HttpWebResponse response = null;
- HttpWebRequest request = null;
- Encoding encoding = Encoding.UTF8;
- byte[] data = encoding.GetBytes(postData);
- // 准备请求...
- try
- {
- // 设置参数
- request = WebRequest.Create(posturl) as HttpWebRequest;
- CookieContainer cookieContainer = new CookieContainer();
- request.CookieContainer = cookieContainer;
- request.AllowAutoRedirect = true;
- request.Method = "POST";
- request.ContentType = "application/x-www-form-urlencoded";
- request.ContentLength = data.Length;
- outstream = request.GetRequestStream();
- outstream.Write(data, 0, data.Length);
- outstream.Close();
- //发送请求并获取相应回应数据
- response = request.GetResponse() as HttpWebResponse;
- //直到request.GetResponse()程序才开始向目标网页发送Post请求
- instream = response.GetResponseStream();
- sr = new StreamReader(instream, encoding);
- //返回结果网页(html)代码
- string content = sr.ReadToEnd();
- string err = string.Empty;
- Response.Write(content);
- return content;
- }
- catch (Exception ex)
- {
- string err = ex.Message;
- return string.Empty;
- }
- }
- }
menu.text里面的内容就是json示例菜单,大家可以从示例复制下来,按照你的需要修改一些就行了。
关于access_token,其实就是一个请求标示,获取方式:https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=appid&secret=secret;appid和secret是开发者标示,在你的信息里面可以看到,通过这个链接返回一个json数据,就可以得到access_token值。
需要注意的是:access_token有一定的时效性,失效的话就需要重新获取下,这个在本机就可以创建,不需要上传到服务器,创建菜单正确,返回{"errcode":0,"errmsg":"ok"}提示信息。这边就不截图了,大家试下就可以看到效果,一般创建菜单是一到两分钟生效,实在不行就重新关注下。
查询、删除菜单
查询和删除菜单也很简单,只不过是get请求,不需要传数据,看下示例代码:
- public partial class selectMenu : System.Web.UI.Page
- {
- protected void Page_Load(object sender, EventArgs e)
- {
- GetPage("https://api.weixin.qq.com/cgi-bin/menu/get?access_token=access_token");
- //GetPage("https://api.weixin.qq.com/cgi-bin/menu/delete?access_token=access_token");
- }
- public string GetPage(string posturl)
- {
- Stream instream = null;
- StreamReader sr = null;
- HttpWebResponse response = null;
- HttpWebRequest request = null;
- Encoding encoding = Encoding.UTF8;
- // 准备请求...
- try
- {
- // 设置参数
- request = WebRequest.Create(posturl) as HttpWebRequest;
- CookieContainer cookieContainer = new CookieContainer();
- request.CookieContainer = cookieContainer;
- request.AllowAutoRedirect = true;
- request.Method = "GET";
- request.ContentType = "application/x-www-form-urlencoded";
- //发送请求并获取相应回应数据
- response = request.GetResponse() as HttpWebResponse;
- //直到request.GetResponse()程序才开始向目标网页发送Post请求
- instream = response.GetResponseStream();
- sr = new StreamReader(instream, encoding);
- //返回结果网页(html)代码
- string content = sr.ReadToEnd();
- string err = string.Empty;
- Response.Write(content);
- return content;
- }
- catch (Exception ex)
- {
- string err = ex.Message;
- return string.Empty;
- }
- }
- }
access_token获取方式上面已经讲过了,查询菜单返回的是json数据,其实就是我们创建菜单的menu.txt里面的内容。
删除成功返回信息提示:{"errcode":0,"errmsg":"ok"},这个也只要在本地运行就可以了。
#p#
接受消息
微信公众平台开发者文档:http://mp.weixin.qq.com/wiki/index.php?title=接收普通消息,我们使用微信就是要对用户发送的信息进行处理,这边以接受普通消息为例,语音、图片消息等,举一反三可得。
从文档上可以看出接受消息获得的是一个xml格式文件,当时有点犯傻的是,我要在哪边进行接受消息啊?还郁闷了半天,其实就是你一开始填写的url,是不是很汗颜啊,哈哈。
- <xml>
- <ToUserName><![CDATA[toUser]]></ToUserName>
- <FromUserName><![CDATA[fromUser]]></FromUserName>
- <CreateTime>1348831860</CreateTime>
- <MsgType><![CDATA[text]]></MsgType>
- <Content><![CDATA[this is a test]]></Content>
- <MsgId>1234567890123456</MsgId>
- </xml>
我们在ashx添加下面代码:
- public void ProcessRequest(HttpContext param_context)
- {
- string postString = string.Empty;
- if (HttpContext.Current.Request.HttpMethod.ToUpper() == "POST")
- {
- using (Stream stream = HttpContext.Current.Request.InputStream)
- {
- Byte[] postBytes = new Byte[stream.Length];
- stream.Read(postBytes, 0, (Int32)stream.Length);
- postString = Encoding.UTF8.GetString(postBytes);
- Handle(postString);
- }
- }
- }
- /// <summary>
- /// 处理信息并应答
- /// </summary>
- private void Handle(string postStr)
- {
- messageHelp help = new messageHelp();
- string responseContent = help.ReturnMessage(postStr);
- HttpContext.Current.Response.ContentEncoding = Encoding.UTF8;
- HttpContext.Current.Response.Write(responseContent);
- }
messageHelp是消息处理帮助类,这边提供下部分代码,完整的可以下载来,获取的postString是xml,格式如上,我们这边只需要转换成XmlDocument进行解析就行了:
- //接受文本消息
- public string TextHandle(XmlDocument xmldoc)
- {
- string responseContent = "";
- XmlNode ToUserName = xmldoc.SelectSingleNode("/xml/ToUserName");
- XmlNode FromUserName = xmldoc.SelectSingleNode("/xml/FromUserName");
- XmlNode Content = xmldoc.SelectSingleNode("/xml/Content");
- if (Content != null)
- {
- responseContent = string.Format(ReplyType.Message_Text,
- FromUserName.InnerText,
- ToUserName.InnerText,
- DateTime.Now.Ticks,
- "欢迎使用微信公共账号,您输入的内容为:" + Content.InnerText+"\r\n<a href=\"http://www.cnblogs.com\">点击进入</a>");
- }
- return responseContent;
- }
- /// <summary>
- /// 普通文本消息
- /// </summary>
- public static string Message_Text
- {
- get { return @"<xml>
- <ToUserName><![CDATA[{0}]]></ToUserName>
- <FromUserName><![CDATA[{1}]]></FromUserName>
- <CreateTime>{2}</CreateTime>
- <MsgType><![CDATA[text]]></MsgType>
- <Content><![CDATA[{3}]]></Content>
- </xml>"; }
- }
上面的代码就是接受消息,并做一些处理操作,返回消息。
#p#
发送消息(图文、菜单事件响应)
这边发送消息我分为三种:普通消息、图文消息和菜单事件响应。普通消息其实上面说接受消息的时候讲到了,完整的代码下边下载来看。
我们先看下图文消息和菜单事件响应,微信公众平台开发者文档:http://mp.weixin.qq.com/wiki/index.php?title=回复图文消息#.E5.9B.9E.E5.A4.8D.E5.9B.BE.E6.96.87.E6.B6.88.E6.81.AF,xml格式为:
- <xml>
- <ToUserName><![CDATA[toUser]]></ToUserName>
- <FromUserName><![CDATA[fromUser]]></FromUserName>
- <CreateTime>12345678</CreateTime>
- <MsgType><![CDATA[news]]></MsgType>
- <ArticleCount>2</ArticleCount>
- <Articles>
- <item>
- <Title><![CDATA[title1]]></Title>
- <Description><![CDATA[description1]]></Description>
- <PicUrl><![CDATA[picurl]]></PicUrl>
- <Url><![CDATA[url]]></Url>
- </item>
- <item>
- <Title><![CDATA[title]]></Title>
- <Description><![CDATA[description]]></Description>
- <PicUrl><![CDATA[picurl]]></PicUrl>
- <Url><![CDATA[url]]></Url>
- </item>
- </Articles>
- </xml>
图文消息分为两种,我们先看下效果,找的圆通速递的微信服务号做示例:
刚开始做的时候,我以为这两种应该不是用的同一个接口,但是在文档中找了半天也没有找到除这个之外的,就试了下两个图文消息,发现就是这个接口发送的,如果多个的话,item中的Description会失效,只会显示Title,大家试下就知道了,示例代码:
- //事件
- public string EventHandle(XmlDocument xmldoc)
- {
- string responseContent = "";
- XmlNode Event = xmldoc.SelectSingleNode("/xml/Event");
- XmlNode EventKey = xmldoc.SelectSingleNode("/xml/EventKey");
- XmlNode ToUserName = xmldoc.SelectSingleNode("/xml/ToUserName");
- XmlNode FromUserName = xmldoc.SelectSingleNode("/xml/FromUserName");
- if (Event!=null)
- {
- //菜单单击事件
- if (Event.InnerText.Equals("CLICK"))
- {
- if (EventKey.InnerText.Equals("click_one"))//click_one
- {
- responseContent = string.Format(ReplyType.Message_Text,
- FromUserName.InnerText,
- ToUserName.InnerText,
- DateTime.Now.Ticks,
- "你点击的是click_one");
- }
- else if (EventKey.InnerText.Equals("click_two"))//click_two
- {
- responseContent = string.Format(ReplyType.Message_News_Main,
- FromUserName.InnerText,
- ToUserName.InnerText,
- DateTime.Now.Ticks,
- "2",
- string.Format(ReplyType.Message_News_Item,"我要寄件","",
- "http://www.soso.com/orderPlace.jpg",
- "http://www.soso.com/")+
- string.Format(ReplyType.Message_News_Item, "订单管理", "",
- "http://www.soso.com/orderManage.jpg",
- "http://www.soso.com/"));
- }
- else if (EventKey.InnerText.Equals("click_three"))//click_three
- {
- responseContent = string.Format(ReplyType.Message_News_Main,
- FromUserName.InnerText,
- ToUserName.InnerText,
- DateTime.Now.Ticks,
- "1",
- string.Format(ReplyType.Message_News_Item, "标题", "摘要",
- "http://www.soso.com/jieshao.jpg",
- "http://www.soso.com/"));
- }
- }
- }
- return responseContent;
- }
- /// <summary>
- /// 图文消息主体
- /// </summary>
- public static string Message_News_Main
- {
- get
- {
- return @"<xml>
- <ToUserName><![CDATA[{0}]]></ToUserName>
- <FromUserName><![CDATA[{1}]]></FromUserName>
- <CreateTime>{2}</CreateTime>
- <MsgType><![CDATA[news]]></MsgType>
- <ArticleCount>{3}</ArticleCount>
- <Articles>
- {4}
- </Articles>
- </xml> ";
- }
- }
- /// <summary>
- /// 图文消息项
- /// </summary>
- public static string Message_News_Item
- {
- get
- {
- return @"<item>
- <Title><![CDATA[{0}]]></Title>
- <Description><![CDATA[{1}]]></Description>
- <PicUrl><![CDATA[{2}]]></PicUrl>
- <Url><![CDATA[{3}]]></Url>
- </item>";
- }
- }
需要注意的是:XmlNode Event = xmldoc.SelectSingleNode("/xml/Event")表示获取的是事件类型,XmlNode EventKey = xmldoc.SelectSingleNode("/xml/EventKey")表示事件标示,就是我们创建菜单添加click的key,通过key我们就可以判断出是点的哪个菜单。
还有一点是回复超链接,有时候在服务号会发送一些链接,我们打开直接就会链接到相关网址,只需要在回复内容中添加:<a href="http://www.baidu.com">点击进入</a>,就可以了。
示例Demo下载
下载地址:http://pan.baidu.com/s/1i3kMpwh
后记
关于微信公众平台当然还有许多其他的东西,本篇只是一些经验之谈,希望可以起到抛砖引玉的作用。有时候我们发现一些新鲜事物,觉得很难,就远远的看着,如果你用心的去感受它,其实也就这么回事。