.net微信公众号开发——群发消息

   本文将介绍微信公众号开发中用于群发消息的类MassMessage，包括：（1）MassMessage类；（2）群发；（3）删除；（4）预览；（5）查询发送状态；（6）接收推送群发结果事件。
    源代码地址：http://git.oschina.net/xrwang2/xrwang.weixin.PublicAccount/tree/master/PublicAccount/MassMessage
    演示地址：http://www.xrwang.net/Example/MassMessage.aspx

1 MassMessage类
    MassMessage静态类封装了群发消息相关的方法，如下表：

作用 方法名
群发 Send
删除 Delete
预览 Preview
查询发送状态 GetStatus

 

2 群发
    公众号可以按用户分组群发消息，也可以按用户的OpenId列表来群发群发消息。
2.1 按用户分组群发消息
    方法定义如下：

复制代码
/// <summary>
/// 根据分组群发消息
/// </summary>
/// <param name="userName">公众号</param>
/// <param name="isToAll">是否群发给所有用户</param>
/// <param name="groupId">如果群发给所有用户，忽略该参数；否则群发给该组中的用户</param>
/// <param name="messageType">群发消息类型</param>
/// <param name="mediaIdOrContent">多媒体id或者文本内容</param>
/// <param name="errorMessage">返回发送是否成功</param>
/// <returns>如果发送成功，返回消息ID；否则，返回-1。</returns>
public static long Send(string userName, bool isToAll, string groupId, MassMessageTypeEnum messageType, string mediaIdOrContent, out ErrorMessage errorMessage)
复制代码

    使用示例如下：

 

[csharp] view plaincopy在CODE上查看代码片派生到我的代码片
  1. /// <summary>  
  2. /// 按分组群发消息  
  3. /// </summary>  
  4. /// <param name="sender"></param>  
  5. /// <param name="e"></param>  
  6. protected void btnSendToGroup_Click(object sender, EventArgs e)  
  7. {  
  8.     if (rblGroup.SelectedIndex >= 0)  
  9.     {  
  10.         string userName = lbPublicAccount.SelectedValue;  
  11.         ErrorMessage errorMessage;  
  12.         bool isToAll = string.IsNullOrWhiteSpace(rblGroup.SelectedValue);  
  13.         string groupId = isToAll ? "" : rblGroup.SelectedValue;  
  14.         string content = txtContent.Text;  
  15.         long msgId = MassMessage.Send(userName, isToAll, groupId, MassMessageTypeEnum.text, content, out errorMessage);  
  16.         if (errorMessage.IsSuccess)  
  17.         {  
  18.             ltrMessage.Text = "群发消息成功。";  
  19.             rblMassMessage.Items.Add(new ListItem(string.Format("id:{0},text:{1}", msgId, content), msgId.ToString()));  
  20.         }  
  21.         else  
  22.             ltrMessage.Text = string.Format("群发消息失败。{0}", errorMessage);  
  23.     }  
  24. }  

 

 

2.2 按OpenId列表群发

    方法定义如下：

复制代码
/// <summary>
/// 根据OpenId列表群发消息
/// </summary>
/// <param name="userName">公众号</param>
/// <param name="tousers">OpenId列表</param>
/// <param name="messageType">群发消息类型</param>
/// <param name="mediaIdOrContent">多媒体id或者文本内容</param>
/// <param name="errorMessage">返回发送是否成功</param>
/// <returns>如果发送成功，返回消息ID；否则，返回-1。</returns>
public static long Send(string userName, IEnumerable<string> tousers, MassMessageTypeEnum messageType, string mediaIdOrContent, out ErrorMessage errorMessage)
复制代码

    使用示例如下：

 

[csharp] view plaincopy在CODE上查看代码片派生到我的代码片
  1. /// <summary>  
  2. /// 按用户群发消息  
  3. /// </summary>  
  4. /// <param name="sender"></param>  
  5. /// <param name="e"></param>  
  6. protected void btnSendToUsers_Click(object sender, EventArgs e)  
  7. {  
  8.     if (cblUser.SelectedIndex >= 0)  
  9.     {  
  10.         string userName = lbPublicAccount.SelectedValue;  
  11.         ErrorMessage errorMessage;  
  12.         List<string> openIds = new List<string>();  
  13.         foreach (ListItem item in cblUser.Items)  
  14.         {  
  15.             if (item.Selected)  
  16.                 openIds.Add(item.Value);  
  17.         }  
  18.         string content = txtContent.Text;  
  19.         long msgId = MassMessage.Send(userName, openIds, MassMessageTypeEnum.text, content, out errorMessage);  
  20.         if (errorMessage.IsSuccess)  
  21.         {  
  22.             ltrMessage.Text = "群发消息成功。";  
  23.             rblMassMessage.Items.Add(new ListItem(string.Format("id:{0},text:{1}", msgId, content), msgId.ToString()));  
  24.         }  
  25.         else  
  26.             ltrMessage.Text = string.Format("群发消息失败。{0}", errorMessage);  
  27.     }  
  28. }  

 

 

3 删除群发
    删除已群发消息的方法定义如下：

复制代码
/// <summary>
/// 删除群发消息。
/// 注：只能删除图文消息和视频消息。
/// </summary>
/// <param name="userName">公众号</param>
/// <param name="messageId">消息id</param>
/// <returns>返回删除是否成功</returns>
public static ErrorMessage Delete(string userName, long messageId)
复制代码

    使用示例如下：

 

[csharp] view plaincopy在CODE上查看代码片派生到我的代码片
  1. /// <summary>  
  2. /// 删除群发消息  
  3. /// </summary>  
  4. /// <param name="sender"></param>  
  5. /// <param name="e"></param>  
  6. protected void btnDelete_Click(object sender, EventArgs e)  
  7. {  
  8.     if (rblMassMessage.SelectedIndex >= 0)  
  9.     {  
  10.         string userName = lbPublicAccount.SelectedValue;  
  11.         long msgId = long.Parse(rblMassMessage.SelectedValue);  
  12.         ErrorMessage errorMessage = MassMessage.Delete(userName, msgId);  
  13.         if (errorMessage.IsSuccess)  
  14.         {  
  15.             ltrMessage.Text = "删除消息成功。";  
  16.             rblMassMessage.Items.Remove(rblMassMessage.SelectedItem);  
  17.         }  
  18.         else  
  19.             ltrMessage.Text = string.Format("删除消息失败。{0}", errorMessage);  
  20.     }  
  21. }  

 

 

4 预览群发
    预览群发消息的方法定义如下：

复制代码
/// <summary>
/// 预览群发消息
/// </summary>
/// <param name="userName">公众号</param>
/// <param name="touser">OpenId</param>
/// <param name="messageType">群发消息类型</param>
/// <param name="mediaIdOrContent">多媒体id或者文本内容</param>
/// <param name="errorMessage">返回发送是否成功</param>
/// <returns>如果发送成功，返回消息ID；否则，返回-1。</returns>
public static long Preview(string userName, string touser, MassMessageTypeEnum messageType, string mediaIdOrContent, out ErrorMessage errorMessage)
复制代码

    使用示例如下：

 

[csharp] view plaincopy在CODE上查看代码片派生到我的代码片
  1. /// <summary>  
  2. /// 预览群发消息  
  3. /// </summary>  
  4. /// <param name="sender"></param>  
  5. /// <param name="e"></param>  
  6. protected void btnPreview_Click(object sender, EventArgs e)  
  7. {  
  8.     if (cblUser.SelectedIndex >= 0)  
  9.     {  
  10.         string userName = lbPublicAccount.SelectedValue;  
  11.         ErrorMessage errorMessage;  
  12.         string openId = cblUser.SelectedValue;  
  13.         string content = txtContent.Text;  
  14.         long msgId = MassMessage.Preview(userName, openId, MassMessageTypeEnum.text, content, out errorMessage);  
  15.         if (errorMessage.IsSuccess)  
  16.         {  
  17.             ltrMessage.Text = "预览消息成功。";  
  18.             rblMassMessage.Items.Add(new ListItem(string.Format("id:{0},text:{1}", msgId, content), msgId.ToString()));  
  19.         }  
  20.         else  
  21.             ltrMessage.Text = string.Format("预览消息失败。{0}", errorMessage);  
  22.     }  
  23. }  

 

 

5 查询群发消息发送状态
    查询群发消息发送状态的方法定义如下：

复制代码
/// <summary>
/// 查询群发消息的发送状态
/// </summary>
/// <param name="userName">公众号</param>
/// <param name="messageId">消息id</param>
/// <param name="errorMessage">返回查询是否成功</param>
/// <returns>返回消息是否发送成功</returns>
public static bool GetStatus(string userName, long messageId, out ErrorMessage errorMessage)
复制代码

    使用示例如下：

 

[csharp] view plaincopy在CODE上查看代码片派生到我的代码片
  1. /// <summary>  
  2. /// 查询群发消息状态  
  3. /// </summary>  
  4. /// <param name="sender"></param>  
  5. /// <param name="e"></param>  
  6. protected void btnGetStatus_Click(object sender, EventArgs e)  
  7. {  
  8.     if (rblMassMessage.SelectedIndex >= 0)  
  9.     {  
  10.         string userName = lbPublicAccount.SelectedValue;  
  11.         ErrorMessage errorMessage;  
  12.         long msgId = long.Parse(rblMassMessage.SelectedValue);  
  13.         bool success = MassMessage.GetStatus(userName, msgId, out errorMessage);  
  14.         if (errorMessage.IsSuccess)  
  15.             ltrMessage.Text = string.Format("消息群发{0}。", success ? "成功" : "失败");  
  16.         else  
  17.             ltrMessage.Text = string.Format("获取消息群发状态失败。{0}", errorMessage);  
  18.     }  
  19. }  

 

 

6 接收推送群发结果事件
    群发消息之后，微信服务器会推送群发的结果到公众号的指定URL上，公众号服务器会接收到一条RequestMassSendJobFinishMessage类型的请求消息。
    RequestMassSendJobFinishMessage类有以下只读属性：

复制代码
        /// <summary>
        /// 获取消息id
        /// </summary>
        public long MsgID { get; private set; }
        /// <summary>
        /// 获取群发消息的结果
        /// </summary>
        public string Status { get; private set; }
        /// <summary>
        /// 获取用户总数
        /// </summary>
        public int TotalCount { get; private set; }
        /// <summary>
        /// 获取过滤后待发送的用户数
        /// </summary>
        public int FilterCount { get; private set; }
        /// <summary>
        /// 获取发送成功的用户数
        /// </summary>
        public int SentCount { get; private set; }
        /// <summary>
        /// 获取发送失败的用户数
        /// </summary>
        public int ErrorCount { get; private set; }

        /// <summary>
        /// 获取消息是否群发成功
        /// </summary>
        public bool SendSuccess
        {
            get
            {
                return Status == sendSuccess;
            }
        }
        /// <summary>
        /// 获取发送失败的原因
        /// </summary>
        public string ErrorReason
        {
            get
            {
                string reason = string.Empty;
                if (Status == sendSuccess)
                    reason = "发送成功";
                else if (Status == sendFailed)
                    reason = "发送失败";
                else if (errorDict.ContainsKey(Status))
                    reason = errorDict[Status];
                return reason;
            }
        }
posted on 2015-05-14 09:08  GC2013  阅读(676)  评论(0)  编辑  收藏  举报
Powered by:
博客园
Copyright © 2024 GC2013
Powered by .NET 9.0 on Kubernetes