Wxsdk
wxsdk
Install / Use
/learn @lemonbar/WxsdkREADME
微信服务号 SDK for Java
###如何使用?
在maven工程的pom.xml,添加下面的引用。
<dependency><br/>
<groupId>com.kunbao.weixin</groupId><br/>
<artifactId>sdk</artifactId><br/>
<version>1.1</version><br/>
</dependency><br/>
==== ###初始化
推荐使用下面的单例模式进行初始化。
private WXApi wxApi;<br/>
public synchronized WXApi getWxApi() {<br/>
if (wxApi == null) {<br/>
wxApi = new WXApi(WXConstant.APP_ID, WXConstant.APP_SECRET, WXConstant.TOKEN, WXConstant.EncodingAESKey);<br/>
}<br/>
return wxApi;<br/>
}<br/>
==== ###方法介绍
所有的方法都通过wxApi进行调用,简单易用。<br/> 开发者不需要关心token,相关的刷新逻辑已经封装在代码中。
#####安全相关的接口(包含js认证)
-
验证服务器地址有效性<br/>
boolean checkSignature(String signature, String timestamp, String nonce)<br/> -
解密消息<br/>
String decryptContent(String encryptType, String msgSignature, String timestamp, String nonce, String content) throws AesException<br/> -
加密消息<br/>
String encryptContent(String encryptType, String timestamp, String nonce, String content) throws AesException<br/> -
获得微信服务器IP地址列表<br/>
List<String> getCallbackIpList() throws WXException<br/> -
获得js api config<br/>
WXJsConfig constructWXJsConfig(String url) throws WXException<br/> -
通过oauth code获取用户信息<br/>
WXOAuthUserInfoGetResponse getAuthUserInfo(String appId, String appSecret, String authCode, String lang) throws WXException<br/>
#####消息相关的接口
-
解析接受的消息<br/>
WXMessageBase consumeMessage(String messageStr) throws WXException<br/> -
产生被动回复消息<br/>
String produceText(String fromUser, String toUser, String content) throws WXException<br/>String produceImage(String fromUser, String toUser, String mediaId) throws WXException<br/>String produceVoice(String fromUser, String toUser, String mediaId) throws WXException<br/>String produceVideo(String fromUser, String toUser, WXSendVideoMedia videoMedia) throws WXException<br/>String produceMusic(String fromUser, String toUser, WXSendMusicMedia musicMedia) throws WXException<br/>String produceNews(String fromUser, String toUser, List<WXSendNewsItem> newsItems) throws WXException<br/> -
发送客服消息<br/>
boolean sendCustomText(String toUser, String content) throws WXException<br/>boolean sendCustomImage(String toUser, String mediaId) throws WXException<br/>boolean sendCustomVoice(String toUser, String mediaId) throws WXException<br/>boolean sendCustomVideo(String toUser, VideoContent videoContent) throws WXException<br/>boolean sendCustomMusic(String toUser, MusicContent musicContent) throws WXException<br/>boolean sendCustomNews(String toUser, List<NewsItemContent> articles) throws WXException<br/> -
发送模板消息<br/>
boolean setIndustryForTemplateMessage(Industry industry) throws WXException<br/>String getTemplateIdByShortId(String shortId) throws WXException<br/>String sendTemplateMessage(MessageInfo messageInfo) throws WXException<br/>
#####素材管理接口<br/>
-
新增临时素材,返回新增素材的url<br/>
String uploadTempMedia(MediaType type, String filePath) throws WXException<br/> -
新增永久图文素材<br/>
String addNewsList(NewsList newsList) throws WXException<br/> -
新增永久其它素材<br/>
WXAddCommonMaterialResponse addCommonMaterial(String filePath) throws WXException<br/> -
删除永久素材<br/>
boolean deleteMaterial(String mediaId) throws WXException<br/> -
修改永久图文素材<br/>
boolean updateNewsItem(NewsUpdater newsUpdater) throws WXException<br/> -
获取素材总数<br/>
WXGetMaterialCountResponse getMaterialCount() throws WXException<br/> -
获取素材列表<br/>
WXGetCommonMaterialListResponse getCommonMaterialList(MaterialPageableRequest pageableRequest) throws WXException<br/>WXGetNewsMaterialListResponse getNewsMaterialList(MaterialPageableRequest pageableRequest) throws WXException<br/> -
根据微信端素材id,获得素材url<br/>
String getMaterialTempUrl(String mediaId) throws WXException<br/> -
根据id读取素材,返回byte数组<br/>
byte[] getMaterialBytes(String mediaId) throws WXException<br/>
#####用户管理接口<br/>
-
用户分组管理<br/>
WXUserGroup createUserGroup(String groupName) throws WXException<br/>List<WXUserGroup> getUserGroup() throws WXException<br/>int getUserInGroupId(String openId) throws WXException<br/>boolean updateUserGroup(int groupId, String groupName) throws WXException<br/>boolean moveUserToGroup(String openId, int groupId) throws WXException<br/>boolean moveBatchUserToGroup(List<String> openIdList, int groupId) throws WXException<br/>boolean deleteUseGroup(int groupId) throws WXException<br/> -
设置用户备注名<br/>
boolean remarkUser(String openId, String remark) throws WXException<br/> -
获取用户基本信息<br/>
WXUserInfoResponse getUserInfo(String openId, WXLang lang) throws WXException<br/>WXUserInfoListResponse getBatchUserInfo(WXUserList userList) throws WXException<br/> -
获取用户列表<br/>
WXUserGetResponse getUserList(String nextOpenId) throws WXException<br/>
#####自定义菜单接口<br/>
-
自定义菜单创建接口<br/>
boolean createMenu(Menu menu) throws WXException<br/> -
自定义菜单查询接口<br/>
WXMenuGetResponse getMenu() throws WXException<br/> -
自定义菜单删除接口<br/>
boolean deleteMenu() throws WXException<br/> -
获取自定义菜单配置接口<br/>
WXSelfMenuGetResponse getSelfMenu() throws WXException<br/>
#####账号管理接口<br/>
-
生成带参数的二维码<br/>
String createTempQrcode(long expireSeconds, int scenceId) throws WXException<br/>String createLimitSceneQrCode(int scenceId) throws WXException<br/>String createLimitStrSceneQrCode(String scenceStr) throws WXException<br/> -
长链接转短链接<br/>
String long2ShortUrl(String longUrl) throws WXException<br/>
#####数据统计接口<br/>
-
用户分析数据接口<br/>
List<UserSummaryItem> getUserSummaryDataCube(Date start, Date end) throws WXException<br/>List<UserCumulateItem> getUserCumulateDateCube(Date start, Date end) throws WXException<br/> -
图文分析数据接口<br/>
List<ArticleData> getArticleSummaryDataCube(Date start, Date end) throws WXException<br/>List<ArticleTotalData> getArticleTotalDataCube(Date start, Date end) throws WXException<br/>List<UserReadData> getArticleUserReadDataCube(Date start, Date end) throws WXException<br/>List<UserReadHourData> getArticleUserReadHourDataCube(Date start, Date end) throws WXException<br/>List<ArticleShareData> getArticleShareDataCube(Date start, Date end) throws WXException<br/>List<ArticleShareHourData> getArticleShareHourDataCube(Date start, Date end) throws WXException<br/> -
消息分析数据接口<br/>
List<UpstreamMsgData> getUpstreamMsgDataCube(Date start, Date end) throws WXException<br/>List<UpstreamMsgHourData> getUpstreamMsgHourDataCube(Date start, Date end) throws WXException<br/>List<UpstreamMsgData> getUpstreamMsgWeekDataCube(Date start, Date end) throws WXException<br/>List<UpstreamMsgData> getUpstreamMsgMonthDataCube(Date start, Date end) throws WXException<br/>List<UpstreamMsgDistData> getUpstreamMsgDistDataCube(Date start, Date end) throws WXException<br/>List<UpstreamMsgDistData> getUpstreamMsgDistWeekDataCube(Date start, Date end) throws WXException<br/>List<UpstreamMsgDistData> getUpstreamMsgDistMonthDataCube(Date start, Date end) throws WXException<br/> -
接口分析数据接口<br/>
List<InterfaceData> getInterfaceSummaryDataCube(Date start, Date end) throws WXException<br/>List<InterfaceHourData> getInterfaceHourSummaryDataCube(Date start, Date end) throws WXException<br/>
#####未实现的接口(持续实现中...)
- 客服账号管理<br/>
- 群发接口<br/>
- 获取自动回复规则接口<br/>
