C#開發(fā)微信門戶及應(yīng)用(37)--微信公眾號標(biāo)簽管理功能
2021-07-25 20:33:56

    /// <summary>
    /// 微信標(biāo)簽管理的API接口
    /// 開發(fā)者可以使用用戶標(biāo)簽管理的相關(guān)接口，實現(xiàn)對公眾號的標(biāo)簽進行創(chuàng)建、查詢、修改、刪除等操作，也可以對用戶進行打標(biāo)簽、取消標(biāo)簽等操作。
    /// </summary>
    public interface ITagApi
    {               
        /// <summary>
        /// 創(chuàng)建標(biāo)簽
        /// 一個公眾號，最多可以創(chuàng)建100個標(biāo)簽。
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <param name="name">標(biāo)簽名（30個字符以內(nèi)）</param>
        /// <returns></returns>
        TagJson CreateTag(string accessToken, string name);

        /// <summary>
        /// 獲取公眾號已創(chuàng)建的標(biāo)簽
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <returns></returns>
        List<TagCountJson> GetTagList(string accessToken);

        /// <summary>
        /// 編輯標(biāo)簽
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <param name="id">標(biāo)簽ID</param>
        /// <param name="name">標(biāo)簽名稱</param>
        /// <returns></returns>
        CommonResult UpdateTag(string accessToken, int id, string name);

        /// <summary>
        /// 刪除標(biāo)簽
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <param name="id">標(biāo)簽ID</param>
        /// <returns></returns>
        CommonResult DeleteTag(string accessToken, int id);

        /// <summary>
        /// 獲取標(biāo)簽下粉絲列表
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <param name="id">標(biāo)簽ID</param>
        /// <param name="name">標(biāo)簽名稱</param>
        /// <returns></returns>
        GetTagResult GetTag(string accessToken, int id, string next_openid = null);

        /// <summary>
        /// 批量為用戶打標(biāo)簽
        /// 標(biāo)簽功能目前支持公眾號為用戶打上最多三個標(biāo)簽。
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <param name="tagid">標(biāo)簽ID</param>
        /// <param name="openid_list">粉絲列表</param>
        /// <returns></returns>
        CommonResult BatchTagging(string accessToken, int tagid, List<string> openid_list);

        /// <summary>
        /// 批量為用戶取消標(biāo)簽
        /// 標(biāo)簽功能目前支持公眾號為用戶打上最多三個標(biāo)簽。
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <param name="tagid">標(biāo)簽ID</param>
        /// <param name="openid_list">粉絲列表</param>
        /// <returns></returns>
        CommonResult BatchUntagging(string accessToken, int tagid, List<string> openid_list);

        /// <summary>
        /// 獲取用戶身上的標(biāo)簽列表
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <param name="openid">用戶OpenID</param>
        /// <returns></returns>
        List<int> GetIdList(string accessToken, string openid);
    }

http請求方式：POST（請使用https協(xié)議）
https://api.weixin.qq.com/cgi-bin/tags/create?access_token=ACCESS_TOKEN
POST數(shù)據(jù)格式：JSON
POST數(shù)據(jù)例子：
{
  "tag" : {
    "name" : "廣東"http://標(biāo)簽名
  }
}

{
  "tag":{
  "id":134,//標(biāo)簽id
  "name":"廣東"
  }
}

    /// <summary>
    /// 標(biāo)簽信息
    /// </summary>
    public class TagJson
    {
        /// <summary>
        /// 標(biāo)簽id，由微信分配
        /// </summary>
        public int id { get; set; }

        /// <summary>
        /// 標(biāo)簽名，UTF8編碼
        /// </summary>
        public string name { get; set; }
    }

        /// <summary>
        /// 創(chuàng)建標(biāo)簽
        /// 一個公眾號，最多可以創(chuàng)建100個標(biāo)簽。
        /// </summary>
        /// <param name="accessToken">調(diào)用接口憑證</param>
        /// <param name="name">標(biāo)簽名（30個字符以內(nèi)）</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協(xié)議）
https://api.weixin.qq.com/cgi-bin/tags/get?access_token=ACCESS_TOKEN

返回數(shù)據(jù)格式：JSON
返回的數(shù)據(jù)例子：
{
  "tags":[{
      "id":1,
      "name":"黑名單",
      "count":0 //此標(biāo)簽下粉絲數(shù)
},{
  "id":2,
  "name":"星標(biāo)組",
  "count":0
},{
  "id":127,
  "name":"廣東",
  "count":5
}
  ]
}

    /// <summary>
    /// 標(biāo)簽信息和統(tǒng)計數(shù)量
    /// </summary>
    public class TagCountJson : TagJson
    {
        /// <summary>
        /// 此標(biāo)簽下粉絲數(shù)
        /// </summary>
        public int count { get; set; }
    }