『QQ:1353814576』

微信公众平台C#开发系列(十四): 模板消息-获取模板列表


使用微信公众平台接口获取当前的模板信息

获取已添加至帐号下所有模板列表,可在微信公众平台后台中查看模板列表信息。为方便第三方开发者,提供通过接口调用的方式来获取帐号下所有模板信息,具体如下:

官方文档地址

https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#

获得模板ID

根据文档我们先定义一个MessageTemplateListResponse类继承 ErrorMessage 用于解析接口结果

ErrorMessage 公共类参考 : 微信公众平台C#开发系列(四):获取access token凭证

namespace YuanTK.WeiXin.Wrapper
{
    /// <summary>
    /// 模板消息列表结果
    /// </summary>
    public class MessageTemplateListResponse : ErrorMessage
    {
        public MessageTemplate[] template_list { get; set; }
    }

    public class MessageTemplate
    {
        /// <summary>
        /// 模板ID
        /// </summary>
        public string template_id { get; set; }
        /// <summary>
        /// 模板标题
        /// </summary>
        public string title { get; set; }
        /// <summary>
        /// 模板所属行业的一级行业
        /// </summary>
        public string primary_industry { get; set; }
        /// <summary>
        /// 模板所属行业的二级行业
        /// </summary>
        public string deputy_industry { get; set; }

        /// <summary>
        /// 模板内容
        /// </summary>
        public string content { get; set; }
        /// <summary>
        /// 模板示例
        /// </summary>
        public string example { get; set; }
    }
}

定义一个MessageTemplateList方法类继承WeiXinRequest 和接口IWeiXin

namespace YuanTK.WeiXin
{

    /// <summary>
    /// 获取模板列表
    /// </summary>
    public class MessageTemplateList : WeiXinRequest<MessageTemplateListResponse>, IWeiXin<MessageTemplateListResponse>
    {
        String api;
        public MessageTemplateList(string access_token)
        {
            this.api = $"https://api.weixin.qq.com/cgi-bin/template/get_all_private_template?access_token={access_token}";
        }

        /// <summary>
        /// 调用接口获取结果
        /// </summary>
        /// <returns></returns>
        public MessageTemplateListResponse GetResponse()
        {
            return this.Get(api);
        }
    }
}

调用代码例子

string access_token = token.access_token; 
IWeiXin<MessageTemplateListResponse> api = new MessageTemplateList(access_token);
MessageTemplateListResponse response = api.GetResponse();

微信公众号凭证access_token如何获取?

调用成功返回的结果

微信公众平台C#开发系列(十四): 模板消息-获取模板列表

可以看到这里的模板信息就是上一篇文章里在后台添加的测试模板

传送门 微信公众平台C#开发系列(十三): 模板消息-获得模板ID