C#开发微信门户及应用(37)--微信公众号标签管理功能

微信公众号，仿照企业号的思路，增加了标签管理的功能，对关注的粉丝可以设置标签管理，实现更加方便的分组管理功能。开发者可以使用用户标签管理的相关接口，实现对公众号的标签进行创建、查询、修改、删除等操作，也可以对用户进行打标签、取消标签等操作。本篇随笔主要介绍如何利用C#对公众号这个较新的特性进行封装，实现对标签的管理功能。

1、标签功能介绍

1）标签功能替代分组功能，支持多维度定义用户属性

运营者可登录公众平台后台，点击左侧菜单“用户管理”后管理已关注用户，点击其中一个用户右侧的“标签”小角标可弹出复选框快速为该用户添加标签，且添加标签复选框内已支持直接新建标签。

另外，标签功能接口也已更新，开发者可调用接口，实现对标签和用户操作。同时，高级群发接口和个性化菜单接口等已支持根据标签实现操作。详情可查看微信公众平台开发者文档。

2）优化用户卡片，支持多场景查看用户头像大图与互动数据，增强运营者对用户熟悉度与管理效率

本期新增消息数、留言数和赞赏数等互动数据，且显示用户关注时间和支持查看用户头像大图，有利于拉近运营者与用户的距离。另外，支持“赞赏功能”和“留言管理”场景直接管理用户，提升管理效率。

2、标签的接口封装

标签的接口分为两部分：标签管理和用户管理，一个公众号，最多可以创建100个标签。标签功能目前支持公众号为用户打上最多三个标签。

其中标签管理包括：

1）创建标签 2）获取公众号已创建的标签 3）编辑标签 4）删除标签 5）获取标签下粉丝列表

标签的用户管理包括：
1）批量为用户打标签 2）批量为用户取消标签 3）获取用户身上的标签列表

下面分别为几种接口封装进行相关的介绍。

首先按照常规的方式，我们定义好相关的接口和实现关系，如下图所示。

根据相关的接口说明，我们可以实现标签接口的定义，C#代码如下所示。

    /// <summary>
    /// 微信标签管理的API接口
    /// 开发者可以使用用户标签管理的相关接口，实现对公众号的标签进行创建、查询、修改、删除等操作，也可以对用户进行打标签、取消标签等操作。
    /// </summary>
    public interface ITagApi
    {               
        /// <summary>
        /// 创建标签
        /// 一个公众号，最多可以创建100个标签。
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="name">标签名（30个字符以内）</param>
        /// <returns></returns>
        TagJson CreateTag(string accessToken, string name);

        /// <summary>
        /// 获取公众号已创建的标签
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <returns></returns>
        List<TagCountJson> GetTagList(string accessToken);

        /// <summary>
        /// 编辑标签
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="id">标签ID</param>
        /// <param name="name">标签名称</param>
        /// <returns></returns>
        CommonResult UpdateTag(string accessToken, int id, string name);

        /// <summary>
        /// 删除标签
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="id">标签ID</param>
        /// <returns></returns>
        CommonResult DeleteTag(string accessToken, int id);

        /// <summary>
        /// 获取标签下粉丝列表
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="id">标签ID</param>
        /// <param name="name">标签名称</param>
        /// <returns></returns>
        GetTagResult GetTag(string accessToken, int id, string next_openid = null);

        /// <summary>
        /// 批量为用户打标签
        /// 标签功能目前支持公众号为用户打上最多三个标签。
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="tagid">标签ID</param>
        /// <param name="openid_list">粉丝列表</param>
        /// <returns></returns>
        CommonResult BatchTagging(string accessToken, int tagid, List<string> openid_list);

        /// <summary>
        /// 批量为用户取消标签
        /// 标签功能目前支持公众号为用户打上最多三个标签。
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="tagid">标签ID</param>
        /// <param name="openid_list">粉丝列表</param>
        /// <returns></returns>
        CommonResult BatchUntagging(string accessToken, int tagid, List<string> openid_list);

        /// <summary>
        /// 获取用户身上的标签列表
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="openid">用户OpenID</param>
        /// <returns></returns>
        List<int> GetIdList(string accessToken, string openid);
    }

具体我们来看看几个接口的官方定义数据。

1）创建标签的接口

接口调用请求说明

http请求方式：POST（请使用https协议）
https://api.weixin.qq.com/cgi-bin/tags/create?access_token=ACCESS_TOKEN
POST数据格式：JSON
POST数据例子：
{
  "tag" : {
    "name" : "广东"//标签名
  }
}

返回说明（正常时返回的json数据包示例）

{
  "tag":{
  "id":134,//标签id
  "name":"广东"
  }
}

这样我们就可以定义一个实体类来承载这个返回的数据了。

    /// <summary>
    /// 标签信息
    /// </summary>
    public class TagJson
    {
        /// <summary>
        /// 标签id，由微信分配
        /// </summary>
        public int id { get; set; }

        /// <summary>
        /// 标签名，UTF8编码
        /// </summary>
        public string name { get; set; }
    }

这样，创建标签的完整实现代码如下所示

        /// <summary>
        /// 创建标签
        /// 一个公众号，最多可以创建100个标签。
        /// </summary>
        /// <param name="accessToken">调用接口凭证</param>
        /// <param name="name">标签名（30个字符以内）</param>
        /// <returns></returns>
        public TagJson CreateTag(string accessToken, string name)
        {
            var url = string.Format("https://api.weixin.qq.com/cgi-bin/tags/create?access_token={0}", accessToken);
            var data = new
            {
                tag = new
                {
                    name = name
                }
            };
            var postData = data.ToJson();

            var result = JsonHelper<TagCreateResult>.ConvertJson(url, postData);
            return result != null ? result.tag : null;
        }

2）获取公众号已创建的标签

接口调用请求说明

http请求方式：GET（请使用https协议）
https://api.weixin.qq.com/cgi-bin/tags/get?access_token=ACCESS_TOKEN

返回数据格式：JSON
返回的数据例子：
{
  "tags":[{
      "id":1,
      "name":"黑名单",
      "count":0 //此标签下粉丝数
},{
  "id":2,
  "name":"星标组",
  "count":0
},{
  "id":127,
  "name":"广东",
  "count":5
}
  ]
}

这样我们就可以定义其返回值为List<TagCountJson>了，其中TagCountJson为对应类的属性即可。

    /// <summary>
    /// 标签信息和统计数量
    /// </summary>
    public class TagCountJson : TagJson
    {
        /// <summary>
        /// 此标签下粉丝数
        /// </summary>
        public int count { get; set; }
    }