C#开发微信门户及应用(37)--微信公众号标签管理功能
2021-07-25 20:33:56

    /// <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);
    }

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

{
  "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;
        }

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
}
  ]
}

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