cn.binarywang.wx.miniapp.api

接口 WxMaSubscribeService

所有已知实现类:

WxMaSubscribeServiceImpl

public interface WxMaSubscribeService

订阅消息类

作者:

Binary Wang

嵌套类概要

嵌套类

限定符和类型	接口和说明
static class	WxMaSubscribeService.CategoryData
static class	WxMaSubscribeService.PubTemplateKeyword
static class	WxMaSubscribeService.TemplateInfo

字段概要

字段

限定符和类型	字段和说明
static String	GET_CATEGORY_URL 获取小程序账号的类目
static String	GET_PUB_TEMPLATE_KEY_WORDS_BY_ID_URL 获取模板标题下的关键词列表.
static String	GET_PUB_TEMPLATE_TITLE_LIST_URL 获取模板标题下的关键词列表.
static String	TEMPLATE_ADD_URL 组合模板并添加至帐号下的个人模板库.
static String	TEMPLATE_DEL_URL 删除帐号下的某个模板.
static String	TEMPLATE_LIST_URL 获取当前帐号下的个人模板列表.

方法概要

限定符和类型	方法和说明
String	addTemplate(String id, List<Integer> keywordIdList, String sceneDesc) 组合模板并添加至帐号下的个人模板库 详情请见: 获取小程序模板库标题列表 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?
boolean	delTemplate(String templateId) 删除帐号下的某个模板 详情请见: 删除帐号下的个人模板 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate?
List<WxMaSubscribeService.CategoryData>	getCategory() 获取小程序账号的类目 https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getCategory.html GET https://api.weixin.qq.com/wxaapi/newtmpl/getcategory?
List<WxMaSubscribeService.PubTemplateKeyword>	getPubTemplateKeyWordsById(String id) 获取模板库某个模板标题下关键词库 详情请见: 获取模板标题下的关键词列表 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?
WxMaPubTemplateTitleListResult	getPubTemplateTitleList(String[] ids, int start, int limit) 获取帐号所属类目下的公共模板标题 详情请见: 获取帐号所属类目下的公共模板标题 接口url格式: https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?
List<WxMaSubscribeService.TemplateInfo>	getTemplateList() 获取当前帐号下的个人模板列表 详情请见: 获取当前帐号下的个人模板列表 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?

字段详细资料

GET_PUB_TEMPLATE_TITLE_LIST_URL

static final String GET_PUB_TEMPLATE_TITLE_LIST_URL

获取模板标题下的关键词列表.

另请参阅:

常量字段值

GET_PUB_TEMPLATE_KEY_WORDS_BY_ID_URL

static final String GET_PUB_TEMPLATE_KEY_WORDS_BY_ID_URL

获取模板标题下的关键词列表.

另请参阅:

常量字段值

TEMPLATE_ADD_URL

static final String TEMPLATE_ADD_URL

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

另请参阅:

常量字段值

TEMPLATE_LIST_URL

static final String TEMPLATE_LIST_URL

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

另请参阅:

常量字段值

TEMPLATE_DEL_URL

static final String TEMPLATE_DEL_URL

删除帐号下的某个模板.

另请参阅:

常量字段值

GET_CATEGORY_URL

static final String GET_CATEGORY_URL

获取小程序账号的类目

另请参阅:

常量字段值

方法详细资料

getPubTemplateTitleList

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

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

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

参数:

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

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

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

返回:

.

抛出:

WxErrorException - .

getPubTemplateKeyWordsById

List<WxMaSubscribeService.PubTemplateKeyword> getPubTemplateKeyWordsById(String id)
                                                                  throws WxErrorException

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

 详情请见: 获取模板标题下的关键词列表
 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?access_token=ACCESS_TOKEN
 

参数:

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

返回:

.

抛出:

WxErrorException - .

addTemplate

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

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

 详情请见: 获取小程序模板库标题列表
 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN
 

参数:

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

keywordIdList - 模板关键词列表

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

返回:

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

抛出:

WxErrorException - .

getTemplateList

List<WxMaSubscribeService.TemplateInfo> getTemplateList()
                                                 throws WxErrorException

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

 详情请见: 获取当前帐号下的个人模板列表
 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?access_token=ACCESS_TOKEN
 

返回:

.

抛出:

WxErrorException - .

delTemplate

boolean delTemplate(String templateId)
             throws WxErrorException

 删除帐号下的某个模板

 详情请见: 删除帐号下的个人模板
 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate?access_token=ACCESS_TOKEN
 

参数:

templateId - 要删除的模板id

返回:

删除是否成功

抛出:

WxErrorException - .

getCategory

List<WxMaSubscribeService.CategoryData> getCategory()
                                             throws WxErrorException

 获取小程序账号的类目
 https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getCategory.html
 GET https://api.weixin.qq.com/wxaapi/newtmpl/getcategory?access_token=ACCESS_TOKEN
 

返回:

.

抛出:

WxErrorException - .