me.chanjar.weixin.mp.api

接口 WxMpSubscribeMsgService

所有已知实现类:

WxMpSubscribeMsgServiceImpl

public interface WxMpSubscribeMsgService

 订阅消息服务接口
 

作者:

Mklaus created on 2018 -01-22 上午11:07

方法概要

限定符和类型	方法和说明
String	addTemplate(String id, List<Integer> keywordIdList, String sceneDesc) 组合模板并添加至账号下的个人模板库 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?
boolean	delTemplate(String templateId) 删除账号下的某个模板 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate?
List<CategoryData>	getCategory() 获取公众号类目 https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html GET https://api.weixin.qq.com/wxaapi/newtmpl/getcategory?
List<PubTemplateKeyword>	getPubTemplateKeyWordsById(String id) 获取模板库某个模板标题下关键词库 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?
PubTemplateTitleListResult	getPubTemplateTitleList(String[] ids, int start, int limit) 获取账号所属类目下的公共模板标题 详情请见: 获取账号所属类目下的公共模板标题 接口url格式: https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?
List<TemplateInfo>	getTemplateList() 获取当前账号下的个人模板列表 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?
String	send(WxMpSubscribeMessage subscribeMessage) 发送订阅消息 https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html
boolean	sendOnce(WxMpSubscribeMessage message) 发送一次性订阅消息 详情请见: https://mp.weixin.qq.com/wiki?
String	subscribeMsgAuthorizationUrl(String redirectURI, int scene, String reserved) 构造用户订阅一条模板消息授权的url连接 详情请见: https://mp.weixin.qq.com/wiki?

方法详细资料

subscribeMsgAuthorizationUrl

String subscribeMsgAuthorizationUrl(String redirectURI,
                                    int scene,
                                    String reserved)

 构造用户订阅一条模板消息授权的url连接
 详情请见: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1500374289_66bvB
 

参数:

redirectURI - 用户授权完成后的重定向链接，无需urlencode, 方法内会进行encode

scene - 重定向后会带上scene参数，开发者可以填0-10000的整形值，用来标识订阅场景值

reserved - 用于保持请求和回调的状态，授权请后原样带回给第三方 (最多128字节，要求做urlencode)

返回:

url string

sendOnce

boolean sendOnce(WxMpSubscribeMessage message)
          throws WxErrorException

 发送一次性订阅消息
 详情请见: https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1500374289_66bvB
 

参数:

message - the message

返回:

消息Id boolean

抛出:

WxErrorException - the wx error exception

getPubTemplateTitleList

PubTemplateTitleListResult getPubTemplateTitleList(String[] ids,
                                                   int start,
                                                   int limit)
                                            throws WxErrorException

 获取账号所属类目下的公共模板标题

 详情请见: 获取账号所属类目下的公共模板标题
 接口url格式: https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?access_token=ACCESS_TOKEN
 

参数:

ids - 类目 id，多个用逗号隔开

start - 用于分页，表示从 start 开始。从 0 开始计数。

limit - 用于分页，表示拉取 limit 条记录。最大为 30。

返回:

. pub template title list

抛出:

WxErrorException - .

getPubTemplateKeyWordsById

List<PubTemplateKeyword> getPubTemplateKeyWordsById(String id)
                                             throws WxErrorException

 获取模板库某个模板标题下关键词库

 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html
 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?access_token=ACCESS_TOKEN
 

参数:

id - 模板标题 id，可通过接口获取

返回:

. pub template key words by id

抛出:

WxErrorException - .

addTemplate

String addTemplate(String id,
                   List<Integer> keywordIdList,
                   String sceneDesc)
            throws WxErrorException

 组合模板并添加至账号下的个人模板库

 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html
 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN
 

参数:

id - 模板标题 id，可通过接口获取，也可登录小程序后台查看获取

keywordIdList - 模板关键词列表

sceneDesc - 服务场景描述，15个字以内

返回:

添加至账号下的模板id ，发送小程序订阅消息时所需

抛出:

WxErrorException - .

getTemplateList

List<TemplateInfo> getTemplateList()
                            throws WxErrorException

 获取当前账号下的个人模板列表

 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html
 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?access_token=ACCESS_TOKEN
 

返回:

. template list

抛出:

WxErrorException - .

delTemplate

boolean delTemplate(String templateId)
             throws WxErrorException

 删除账号下的某个模板

 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html
 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate?access_token=ACCESS_TOKEN
 

参数:

templateId - 要删除的模板id

返回:

删除是否成功 boolean

抛出:

WxErrorException - .

getCategory

List<CategoryData> getCategory()
                        throws WxErrorException

 获取公众号类目
 https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html
 GET https://api.weixin.qq.com/wxaapi/newtmpl/getcategory?access_token=ACCESS_TOKEN
 

返回:

. category

抛出:

WxErrorException - .

send

String send(WxMpSubscribeMessage subscribeMessage)
     throws WxErrorException

 发送订阅消息
 https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html
 

参数:

subscribeMessage - 订阅消息

返回:

下发消息id，与下发结果回调的msgId对应

抛出:

WxErrorException - .