cn.binarywang.wx.miniapp.api.WxMaSubscribeService Maven / Gradle / Ivy
package cn.binarywang.wx.miniapp.api;
import cn.binarywang.wx.miniapp.bean.WxMaSubscribeMessage;
import me.chanjar.weixin.common.bean.subscribemsg.CategoryData;
import me.chanjar.weixin.common.bean.subscribemsg.PubTemplateKeyword;
import me.chanjar.weixin.common.bean.subscribemsg.TemplateInfo;
import me.chanjar.weixin.common.bean.subscribemsg.PubTemplateTitleListResult;
import me.chanjar.weixin.common.error.WxErrorException;
import java.util.List;
/**
* 订阅消息类
*
* @author Binary Wang
* created on 2019-12-15
*/
public interface WxMaSubscribeService {
/**
*
* 获取帐号所属类目下的公共模板标题
*
* 详情请见: 获取帐号所属类目下的公共模板标题
* 接口url格式: https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?access_token=ACCESS_TOKEN
*
*
* @param ids 类目 id，多个用逗号隔开
* @param limit 用于分页，表示拉取 limit 条记录。最大为 30。
* @param start 用于分页，表示从 start 开始。从 0 开始计数。
* @return .
* @throws WxErrorException .
*/
PubTemplateTitleListResult getPubTemplateTitleList(String[] ids, int start, int limit) throws WxErrorException;
/**
*
* 获取模板库某个模板标题下关键词库
*
* 详情请见: 获取模板标题下的关键词列表
* 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?access_token=ACCESS_TOKEN
*
*
* @param id 模板标题 id，可通过接口获取
* @return .
* @throws WxErrorException .
*/
List getPubTemplateKeyWordsById(String id) throws WxErrorException;
/**
*
* 组合模板并添加至帐号下的个人模板库
*
* 详情请见: 获取小程序模板库标题列表
* 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN
*
*
* @param id 模板标题 id，可通过接口获取，也可登录小程序后台查看获取
* @param keywordIdList 模板关键词列表
* @param sceneDesc 服务场景描述，15个字以内
* @return 添加至帐号下的模板id，发送小程序订阅消息时所需
* @throws WxErrorException .
*/
String addTemplate(String id, List keywordIdList, String sceneDesc) throws WxErrorException;
/**
*
* 获取当前帐号下的个人模板列表
*
* 详情请见: 获取当前帐号下的个人模板列表
* 接口url格式: GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?access_token=ACCESS_TOKEN
*
*
* @return .
* @throws WxErrorException .
*/
List getTemplateList() throws WxErrorException;
/**
*
* 删除帐号下的某个模板
*
* 详情请见: 删除帐号下的个人模板
* 接口url格式: POST https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate?access_token=ACCESS_TOKEN
*
*
* @param templateId 要删除的模板id
* @return 删除是否成功
* @throws WxErrorException .
*/
boolean delTemplate(String templateId) 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
*
*
* @return .
* @throws WxErrorException .
*/
List getCategory() throws WxErrorException;
/**
*
* 发送订阅消息
* https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html
*
*
* @param subscribeMessage 订阅消息
* @throws WxErrorException .
*/
void sendSubscribeMsg(WxMaSubscribeMessage subscribeMessage) throws WxErrorException;
}