C#開發(fā)微信公眾平臺(tái)-就這么簡(jiǎn)單(附Demo)
最近公司在做微信開發(fā),其實(shí)就是接口開發(fā),網(wǎng)上找了很多資料,當(dāng)然園友也寫了很多教程,但都是理論說了一大堆,實(shí)用指導(dǎo)或代碼很少。如果你自己仔細(xì)研究下,其實(shí)就那么點(diǎn)東西,C#實(shí)現(xiàn)起來也很簡(jiǎn)單,原本不想寫這篇文章的,但是本人當(dāng)時(shí)摸索走了很多彎路,這邊總結(jié)下,希望初次接觸微信公眾平臺(tái)的朋友別像當(dāng)時(shí)的我一樣。
自己動(dòng)手,豐衣足食。
服務(wù)號(hào)和訂閱號(hào)
服務(wù)號(hào)是公司申請(qǐng)的微信公共賬號(hào),訂閱號(hào)是個(gè)人申請(qǐng)的,我個(gè)人也申請(qǐng)了一個(gè),不過沒怎么用。
服務(wù)號(hào)
- 1個(gè)月(30天)內(nèi)僅可以發(fā)送1條群發(fā)消息。
- 發(fā)給訂閱用戶(粉絲)的消息,會(huì)顯示在對(duì)方的聊天列表中。
- 在發(fā)送消息給用戶時(shí),用戶將收到即時(shí)的消息提醒。
- 服務(wù)號(hào)會(huì)在訂閱用戶(粉絲)的通訊錄中。
- 可申請(qǐng)自定義菜單。
訂閱號(hào)
- 每天(24小時(shí)內(nèi))可以發(fā)送1條群發(fā)消息。
- 發(fā)給訂閱用戶(粉絲)的消息,將會(huì)顯示在對(duì)方的訂閱號(hào)文件夾中。
- 在發(fā)送消息給訂閱用戶(粉絲)時(shí),訂閱用戶不會(huì)收到即時(shí)消息提醒。
- 在訂閱用戶(粉絲)的通訊錄中,訂閱號(hào)將被放入訂閱號(hào)文件夾中。
- 訂閱號(hào)不支持申請(qǐng)自定義菜單。
URL配置
啟用開發(fā)模式需要先成為開發(fā)者,而且編輯模式和開發(fā)模式只能選擇一個(gè),進(jìn)入微信公眾平臺(tái)-開發(fā)模式,如下:
需要填寫url和token,當(dāng)時(shí)本人填寫這個(gè)的時(shí)候花了好久,我本以為填寫個(gè)服務(wù)器的url就可以了(80端口),但是不行,主要是沒有仔細(xì)的閱讀提示信息,所以總是提示
從上面可以看出,點(diǎn)擊提交后微信會(huì)向我們填寫的服務(wù)器發(fā)送幾個(gè)參數(shù),然后需要原樣返回出來,所以在提交url的時(shí)候,先在服務(wù)器創(chuàng)建接口測(cè)試返回echostr參數(shù)內(nèi)容。代碼:
- //成為開發(fā)者url測(cè)試,返回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的方法內(nèi)調(diào)用上面的方法,url填寫的就是這個(gè)ashx的服務(wù)器地址,token是一個(gè)服務(wù)器標(biāo)示,可以隨便輸入,代碼中的token要和申請(qǐng)?zhí)顚懙囊恢?,成為開發(fā)者才能做開發(fā)。
#p#
創(chuàng)建菜單
我們添加一些微信服務(wù)號(hào),聊天窗口下面有些菜單,這個(gè)可以在編輯模式簡(jiǎn)單配置,也可以在開發(fā)模式代碼配置。微信公眾平臺(tái)開發(fā)者文檔:http://mp.weixin.qq.com/wiki/index.php?title=自定義菜單創(chuàng)建接口,可以看到創(chuàng)建菜單的一些要點(diǎn),下面的使用網(wǎng)頁調(diào)試工具調(diào)試該接口,只是調(diào)試接口是否可用,并不是直接創(chuàng)建菜單的,菜單分為兩種:
- click: 用戶點(diǎn)擊click類型按鈕后,微信服務(wù)器會(huì)通過消息接口推送消息類型為event 的結(jié)構(gòu)給開發(fā)者(參考消息接口指南),并且?guī)习粹o中開發(fā)者填寫的key值,開發(fā)者可以通過自定義的key值與用戶進(jìn)行交互。
- view: 用戶點(diǎn)擊view類型按鈕后,微信客戶端將會(huì)打開開發(fā)者在按鈕中填寫的url值 (即網(wǎng)頁鏈接),達(dá)到打開網(wǎng)頁的目的,建議與網(wǎng)頁授權(quán)獲取用戶基本信息接口結(jié)合,獲得用戶的登入個(gè)人信息。
click菜單需要填一個(gè)key,這個(gè)是在我們菜單點(diǎn)擊事件的時(shí)候會(huì)用到,view只是一個(gè)菜單超鏈接。菜單數(shù)據(jù)是json格式,官網(wǎng)是php示例,其實(shí)C#實(shí)現(xiàn)起來也很簡(jiǎn)單,就是post發(fā)送一個(gè)json數(shù)據(jù),示例代碼:
- 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);
- // 準(zhǔn)備請(qǐng)求...
- try
- {
- // 設(shè)置參數(shù)
- 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();
- //發(fā)送請(qǐng)求并獲取相應(yīng)回應(yīng)數(shù)據(jù)
- response = request.GetResponse() as HttpWebResponse;
- //直到request.GetResponse()程序才開始向目標(biāo)網(wǎng)頁發(fā)送Post請(qǐng)求
- instream = response.GetResponseStream();
- sr = new StreamReader(instream, encoding);
- //返回結(jié)果網(wǎng)頁(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里面的內(nèi)容就是json示例菜單,大家可以從示例復(fù)制下來,按照你的需要修改一些就行了。
關(guān)于access_token,其實(shí)就是一個(gè)請(qǐng)求標(biāo)示,獲取方式:https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=appid&secret=secret;appid和secret是開發(fā)者標(biāo)示,在你的信息里面可以看到,通過這個(gè)鏈接返回一個(gè)json數(shù)據(jù),就可以得到access_token值。
需要注意的是:access_token有一定的時(shí)效性,失效的話就需要重新獲取下,這個(gè)在本機(jī)就可以創(chuàng)建,不需要上傳到服務(wù)器,創(chuàng)建菜單正確,返回{"errcode":0,"errmsg":"ok"}提示信息。這邊就不截圖了,大家試下就可以看到效果,一般創(chuàng)建菜單是一到兩分鐘生效,實(shí)在不行就重新關(guān)注下。
查詢、刪除菜單
查詢和刪除菜單也很簡(jiǎn)單,只不過是get請(qǐng)求,不需要傳數(shù)據(jù),看下示例代碼:
- 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;
- // 準(zhǔn)備請(qǐng)求...
- try
- {
- // 設(shè)置參數(shù)
- 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";
- //發(fā)送請(qǐng)求并獲取相應(yīng)回應(yīng)數(shù)據(jù)
- response = request.GetResponse() as HttpWebResponse;
- //直到request.GetResponse()程序才開始向目標(biāo)網(wǎng)頁發(fā)送Post請(qǐng)求
- instream = response.GetResponseStream();
- sr = new StreamReader(instream, encoding);
- //返回結(jié)果網(wǎng)頁(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獲取方式上面已經(jīng)講過了,查詢菜單返回的是json數(shù)據(jù),其實(shí)就是我們創(chuàng)建菜單的menu.txt里面的內(nèi)容。
刪除成功返回信息提示:{"errcode":0,"errmsg":"ok"},這個(gè)也只要在本地運(yùn)行就可以了。
#p#
接受消息
微信公眾平臺(tái)開發(fā)者文檔:http://mp.weixin.qq.com/wiki/index.php?title=接收普通消息,我們使用微信就是要對(duì)用戶發(fā)送的信息進(jìn)行處理,這邊以接受普通消息為例,語音、圖片消息等,舉一反三可得。
從文檔上可以看出接受消息獲得的是一個(gè)xml格式文件,當(dāng)時(shí)有點(diǎn)犯傻的是,我要在哪邊進(jìn)行接受消息???還郁悶了半天,其實(shí)就是你一開始填寫的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>
我們?cè)赼shx添加下面代碼:
- 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>
- /// 處理信息并應(yīng)答
- /// </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,格式如上,我們這邊只需要轉(zhuǎn)換成XmlDocument進(jìn)行解析就行了:
- //接受文本消息
- 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,
- "歡迎使用微信公共賬號(hào),您輸入的內(nèi)容為:" + Content.InnerText+"\r\n<a href=\"http://www.cnblogs.com\">點(diǎn)擊進(jìn)入</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#
發(fā)送消息(圖文、菜單事件響應(yīng))
這邊發(fā)送消息我分為三種:普通消息、圖文消息和菜單事件響應(yīng)。普通消息其實(shí)上面說接受消息的時(shí)候講到了,完整的代碼下邊下載來看。
我們先看下圖文消息和菜單事件響應(yīng),微信公眾平臺(tái)開發(fā)者文檔:http://mp.weixin.qq.com/wiki/index.php?title=回復(fù)圖文消息#.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>
圖文消息分為兩種,我們先看下效果,找的圓通速遞的微信服務(wù)號(hào)做示例:
剛開始做的時(shí)候,我以為這兩種應(yīng)該不是用的同一個(gè)接口,但是在文檔中找了半天也沒有找到除這個(gè)之外的,就試了下兩個(gè)圖文消息,發(fā)現(xiàn)就是這個(gè)接口發(fā)送的,如果多個(gè)的話,item中的Description會(huì)失效,只會(huì)顯示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,
- "你點(diǎn)擊的是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, "標(biāo)題", "摘要",
- "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>
- /// 圖文消息項(xiàng)
- /// </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")表示事件標(biāo)示,就是我們創(chuàng)建菜單添加click的key,通過key我們就可以判斷出是點(diǎn)的哪個(gè)菜單。
還有一點(diǎn)是回復(fù)超鏈接,有時(shí)候在服務(wù)號(hào)會(huì)發(fā)送一些鏈接,我們打開直接就會(huì)鏈接到相關(guān)網(wǎng)址,只需要在回復(fù)內(nèi)容中添加:<a href="http://www.baidu.com">點(diǎn)擊進(jìn)入</a>,就可以了。
示例Demo下載
下載地址:http://pan.baidu.com/s/1i3kMpwh
后記
關(guān)于微信公眾平臺(tái)當(dāng)然還有許多其他的東西,本篇只是一些經(jīng)驗(yàn)之談,希望可以起到拋磚引玉的作用。有時(shí)候我們發(fā)現(xiàn)一些新鮮事物,覺得很難,就遠(yuǎn)遠(yuǎn)的看著,如果你用心的去感受它,其實(shí)也就這么回事。