作者:王先榮
本文介紹微信公眾號中的範本訊息,包含以下內容:(1)TemplateMessage類別簡介;(2)設定所屬產業;(3)取得範本id; (4)發送範本訊息;(5)接收推播範本訊息發送結果事件。
1 TemplateMessage類別簡介
TemplateMessage靜態類別封裝了與範本訊息相關的方法,請參閱下表:
#方法名稱 | 功能 |
SetIndustry | 設定產業 |
GetId | #取得範本id |
Send | 傳送範本訊息 |
2 設定所屬產業
TemplateMessage類別的SetIndustry方法用於設定公眾號所屬的產業,此方法的定義如下:
/// <summary> /// 设置行业 /// </summary> /// <param name="userName">公众号</param> /// <param name="code1">行业代码1</param> /// <param name="code2">行业代码2</param> /// <returns>返回设置是否成功</returns> public static ErrorMessage SetIndustry(string userName, string code1, string code2) //或者 /// <summary> /// 设置行业 /// </summary> /// <param name="userName">公众号</param> /// <param name="industry1">行业1</param> /// <param name="industry2">行业2</param> /// <returns>返回设置是否成功</returns> public static ErrorMessage SetIndustry(string userName, Industry industry1, Industry industry2)
其中,Industry為行業類,類中的靜態成員包含了已知的所有行業,例如:Industry.OnlineGame代表了網絡遊戲這一行業;Industry類有三個屬性,分別為:Code-產業代碼,Name-產業名稱,PrimaryIndustry-主產業。
設定所屬產業的範例:
/// <summary> /// 设置所属行业 /// </summary> /// <param name="sender"></param> /// <param name="e"></param> protected void btnSetIndustry_Click(object sender, EventArgs e) { string userName = lbPublicAccount.SelectedValue; string industryCode1 = "", industryCode2 = ""; int count = 0; foreach (ListItem item in cblIndustry.Items) { if (item.Selected) { count++; if (count == 1) industryCode1 = item.Value; else if (count == 2) { industryCode2 = item.Value; break; } } } if (count != 2) ltrMessage.Text = "请选择两个行业。"; else { ErrorMessage errorMessage = TemplateMessage.SetIndustry(userName, industryCode1, industryCode2); ltrMessage.Text = string.Format("设置所属行业{0}。{1}", errorMessage.IsSuccess ? "成功" : "失败", errorMessage.IsSuccess ? "" : errorMessage.ToString()); } } 设置所属行业示例
設定所屬產業範例
3 取得範本id
TemplateMessage類別的GetId方法用於取得模板id,此方法定義如下:
/// <summary> /// 获取模板ID /// </summary> /// <param name="userName">公众号</param> /// <param name="shortTemplateId">模板库中模板的编号,有“TM**”和“OPENTMTM**”等形式</param> /// <param name="errorMessage">返回获取是否成功</param> /// <returns>返回模板ID;如果获取失败,返回空字符串。</returns> public static string GetId(string userName, string shortTemplateId, out ErrorMessage errorMessage)
注意:(1)如果尚未新增模板,則該方法會先新增模板,然後返回模板id;(2)如果已經新增了模板,再次呼叫該方法,會傳回一個新的不同於上次取得的模板id。
取得模板id的範例:
/// <summary> /// 添加并模板id /// </summary> /// <param name="sender"></param> /// <param name="e"></param> protected void btnGetTemplateId_Click(object sender, EventArgs e) { string userName = lbPublicAccount.SelectedValue; ErrorMessage errorMessage; string templateId = TemplateMessage.GetId(userName, txtTemplateIdShort.Text, out errorMessage); if (errorMessage.IsSuccess) ltrMessage.Text = string.Format("添加并获取模板id成功。模板id:{0}", templateId); else ltrMessage.Text = string.Format("添加并获取模板id失败。{0}", errorMessage.ToString()); }
#取得範本id範例
4 傳送模板訊息
TemplateMessage類別的Send方法用於傳送範本訊息,方法定義如下:
/// <summary> /// 发送模板消息 /// </summary> /// <param name="userName">公众号</param> /// <param name="touser">接收消息的账号</param> /// <param name="templateId">模板id</param> /// <param name="detailUrl">详情地址</param> /// <param name="topColor">顶端颜色</param> /// <param name="data">数据</param> /// <param name="errorMessage">返回发送是否成功</param> /// <returns>返回消息id;如果发送失败,返回-1。</returns> public static long Send(string userName, string touser, string templateId, string detailUrl, Color topColor, Tuple<string, string, Color>[] data, out ErrorMessage errorMessage)
其中,data參數為Tuple類型,包含模板所使用的數據,data.Item1為數據鍵,data.Item2為數據值,data.Item3為顯示數據的顏色。
傳送範本訊息的範例:
/// <summary> /// 发送模板消息 /// </summary> /// <param name="userName">公众号</param> /// <param name="touser">接收消息的账号</param> /// <param name="templateId">模板id</param> /// <param name="detailUrl">详情地址</param> /// <param name="topColor">顶端颜色</param> /// <param name="data">数据</param> /// <param name="errorMessage">返回发送是否成功</param> /// <returns>返回消息id;如果发送失败,返回-1。</returns> public static long Send(string userName, string touser, string templateId, string detailUrl, Color topColor, Tuple<string, string, Color>[] data, out ErrorMessage errorMessage)
#傳送範本訊息範例
5 接收推播範本訊息傳送結果事件
在傳送範本訊息之後,微信伺服器會推送結果到公眾號碼的指定URL上,公眾號碼伺服器會接收到一封RequestTemplateSendJobFinishMessage類型的請求訊息。
RequestTemplateSendJobFinishMessage類別有以下唯讀屬性:
/// <summary> /// 获取消息id /// </summary> public long MsgID { get; private set; } /// <summary> /// 获取群发消息的结果 /// </summary> public string Status { get; private set; } /// <summary> /// 获取消息是否群发成功 /// </summary> public TemplateMessageSendStatusEnum SendStatus { get { TemplateMessageSendStatusEnum status; if (Status == sendFailedUserBlock) status = TemplateMessageSendStatusEnum.UserBlock; else if (Status == sendFailedSystemFailed) status = TemplateMessageSendStatusEnum.SystemFailed; else status = TemplateMessageSendStatusEnum.Success; return status; } }
以上是.net微信公眾號開發的詳細內容。更多資訊請關注PHP中文網其他相關文章!