me.chanjar.weixin.mp.api

类 WxMpServiceImpl

java.lang.Object

me.chanjar.weixin.mp.api.WxMpServiceImpl

所有已实现的接口:

WxMpService

public class WxMpServiceImpl
extends Object
implements WxMpService

字段概要

字段

限定符和类型	字段和说明
protected Object	globalAccessTokenRefreshLock 全局的是否正在刷新access token的锁
protected Object	globalJsapiTicketRefreshLock 全局的是否正在刷新jsapi_ticket的锁
protected org.apache.http.impl.client.CloseableHttpClient	httpClient
protected org.apache.http.HttpHost	httpProxy
protected org.slf4j.Logger	log
protected WxSessionManager	sessionManager
protected WxMpConfigStorage	wxMpConfigStorage

从接口继承的字段 me.chanjar.weixin.mp.api.WxMpService

SIMPLE_DATE_FORMAT

构造器概要

构造器

构造器和说明
WxMpServiceImpl()

方法概要

方法

限定符和类型	方法和说明
boolean	checkJSSDKCallbackDataSignature(Map<String,String> kvm, String signature) 计算Map键值对是否和签名相符, 按照字段名的 ASCII 码从小到大排序(字典序)后,使用 URL 键值对的 格式(即 key1=value1&key2=value2...)拼接成字符串
boolean	checkSignature(String timestamp, String nonce, String signature) 验证推送过来的消息的正确性 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxJsapiSignature	createJsapiSignature(String url) 创建调用jsapi时所需要的签名 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
void	customMessageSend(WxMpCustomMessage message) 发送客服消息 详情请见: http://mp.weixin.qq.com/wiki/index.php?
<T,E> T	execute(RequestExecutor<T,E> executor, String uri, E data) 向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求
protected <T,E> T	executeInternal(RequestExecutor<T,E> executor, String uri, E data)
String	get(String url, String queryParam) 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求
String	getAccessToken() 获取access_token, 不强制刷新access_token
String	getAccessToken(boolean forceRefresh) 获取access_token，本方法线程安全 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限 另：本service的所有方法都会在access_token过期是调用此方法 程序员在非必要情况下尽量不要主动调用此方法 详情请见: http://mp.weixin.qq.com/wiki/index.php?
String[]	getCallbackIP() 获取微信服务器IP地址 http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
protected org.apache.http.impl.client.CloseableHttpClient	getHttpclient()
String	getJsapiTicket() 获得jsapi_ticket,不强制刷新jsapi_ticket
String	getJsapiTicket(boolean forceRefresh) 获得jsapi_ticket 获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
WxMpPayCallback	getJSSDKCallbackData(String xmlData) 读取支付结果通知 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?
Map<String,String>	getJSSDKPayInfo(Map<String,String> parameters) 该接口调用“统一下单”接口，并拼装JSSDK发起支付请求需要的参数 详见http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E5.8F.91.E8.B5.B7.E4.B8.80.E4.B8.AA.E5.BE.AE.E4.BF.A1.E6.94.AF.E4.BB.98.E8.AF.B7.E6.B1.82
Map<String,String>	getJSSDKPayInfo(String openId, String outTradeNo, double amt, String body, String tradeType, String ip, String callbackUrl) 该接口调用“统一下单”接口，并拼装JSSDK发起支付请求需要的参数 详见http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E5.8F.91.E8.B5.B7.E4.B8.80.E4.B8.AA.E5.BE.AE.E4.BF.A1.E6.94.AF.E4.BB.98.E8.AF.B7.E6.B1.82
WxMpPayResult	getJSSDKPayResult(String transactionId, String outTradeNo) 该接口提供所有微信支付订单的查询,当支付通知处理异常戒丢失的情冴,商户可以通过该接口查询订单支付状态。
WxMpPrepayIdResult	getPrepayId(Map<String,String> parameters) 统一下单(详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?
WxMpPrepayIdResult	getPrepayId(String openId, String outTradeNo, double amt, String body, String tradeType, String ip, String callbackUrl) 统一下单(详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?
List<WxMpUserCumulate>	getUserCumulate(Date beginDate, Date endDate) 获取累计用户数据 http://mp.weixin.qq.com/wiki/3/ecfed6e1a0a03b5f35e5efac98e864b7.html
List<WxMpUserSummary>	getUserSummary(Date beginDate, Date endDate) 获取用户增减数据 http://mp.weixin.qq.com/wiki/3/ecfed6e1a0a03b5f35e5efac98e864b7.html
WxMpGroup	groupCreate(String name) 分组管理接口 - 创建分组 最多支持创建500个分组 详情请见: http://mp.weixin.qq.com/wiki/index.php?
List<WxMpGroup>	groupGet() 分组管理接口 - 查询所有分组 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	groupUpdate(WxMpGroup group) 分组管理接口 - 修改分组名 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpMassSendResult	massGroupMessageSend(WxMpMassGroupMessage message) 分组群发消息 如果发送图文消息，必须先使用 WxMpService.massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews) 获得media_id，然后再发送 如果发送视频消息，必须先使用 WxMpService.massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo) 获得media_id，然后再发送 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpMassUploadResult	massNewsUpload(WxMpMassNews news) 上传群发用的图文消息，上传后才能群发图文消息 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpMassSendResult	massOpenIdsMessageSend(WxMpMassOpenIdsMessage message) 按openId列表群发消息 如果发送图文消息，必须先使用 WxMpService.massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews) 获得media_id，然后再发送 如果发送视频消息，必须先使用 WxMpService.massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo) 获得media_id，然后再发送 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpMassUploadResult	massVideoUpload(WxMpMassVideo video) 上传群发用的视频，上传后才能群发视频消息 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpMaterialCountResult	materialCount() 获取各类素材总数 详情请见: http://mp.weixin.qq.com/wiki/16/8cc64f8c189674b421bee3ed403993b8.html
boolean	materialDelete(String media_id) 删除永久素材 详情请见: http://mp.weixin.qq.com/wiki/5/e66f61c303db51a6c0f90f46b15af5f5.html
WxMpMaterialFileBatchGetResult	materialFileBatchGet(String type, int offset, int count) 分页获取其他媒体素材列表 详情请见: http://mp.weixin.qq.com/wiki/12/2108cd7aafff7f388f41f37efa710204.html
WxMpMaterialUploadResult	materialFileUpload(String mediaType, WxMpMaterial material) 上传非图文永久素材 上传的多媒体文件有格式和大小限制，如下： 图片（image）: 图片大小不超过2M，支持bmp/png/jpeg/jpg/gif格式 语音（voice）：语音大小不超过5M，长度不超过60秒，支持mp3/wma/wav/amr格式 视频（video）：在上传视频素材时需要POST另一个表单，id为description，包含素材的描述信息，内容格式为JSON 缩略图（thumb）：文档未说明 详情请见: http://mp.weixin.qq.com/wiki/14/7e6c03263063f4813141c3e17dd4350a.html
InputStream	materialImageOrVoiceDownload(String media_id) 下载声音或者图片永久素材 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
WxMpMaterialNewsBatchGetResult	materialNewsBatchGet(int offset, int count) 分页获取图文素材列表 详情请见: http://mp.weixin.qq.com/wiki/12/2108cd7aafff7f388f41f37efa710204.html
WxMpMaterialNews	materialNewsInfo(String media_id) 获取图文永久素材的信息 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
boolean	materialNewsUpdate(WxMpMaterialArticleUpdate wxMpMaterialArticleUpdate) 更新图文永久素材 详情请见: http://mp.weixin.qq.com/wiki/4/19a59cba020d506e767360ca1be29450.html
WxMpMaterialUploadResult	materialNewsUpload(WxMpMaterialNews news) 上传永久图文素材 详情请见: http://mp.weixin.qq.com/wiki/14/7e6c03263063f4813141c3e17dd4350a.html
WxMpMaterialVideoInfoResult	materialVideoInfo(String media_id) 获取视频永久素材的信息和下载地址 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
File	mediaDownload(String media_id) 下载多媒体文件 根据微信文档，视频文件下载不了，会返回null 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMediaUploadResult	mediaUpload(String mediaType, File file)
WxMediaUploadResult	mediaUpload(String mediaType, String fileType, InputStream inputStream) 上传多媒体文件 上传的多媒体文件有格式和大小限制，如下： 图片（image）: 1M，支持JPG格式 语音（voice）：2M，播放长度不超过60s，支持AMR\MP3格式 视频（video）：10MB，支持MP4格式 缩略图（thumb）：64KB，支持JPG格式 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	menuCreate(WxMenu menu) 自定义菜单创建接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	menuDelete() 自定义菜单删除接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	menuDelete(String menuid) 删除个性化菜单接口 详情请见: http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
WxMenu	menuGet() 自定义菜单查询接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMenu	menuTryMatch(String userid) 测试个性化菜单匹配结果 详情请见: http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
String	oauth2buildAuthorizationUrl(String scope, String state) 构造oauth2授权的url连接 详情请见: http://mp.weixin.qq.com/wiki/index.php?
String	oauth2buildAuthorizationUrl(String redirectURI, String scope, String state) 构造oauth2授权的url连接 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpOAuth2AccessToken	oauth2getAccessToken(String code) 用code换取oauth2的access token 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpUser	oauth2getUserInfo(WxMpOAuth2AccessToken oAuth2AccessToken, String lang) 用oauth2获取用户信息, 当前面引导授权时的scope是snsapi_userinfo的时候才可以
WxMpOAuth2AccessToken	oauth2refreshAccessToken(String refreshToken) 刷新oauth2的access token
boolean	oauth2validateAccessToken(WxMpOAuth2AccessToken oAuth2AccessToken) 验证oauth2的access token是否有效
String	post(String url, String postData) 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求
WxMpQrCodeTicket	qrCodeCreateLastTicket(int scene_id) 换取永久二维码ticket 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpQrCodeTicket	qrCodeCreateLastTicket(String scene_str) 换取永久字符串二维码ticket 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpQrCodeTicket	qrCodeCreateTmpTicket(int scene_id, Integer expire_seconds) 换取临时二维码ticket 详情请见: http://mp.weixin.qq.com/wiki/index.php?
File	qrCodePicture(WxMpQrCodeTicket ticket) 换取二维码图片文件，jpg格式 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpSemanticQueryResult	semanticQuery(WxMpSemanticQuery semanticQuery) 语义查询接口 详情请见：http://mp.weixin.qq.com/wiki/index.php?
WxRedpackResult	sendRedpack(Map<String,String> parameters) 发送微信红包给个人用户
void	setMaxRetryTimes(int maxRetryTimes) 设置当微信系统响应系统繁忙时，最大重试次数 默认：5次
void	setRetrySleepMillis(int retrySleepMillis) 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试 默认：1000ms
void	setWxMpConfigStorage(WxMpConfigStorage wxConfigProvider) 注入 WxMpConfigStorage 的实现
String	shortUrl(String long_url) 长链接转短链接接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
String	templateSend(WxMpTemplateMessage templateMessage) 发送模板消息 详情请见: http://mp.weixin.qq.com/wiki/index.php?
long	userGetGroup(String openid) 分组管理接口 - 查询用户所在分组 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpUser	userInfo(String openid, String lang) 获取用户基本信息 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMpUserList	userList(String next_openid) 获取关注者列表 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	userUpdateGroup(String openid, long to_groupid) 分组管理接口 - 移动用户分组 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	userUpdateRemark(String openid, String remark) 设置用户备注名接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

log

protected final org.slf4j.Logger log

globalAccessTokenRefreshLock

protected final Object globalAccessTokenRefreshLock

全局的是否正在刷新access token的锁

globalJsapiTicketRefreshLock

protected final Object globalJsapiTicketRefreshLock

全局的是否正在刷新jsapi_ticket的锁

wxMpConfigStorage

protected WxMpConfigStorage wxMpConfigStorage

httpClient

protected org.apache.http.impl.client.CloseableHttpClient httpClient

httpProxy

protected org.apache.http.HttpHost httpProxy

sessionManager

protected WxSessionManager sessionManager

构造器详细资料

WxMpServiceImpl

public WxMpServiceImpl()

方法详细资料

checkSignature

public boolean checkSignature(String timestamp,
                     String nonce,
                     String signature)

从接口复制的说明: WxMpService

 验证推送过来的消息的正确性
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=验证消息真实性
 

指定者:

checkSignature 在接口中 WxMpService

返回:

getAccessToken

public String getAccessToken()
                      throws WxErrorException

从接口复制的说明: WxMpService

获取access_token, 不强制刷新access_token

指定者:

getAccessToken 在接口中 WxMpService

返回:

抛出:

WxErrorException

另请参阅:

WxMpService.getAccessToken(boolean)

getAccessToken

public String getAccessToken(boolean forceRefresh)
                      throws WxErrorException

从接口复制的说明: WxMpService

 获取access_token，本方法线程安全
 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限

 另：本service的所有方法都会在access_token过期是调用此方法

 程序员在非必要情况下尽量不要主动调用此方法

 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取access_token
 

指定者:

getAccessToken 在接口中 WxMpService

参数:

forceRefresh - 强制刷新

返回:

抛出:

WxErrorException

getJsapiTicket

public String getJsapiTicket()
                      throws WxErrorException

从接口复制的说明: WxMpService

获得jsapi_ticket,不强制刷新jsapi_ticket

指定者:

getJsapiTicket 在接口中 WxMpService

返回:

抛出:

WxErrorException

另请参阅:

WxMpService.getJsapiTicket(boolean)

getJsapiTicket

public String getJsapiTicket(boolean forceRefresh)
                      throws WxErrorException

从接口复制的说明: WxMpService

 获得jsapi_ticket
 获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干

 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
 

指定者:

getJsapiTicket 在接口中 WxMpService

参数:

forceRefresh - 强制刷新

返回:

抛出:

WxErrorException

createJsapiSignature

public WxJsapiSignature createJsapiSignature(String url)
                                      throws WxErrorException

从接口复制的说明: WxMpService

 创建调用jsapi时所需要的签名

 详情请见：http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E9.99.84.E5.BD.951-JS-SDK.E4.BD.BF.E7.94.A8.E6.9D.83.E9.99.90.E7.AD.BE.E5.90.8D.E7.AE.97.E6.B3.95
 

指定者:

createJsapiSignature 在接口中 WxMpService

参数:

url - url

返回:

抛出:

WxErrorException

customMessageSend

public void customMessageSend(WxMpCustomMessage message)
                       throws WxErrorException

从接口复制的说明: WxMpService

 发送客服消息
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
 

指定者:

customMessageSend 在接口中 WxMpService

抛出:

WxErrorException

menuCreate

public void menuCreate(WxMenu menu)
                throws WxErrorException

从接口复制的说明: WxMpService

 自定义菜单创建接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口
 如果要创建个性化菜单，请设置matchrule属性
 详情请见:http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
 

指定者:

menuCreate 在接口中 WxMpService

抛出:

WxErrorException

menuDelete

public void menuDelete()
                throws WxErrorException

从接口复制的说明: WxMpService

 自定义菜单删除接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口
 

指定者:

menuDelete 在接口中 WxMpService

抛出:

WxErrorException

menuDelete

public void menuDelete(String menuid)
                throws WxErrorException

从接口复制的说明: WxMpService

 删除个性化菜单接口
 详情请见: http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
 

指定者:

menuDelete 在接口中 WxMpService

抛出:

WxErrorException

menuGet

public WxMenu menuGet()
               throws WxErrorException

从接口复制的说明: WxMpService

 自定义菜单查询接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口
 

指定者:

menuGet 在接口中 WxMpService

返回:

抛出:

WxErrorException

menuTryMatch

public WxMenu menuTryMatch(String userid)
                    throws WxErrorException

从接口复制的说明: WxMpService

 测试个性化菜单匹配结果
 详情请见: http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
 

指定者:

menuTryMatch 在接口中 WxMpService

参数:

userid - 可以是粉丝的OpenID，也可以是粉丝的微信号。

抛出:

WxErrorException

mediaUpload

public WxMediaUploadResult mediaUpload(String mediaType,
                              String fileType,
                              InputStream inputStream)
                                throws WxErrorException,
                                       IOException

从接口复制的说明: WxMpService

 上传多媒体文件

 上传的多媒体文件有格式和大小限制，如下：
   图片（image）: 1M，支持JPG格式
   语音（voice）：2M，播放长度不超过60s，支持AMR\MP3格式
   视频（video）：10MB，支持MP4格式
   缩略图（thumb）：64KB，支持JPG格式

 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
 

指定者:

mediaUpload 在接口中 WxMpService

参数:

mediaType - 媒体类型, 请看WxConsts

fileType - 文件类型，请看WxConsts

inputStream - 输入流

抛出:

WxErrorException

IOException

mediaUpload

public WxMediaUploadResult mediaUpload(String mediaType,
                              File file)
                                throws WxErrorException

指定者:

mediaUpload 在接口中 WxMpService

抛出:

WxErrorException

另请参阅:

WxMpService.mediaUpload(String, String, InputStream)

mediaDownload

public File mediaDownload(String media_id)
                   throws WxErrorException

从接口复制的说明: WxMpService

 下载多媒体文件
 根据微信文档，视频文件下载不了，会返回null
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
 

指定者:

mediaDownload 在接口中 WxMpService

返回:

保存到本地的临时文件

抛出:

WxErrorException

materialFileUpload

public WxMpMaterialUploadResult materialFileUpload(String mediaType,
                                          WxMpMaterial material)
                                            throws WxErrorException

从接口复制的说明: WxMpService

 上传非图文永久素材

 上传的多媒体文件有格式和大小限制，如下：
   图片（image）: 图片大小不超过2M，支持bmp/png/jpeg/jpg/gif格式
   语音（voice）：语音大小不超过5M，长度不超过60秒，支持mp3/wma/wav/amr格式
   视频（video）：在上传视频素材时需要POST另一个表单，id为description，包含素材的描述信息，内容格式为JSON
   缩略图（thumb）：文档未说明

 详情请见: http://mp.weixin.qq.com/wiki/14/7e6c03263063f4813141c3e17dd4350a.html
 

指定者:

materialFileUpload 在接口中 WxMpService

参数:

mediaType - 媒体类型, 请看WxConsts

material - 上传的素材, 请看WxMpMaterial

返回:

抛出:

WxErrorException

materialNewsUpload

public WxMpMaterialUploadResult materialNewsUpload(WxMpMaterialNews news)
                                            throws WxErrorException

从接口复制的说明: WxMpService

 上传永久图文素材

 详情请见: http://mp.weixin.qq.com/wiki/14/7e6c03263063f4813141c3e17dd4350a.html
 

指定者:

materialNewsUpload 在接口中 WxMpService

参数:

news - 上传的图文消息, 请看WxMpMaterialNews

返回:

抛出:

WxErrorException

materialImageOrVoiceDownload

public InputStream materialImageOrVoiceDownload(String media_id)
                                         throws WxErrorException

从接口复制的说明: WxMpService

 下载声音或者图片永久素材

 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
 

指定者:

materialImageOrVoiceDownload 在接口中 WxMpService

参数:

media_id - 永久素材的id

返回:

抛出:

WxErrorException

materialVideoInfo

public WxMpMaterialVideoInfoResult materialVideoInfo(String media_id)
                                              throws WxErrorException

从接口复制的说明: WxMpService

 获取视频永久素材的信息和下载地址

 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
 

指定者:

materialVideoInfo 在接口中 WxMpService

参数:

media_id - 永久素材的id

返回:

抛出:

WxErrorException

materialNewsInfo

public WxMpMaterialNews materialNewsInfo(String media_id)
                                  throws WxErrorException

从接口复制的说明: WxMpService

 获取图文永久素材的信息

 详情请见: http://mp.weixin.qq.com/wiki/4/b3546879f07623cb30df9ca0e420a5d0.html
 

指定者:

materialNewsInfo 在接口中 WxMpService

参数:

media_id - 永久素材的id

返回:

抛出:

WxErrorException

materialNewsUpdate

public boolean materialNewsUpdate(WxMpMaterialArticleUpdate wxMpMaterialArticleUpdate)
                           throws WxErrorException

从接口复制的说明: WxMpService

 更新图文永久素材

 详情请见: http://mp.weixin.qq.com/wiki/4/19a59cba020d506e767360ca1be29450.html
 

指定者:

materialNewsUpdate 在接口中 WxMpService

参数:

wxMpMaterialArticleUpdate - 用来更新图文素材的bean, 请看WxMpMaterialArticleUpdate

返回:

抛出:

WxErrorException

materialDelete

public boolean materialDelete(String media_id)
                       throws WxErrorException

从接口复制的说明: WxMpService

 删除永久素材

 详情请见: http://mp.weixin.qq.com/wiki/5/e66f61c303db51a6c0f90f46b15af5f5.html
 

指定者:

materialDelete 在接口中 WxMpService

参数:

media_id - 永久素材的id

返回:

抛出:

WxErrorException

materialCount

public WxMpMaterialCountResult materialCount()
                                      throws WxErrorException

从接口复制的说明: WxMpService

 获取各类素材总数

 详情请见: http://mp.weixin.qq.com/wiki/16/8cc64f8c189674b421bee3ed403993b8.html
 

指定者:

materialCount 在接口中 WxMpService

返回:

抛出:

WxErrorException

materialNewsBatchGet

public WxMpMaterialNewsBatchGetResult materialNewsBatchGet(int offset,
                                                  int count)
                                                    throws WxErrorException

从接口复制的说明: WxMpService

 分页获取图文素材列表

 详情请见: http://mp.weixin.qq.com/wiki/12/2108cd7aafff7f388f41f37efa710204.html
 

指定者:

materialNewsBatchGet 在接口中 WxMpService

参数:

offset - 从全部素材的该偏移位置开始返回，0表示从第一个素材 返回

count - 返回素材的数量，取值在1到20之间

返回:

抛出:

WxErrorException

materialFileBatchGet

public WxMpMaterialFileBatchGetResult materialFileBatchGet(String type,
                                                  int offset,
                                                  int count)
                                                    throws WxErrorException

从接口复制的说明: WxMpService

 分页获取其他媒体素材列表

 详情请见: http://mp.weixin.qq.com/wiki/12/2108cd7aafff7f388f41f37efa710204.html
 

指定者:

materialFileBatchGet 在接口中 WxMpService

参数:

type - 媒体类型, 请看WxConsts

offset - 从全部素材的该偏移位置开始返回，0表示从第一个素材 返回

count - 返回素材的数量，取值在1到20之间

返回:

抛出:

WxErrorException

massNewsUpload

public WxMpMassUploadResult massNewsUpload(WxMpMassNews news)
                                    throws WxErrorException

从接口复制的说明: WxMpService

 上传群发用的图文消息，上传后才能群发图文消息

 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
 

指定者:

massNewsUpload 在接口中 WxMpService

抛出:

WxErrorException

另请参阅:

WxMpService.massGroupMessageSend(me.chanjar.weixin.mp.bean.WxMpMassGroupMessage), WxMpService.massOpenIdsMessageSend(me.chanjar.weixin.mp.bean.WxMpMassOpenIdsMessage)

massVideoUpload

public WxMpMassUploadResult massVideoUpload(WxMpMassVideo video)
                                     throws WxErrorException

从接口复制的说明: WxMpService

 上传群发用的视频，上传后才能群发视频消息
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
 

指定者:

massVideoUpload 在接口中 WxMpService

返回:

抛出:

WxErrorException

另请参阅:

WxMpService.massGroupMessageSend(me.chanjar.weixin.mp.bean.WxMpMassGroupMessage), WxMpService.massOpenIdsMessageSend(me.chanjar.weixin.mp.bean.WxMpMassOpenIdsMessage)

massGroupMessageSend

public WxMpMassSendResult massGroupMessageSend(WxMpMassGroupMessage message)
                                        throws WxErrorException

从接口复制的说明: WxMpService

 分组群发消息
 如果发送图文消息，必须先使用 WxMpService.massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews) 获得media_id，然后再发送
 如果发送视频消息，必须先使用 WxMpService.massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo) 获得media_id，然后再发送
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
 

指定者:

massGroupMessageSend 在接口中 WxMpService

返回:

抛出:

WxErrorException

massOpenIdsMessageSend

public WxMpMassSendResult massOpenIdsMessageSend(WxMpMassOpenIdsMessage message)
                                          throws WxErrorException

从接口复制的说明: WxMpService

 按openId列表群发消息
 如果发送图文消息，必须先使用 WxMpService.massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews) 获得media_id，然后再发送
 如果发送视频消息，必须先使用 WxMpService.massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo) 获得media_id，然后再发送
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
 

指定者:

massOpenIdsMessageSend 在接口中 WxMpService

返回:

抛出:

WxErrorException

groupCreate

public WxMpGroup groupCreate(String name)
                      throws WxErrorException

从接口复制的说明: WxMpService

 分组管理接口 - 创建分组
 最多支持创建500个分组
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
 

指定者:

groupCreate 在接口中 WxMpService

参数:

name - 分组名字（30个字符以内）

抛出:

WxErrorException

groupGet

public List<WxMpGroup> groupGet()
                         throws WxErrorException

从接口复制的说明: WxMpService

 分组管理接口 - 查询所有分组
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
 

指定者:

groupGet 在接口中 WxMpService

返回:

抛出:

WxErrorException

userGetGroup

public long userGetGroup(String openid)
                  throws WxErrorException

从接口复制的说明: WxMpService

 分组管理接口 - 查询用户所在分组
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
 

指定者:

userGetGroup 在接口中 WxMpService

参数:

openid - 微信用户的openid

抛出:

WxErrorException

groupUpdate

public void groupUpdate(WxMpGroup group)
                 throws WxErrorException

从接口复制的说明: WxMpService

 分组管理接口 - 修改分组名
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口

 如果id为0(未分组),1(黑名单),2(星标组)，或者不存在的id，微信会返回系统繁忙的错误
 

指定者:

groupUpdate 在接口中 WxMpService

参数:

group - 要更新的group，group的id,name必须设置

抛出:

WxErrorException

userUpdateGroup

public void userUpdateGroup(String openid,
                   long to_groupid)
                     throws WxErrorException

从接口复制的说明: WxMpService

 分组管理接口 - 移动用户分组
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口

 如果to_groupid为0(未分组),1(黑名单),2(星标组)，或者不存在的id，微信会返回系统繁忙的错误
 

指定者:

userUpdateGroup 在接口中 WxMpService

参数:

openid - 用户openid

to_groupid - 移动到的分组id

抛出:

WxErrorException

userUpdateRemark

public void userUpdateRemark(String openid,
                    String remark)
                      throws WxErrorException

从接口复制的说明: WxMpService

 设置用户备注名接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=设置用户备注名接口
 

指定者:

userUpdateRemark 在接口中 WxMpService

参数:

openid - 用户openid

remark - 备注名

抛出:

WxErrorException

userInfo

public WxMpUser userInfo(String openid,
                String lang)
                  throws WxErrorException

从接口复制的说明: WxMpService

 获取用户基本信息
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取用户基本信息
 

指定者:

userInfo 在接口中 WxMpService

参数:

openid - 用户openid

lang - 语言，zh_CN 简体(默认)，zh_TW 繁体，en 英语

返回:

抛出:

WxErrorException

userList

public WxMpUserList userList(String next_openid)
                      throws WxErrorException

从接口复制的说明: WxMpService

 获取关注者列表
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取关注者列表
 

指定者:

userList 在接口中 WxMpService

参数:

next_openid - 可选，第一个拉取的OPENID，null为从头开始拉取

返回:

抛出:

WxErrorException

qrCodeCreateTmpTicket

public WxMpQrCodeTicket qrCodeCreateTmpTicket(int scene_id,
                                     Integer expire_seconds)
                                       throws WxErrorException

从接口复制的说明: WxMpService

 换取临时二维码ticket
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
 

指定者:

qrCodeCreateTmpTicket 在接口中 WxMpService

参数:

scene_id - 参数。

expire_seconds - 过期秒数，默认60秒，最小60秒，最大1800秒

返回:

抛出:

WxErrorException

qrCodeCreateLastTicket

public WxMpQrCodeTicket qrCodeCreateLastTicket(int scene_id)
                                        throws WxErrorException

从接口复制的说明: WxMpService

 换取永久二维码ticket
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
 

指定者:

qrCodeCreateLastTicket 在接口中 WxMpService

参数:

scene_id - 参数。永久二维码时最大值为100000（目前参数只支持1--100000）

返回:

抛出:

WxErrorException

qrCodeCreateLastTicket

public WxMpQrCodeTicket qrCodeCreateLastTicket(String scene_str)
                                        throws WxErrorException

从接口复制的说明: WxMpService

 换取永久字符串二维码ticket
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
 

指定者:

qrCodeCreateLastTicket 在接口中 WxMpService

参数:

scene_str - 参数。字符串类型长度现在为1到64

返回:

抛出:

WxErrorException

qrCodePicture

public File qrCodePicture(WxMpQrCodeTicket ticket)
                   throws WxErrorException

从接口复制的说明: WxMpService

 换取二维码图片文件，jpg格式
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
 

指定者:

qrCodePicture 在接口中 WxMpService

参数:

ticket - 二维码ticket

返回:

抛出:

WxErrorException

shortUrl

public String shortUrl(String long_url)
                throws WxErrorException

从接口复制的说明: WxMpService

 长链接转短链接接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=长链接转短链接接口
 

指定者:

shortUrl 在接口中 WxMpService

返回:

抛出:

WxErrorException

templateSend

public String templateSend(WxMpTemplateMessage templateMessage)
                    throws WxErrorException

从接口复制的说明: WxMpService

 发送模板消息
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=模板消息接口
 

指定者:

templateSend 在接口中 WxMpService

返回:

msgid

抛出:

WxErrorException

semanticQuery

public WxMpSemanticQueryResult semanticQuery(WxMpSemanticQuery semanticQuery)
                                      throws WxErrorException

从接口复制的说明: WxMpService

 语义查询接口
 详情请见：http://mp.weixin.qq.com/wiki/index.php?title=语义理解
 

指定者:

semanticQuery 在接口中 WxMpService

返回:

抛出:

WxErrorException

oauth2buildAuthorizationUrl

public String oauth2buildAuthorizationUrl(String scope,
                                 String state)

从接口复制的说明: WxMpService

 构造oauth2授权的url连接
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息
 

指定者:

oauth2buildAuthorizationUrl 在接口中 WxMpService

返回:

url

oauth2buildAuthorizationUrl

public String oauth2buildAuthorizationUrl(String redirectURI,
                                 String scope,
                                 String state)

从接口复制的说明: WxMpService

 构造oauth2授权的url连接
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息
 

指定者:

oauth2buildAuthorizationUrl 在接口中 WxMpService

参数:

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

返回:

url

oauth2getAccessToken

public WxMpOAuth2AccessToken oauth2getAccessToken(String code)
                                           throws WxErrorException

从接口复制的说明: WxMpService

 用code换取oauth2的access token
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息
 

指定者:

oauth2getAccessToken 在接口中 WxMpService

返回:

抛出:

WxErrorException

oauth2refreshAccessToken

public WxMpOAuth2AccessToken oauth2refreshAccessToken(String refreshToken)
                                               throws WxErrorException

从接口复制的说明: WxMpService

 刷新oauth2的access token
 

指定者:

oauth2refreshAccessToken 在接口中 WxMpService

返回:

抛出:

WxErrorException

oauth2getUserInfo

public WxMpUser oauth2getUserInfo(WxMpOAuth2AccessToken oAuth2AccessToken,
                         String lang)
                           throws WxErrorException

从接口复制的说明: WxMpService

 用oauth2获取用户信息, 当前面引导授权时的scope是snsapi_userinfo的时候才可以
 

指定者:

oauth2getUserInfo 在接口中 WxMpService

lang - zh_CN, zh_TW, en

抛出:

WxErrorException

oauth2validateAccessToken

public boolean oauth2validateAccessToken(WxMpOAuth2AccessToken oAuth2AccessToken)

从接口复制的说明: WxMpService

 验证oauth2的access token是否有效
 

指定者:

oauth2validateAccessToken 在接口中 WxMpService

返回:

getCallbackIP

public String[] getCallbackIP()
                       throws WxErrorException

从接口复制的说明: WxMpService

 获取微信服务器IP地址
 http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
 

指定者:

getCallbackIP 在接口中 WxMpService

返回:

抛出:

WxErrorException

getUserSummary

public List<WxMpUserSummary> getUserSummary(Date beginDate,
                                   Date endDate)
                                     throws WxErrorException

从接口复制的说明: WxMpService

 获取用户增减数据
 http://mp.weixin.qq.com/wiki/3/ecfed6e1a0a03b5f35e5efac98e864b7.html
 

指定者:

getUserSummary 在接口中 WxMpService

参数:

beginDate - 最大时间跨度7天

endDate - endDate不能早于begingDate

返回:

抛出:

WxErrorException

getUserCumulate

public List<WxMpUserCumulate> getUserCumulate(Date beginDate,
                                     Date endDate)
                                       throws WxErrorException

从接口复制的说明: WxMpService

 获取累计用户数据
 http://mp.weixin.qq.com/wiki/3/ecfed6e1a0a03b5f35e5efac98e864b7.html
 

指定者:

getUserCumulate 在接口中 WxMpService

参数:

beginDate - 最大时间跨度7天

endDate - endDate不能早于begingDate

返回:

抛出:

WxErrorException

get

public String get(String url,
         String queryParam)
           throws WxErrorException

从接口复制的说明: WxMpService

当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求

指定者:

get 在接口中 WxMpService

返回:

抛出:

WxErrorException

post

public String post(String url,
          String postData)
            throws WxErrorException

从接口复制的说明: WxMpService

当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求

指定者:

post 在接口中 WxMpService

返回:

抛出:

WxErrorException

execute

public <T,E> T execute(RequestExecutor<T,E> executor,
              String uri,
              E data)
          throws WxErrorException

向微信端发送请求，在这里执行的策略是当发生access_token过期时才去刷新，然后重新执行请求，而不是全局定时请求

指定者:

execute 在接口中 WxMpService

参数:

executor -

uri -

data -

返回:

抛出:

WxErrorException

executeInternal

protected <T,E> T executeInternal(RequestExecutor<T,E> executor,
                      String uri,
                      E data)
                     throws WxErrorException

抛出:

WxErrorException

getHttpclient

protected org.apache.http.impl.client.CloseableHttpClient getHttpclient()

setWxMpConfigStorage

public void setWxMpConfigStorage(WxMpConfigStorage wxConfigProvider)

从接口复制的说明: WxMpService

注入 WxMpConfigStorage 的实现

指定者:

setWxMpConfigStorage 在接口中 WxMpService

setRetrySleepMillis

public void setRetrySleepMillis(int retrySleepMillis)

从接口复制的说明: WxMpService

 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试
 默认：1000ms
 

指定者:

setRetrySleepMillis 在接口中 WxMpService

setMaxRetryTimes

public void setMaxRetryTimes(int maxRetryTimes)

从接口复制的说明: WxMpService

 设置当微信系统响应系统繁忙时，最大重试次数
 默认：5次
 

指定者:

setMaxRetryTimes 在接口中 WxMpService

getPrepayId

public WxMpPrepayIdResult getPrepayId(String openId,
                             String outTradeNo,
                             double amt,
                             String body,
                             String tradeType,
                             String ip,
                             String callbackUrl)

从接口复制的说明: WxMpService

统一下单(详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1) 在发起微信支付前，需要调用统一下单接口，获取"预支付交易会话标识"

指定者:

getPrepayId 在接口中 WxMpService

参数:

openId - 支付人openId

outTradeNo - 商户端对应订单号

amt - 金额(单位元)

body - 商品描述

tradeType - 交易类型 JSAPI，NATIVE，APP，WAP

ip - 发起支付的客户端IP

callbackUrl - 通知地址

返回:

getPrepayId

public WxMpPrepayIdResult getPrepayId(Map<String,String> parameters)

从接口复制的说明: WxMpService

统一下单(详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1) 在发起微信支付前，需要调用统一下单接口，获取"预支付交易会话标识"

指定者:

getPrepayId 在接口中 WxMpService

参数:

parameters - All required/optional parameters for weixin payment

返回:

getJSSDKPayInfo

public Map<String,String> getJSSDKPayInfo(String openId,
                                 String outTradeNo,
                                 double amt,
                                 String body,
                                 String tradeType,
                                 String ip,
                                 String callbackUrl)

从接口复制的说明: WxMpService

该接口调用“统一下单”接口，并拼装JSSDK发起支付请求需要的参数 详见http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E5.8F.91.E8.B5.B7.E4.B8.80.E4.B8.AA.E5.BE.AE.E4.BF.A1.E6.94.AF.E4.BB.98.E8.AF.B7.E6.B1.82

指定者:

getJSSDKPayInfo 在接口中 WxMpService

参数:

openId - 支付人openId

outTradeNo - 商户端对应订单号

amt - 金额(单位元)

body - 商品描述

tradeType - 交易类型 JSAPI，NATIVE，APP，WAP

ip - 发起支付的客户端IP

callbackUrl - 通知地址

返回:

getJSSDKPayInfo

public Map<String,String> getJSSDKPayInfo(Map<String,String> parameters)

从接口复制的说明: WxMpService

该接口调用“统一下单”接口，并拼装JSSDK发起支付请求需要的参数 详见http://mp.weixin.qq.com/wiki/7/aaa137b55fb2e0456bf8dd9148dd613f.html#.E5.8F.91.E8.B5.B7.E4.B8.80.E4.B8.AA.E5.BE.AE.E4.BF.A1.E6.94.AF.E4.BB.98.E8.AF.B7.E6.B1.82

指定者:

getJSSDKPayInfo 在接口中 WxMpService

参数:

parameters - the required or optional parameters

返回:

getJSSDKPayResult

public WxMpPayResult getJSSDKPayResult(String transactionId,
                              String outTradeNo)

从接口复制的说明: WxMpService

该接口提供所有微信支付订单的查询,当支付通知处理异常戒丢失的情冴,商户可以通过该接口查询订单支付状态。 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_2

指定者:

getJSSDKPayResult 在接口中 WxMpService

getJSSDKCallbackData

public WxMpPayCallback getJSSDKCallbackData(String xmlData)

从接口复制的说明: WxMpService

读取支付结果通知 详见http://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_7

指定者:

getJSSDKCallbackData 在接口中 WxMpService

返回:

checkJSSDKCallbackDataSignature

public boolean checkJSSDKCallbackDataSignature(Map<String,String> kvm,
                                      String signature)

从接口复制的说明: WxMpService

 计算Map键值对是否和签名相符,
 按照字段名的 ASCII 码从小到大排序(字典序)后,使用 URL 键值对的 格式(即 key1=value1&key2=value2...)拼接成字符串
 

指定者:

checkJSSDKCallbackDataSignature 在接口中 WxMpService

返回:

sendRedpack

public WxRedpackResult sendRedpack(Map<String,String> parameters)
                            throws WxErrorException

从接口复制的说明: WxMpService

发送微信红包给个人用户

指定者:

sendRedpack 在接口中 WxMpService

返回:

抛出:

WxErrorException