public interface WxMpService
| 限定符和类型 | 字段和说明 |
|---|---|
static String |
CONNECT_OAUTH2_AUTHORIZE_URL
oauth2授权的url连接
|
static String |
GET_ACCESS_TOKEN_URL
获取access_token
|
static String |
GET_CALLBACK_IP_URL
获取微信服务器IP地址
|
static String |
GET_JSAPI_TICKET_URL
获得jsapi_ticket
|
static String |
MEDIA_UPLOAD_NEWS_URL
上传群发用的图文消息
|
static String |
MEDIA_UPLOAD_VIDEO_URL
上传群发用的视频
|
static String |
MESSAGE_MASS_PREVIEW_URL
群发消息预览接口
|
static String |
MESSAGE_MASS_SEND_URL
按openId列表群发消息
|
static String |
MESSAGE_MASS_SENDALL_URL
分组群发消息
|
static String |
OAUTH2_ACCESS_TOKEN_URL
用code换取oauth2的access token
|
static String |
OAUTH2_REFRESH_TOKEN_URL
刷新oauth2的access token
|
static String |
OAUTH2_USERINFO_URL
用oauth2获取用户信息
|
static String |
OAUTH2_VALIDATE_TOKEN_URL
验证oauth2的access token是否有效
|
static String |
QRCONNECT_URL
第三方使用网站应用授权登录的url
|
static String |
SEMANTIC_SEMPROXY_SEARCH_URL
语义查询接口
|
static String |
SHORTURL_API_URL
长链接转短链接接口
|
| 限定符和类型 | 方法和说明 | ||
|---|---|---|---|
String |
buildQrConnectUrl(String redirectURI,
String scope,
String state)
构造第三方使用网站应用授权登录的url
详情请见:
booleancheckSignature(String timestamp,
String nonce,
String signature)
验证消息的确来自微信服务器
详情请见: http://mp.weixin.qq.com/wiki?
| ||
WxJsapiSignature |
createJsapiSignature(String url)
创建调用jsapi时所需要的签名
详情请见：http://mp.weixin.qq.com/wiki?
|
||
<T,E> T |
execute(RequestExecutor<T,E> executor,
String uri,
E data)
Service没有实现某个API的时候，可以用这个，
比
get(java.lang.String, java.lang.String)和post(java.lang.String, java.lang.String)方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。 |
||
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?
|
||
WxMpUserBlacklistService |
getBlackListService()
返回用户黑名单管理相关接口方法的实现类对象，以方便调用其各个接口
|
||
String[] |
getCallbackIP()
获取微信服务器IP地址
http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
|
||
WxMpCardService |
getCardService()
返回卡券相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpDataCubeService |
getDataCubeService()
返回数据分析统计相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpDeviceService |
getDeviceService()
返回硬件平台相关接口方法的实现类对象，以方便调用其各个接口
|
||
String |
getJsapiTicket()
获得jsapi_ticket,不强制刷新jsapi_ticket
|
||
String |
getJsapiTicket(boolean forceRefresh)
获得jsapi_ticket
获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干
详情请见：http://mp.weixin.qq.com/wiki?
|
||
WxMpKefuService |
getKefuService()
返回客服接口方法实现类，以方便调用其各个接口
|
||
WxMpMaterialService |
getMaterialService()
返回素材相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpMenuService |
getMenuService()
返回菜单相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpQrcodeService |
getQrcodeService()
返回二维码相关接口方法的实现类对象，以方便调用其各个接口
|
||
RequestHttp |
getRequestHttp() |
||
WxMpShakeService |
getShakeService()
返回摇一摇周边相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpStoreService |
getStoreService()
返回门店管理相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpTemplateMsgService |
getTemplateMsgService()
返回模板消息相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpUserService |
getUserService()
返回用户相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpUserTagService |
getUserTagService()
返回用户标签相关接口方法的实现类对象，以方便调用其各个接口
|
||
WxMpConfigStorage |
getWxMpConfigStorage()
获取WxMpConfigStorage 对象
|
||
void |
initHttp()
初始化http请求对象
|
||
WxMpMassSendResult |
massGroupMessageSend(WxMpMassTagMessage message)
分组群发消息
如果发送图文消息，必须先使用
massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews) 获得media_id，然后再发送
如果发送视频消息，必须先使用 massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo) 获得media_id，然后再发送
详情请见: http://mp.weixin.qq.com/wiki? |
||
WxMpMassSendResult |
massMessagePreview(WxMpMassPreviewMessage wxMpMassPreviewMessage)
群发消息预览接口
开发者可通过该接口发送消息给指定用户，在手机端查看消息的样式和排版。
|
||
WxMpMassUploadResult |
massNewsUpload(WxMpMassNews news)
上传群发用的图文消息，上传后才能群发图文消息
详情请见: http://mp.weixin.qq.com/wiki?
|
||
WxMpMassSendResult |
massOpenIdsMessageSend(WxMpMassOpenIdsMessage message)
按openId列表群发消息
如果发送图文消息，必须先使用
massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews) 获得media_id，然后再发送
如果发送视频消息，必须先使用 massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo) 获得media_id，然后再发送
详情请见: http://mp.weixin.qq.com/wiki? |
||
WxMpMassUploadResult |
massVideoUpload(WxMpMassVideo video)
上传群发用的视频，上传后才能群发视频消息
详情请见: http://mp.weixin.qq.com/wiki?
|
||
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请求
|
||
WxMpSemanticQueryResult |
semanticQuery(WxMpSemanticQuery semanticQuery)
语义查询接口
详情请见：http://mp.weixin.qq.com/wiki/index.php?
|
||
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?
|
static final String OAUTH2_ACCESS_TOKEN_URL
static final String OAUTH2_REFRESH_TOKEN_URL
static final String OAUTH2_VALIDATE_TOKEN_URL
boolean checkSignature(String timestamp, String nonce, String signature)
验证消息的确来自微信服务器 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN
String getAccessToken() throws WxErrorException
WxErrorExceptiongetAccessToken(boolean)String getAccessToken(boolean forceRefresh) throws WxErrorException
获取access_token，本方法线程安全 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限 另：本service的所有方法都会在access_token过期是调用此方法 程序员在非必要情况下尽量不要主动调用此方法 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN
forceRefresh - 强制刷新WxErrorExceptionString getJsapiTicket() throws WxErrorException
WxErrorExceptiongetJsapiTicket(boolean)String getJsapiTicket(boolean forceRefresh) throws WxErrorException
获得jsapi_ticket 获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干 详情请见：http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
forceRefresh - 强制刷新WxErrorExceptionWxJsapiSignature createJsapiSignature(String url) throws WxErrorException
创建调用jsapi时所需要的签名 详情请见：http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN
WxErrorExceptionWxMpMassUploadResult massNewsUpload(WxMpMassNews news) throws WxErrorException
上传群发用的图文消息，上传后才能群发图文消息 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
WxMpMassUploadResult massVideoUpload(WxMpMassVideo video) throws WxErrorException
上传群发用的视频，上传后才能群发视频消息 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
WxMpMassSendResult massGroupMessageSend(WxMpMassTagMessage message) throws WxErrorException
分组群发消息 如果发送图文消息，必须先使用massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews)获得media_id，然后再发送 如果发送视频消息，必须先使用massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo)获得media_id，然后再发送 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
WxErrorExceptionWxMpMassSendResult massOpenIdsMessageSend(WxMpMassOpenIdsMessage message) throws WxErrorException
按openId列表群发消息 如果发送图文消息，必须先使用massNewsUpload(me.chanjar.weixin.mp.bean.WxMpMassNews)获得media_id，然后再发送 如果发送视频消息，必须先使用massVideoUpload(me.chanjar.weixin.mp.bean.WxMpMassVideo)获得media_id，然后再发送 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
WxErrorExceptionWxMpMassSendResult massMessagePreview(WxMpMassPreviewMessage wxMpMassPreviewMessage) throws Exception
群发消息预览接口 开发者可通过该接口发送消息给指定用户，在手机端查看消息的样式和排版。为了满足第三方平台开发者的需求，在保留对openID预览能力的同时，增加了对指定微信号发送预览的能力，但该能力每日调用次数有限制（100次），请勿滥用。 接口调用请求说明 http请求方式: POST https://api.weixin.qq.com/cgi-bin/message/mass/preview?access_token=ACCESS_TOKEN 详情请见：http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140549&token=&lang=zh_CN
ExceptionString shortUrl(String long_url) throws WxErrorException
长链接转短链接接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=长链接转短链接接口
WxErrorExceptionWxMpSemanticQueryResult semanticQuery(WxMpSemanticQuery semanticQuery) throws WxErrorException
语义查询接口 详情请见：http://mp.weixin.qq.com/wiki/index.php?title=语义理解
WxErrorExceptionString buildQrConnectUrl(String redirectURI, String scope, String state)
构造第三方使用网站应用授权登录的url 详情请见: 网站应用微信登录开发指南 URL格式为：https://open.weixin.qq.com/connect/qrconnect?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect
redirectURI - 用户授权完成后的重定向链接，无需urlencode, 方法内会进行encodescope - 应用授权作用域，拥有多个作用域用逗号（,）分隔，网页应用目前仅填写snsapi_login即可state - 非必填，用于保持请求和回调的状态，授权请求后原样带回给第三方。该参数可用于防止csrf攻击（跨站请求伪造攻击），建议第三方带上该参数，可设置为简单的随机数加session进行校验String oauth2buildAuthorizationUrl(String redirectURI, String scope, String state)
构造oauth2授权的url连接 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息
redirectURI - 用户授权完成后的重定向链接，无需urlencode, 方法内会进行encodeWxMpOAuth2AccessToken oauth2getAccessToken(String code) throws WxErrorException
用code换取oauth2的access token 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息
WxErrorExceptionWxMpOAuth2AccessToken oauth2refreshAccessToken(String refreshToken) throws WxErrorException
刷新oauth2的access token
WxErrorExceptionWxMpUser oauth2getUserInfo(WxMpOAuth2AccessToken oAuth2AccessToken, String lang) throws WxErrorException
用oauth2获取用户信息, 当前面引导授权时的scope是snsapi_userinfo的时候才可以
lang - zh_CN, zh_TW, enWxErrorExceptionboolean oauth2validateAccessToken(WxMpOAuth2AccessToken oAuth2AccessToken)
验证oauth2的access token是否有效
String[] getCallbackIP() throws WxErrorException
获取微信服务器IP地址 http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
WxErrorExceptionString get(String url, String queryParam) throws WxErrorException
WxErrorExceptionString post(String url, String postData) throws WxErrorException
WxErrorException<T,E> T execute(RequestExecutor<T,E> executor, String uri, E data) throws WxErrorException
Service没有实现某个API的时候，可以用这个， 比get(java.lang.String, java.lang.String)和post(java.lang.String, java.lang.String)方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。 可以参考，MediaUploadRequestExecutor的实现方法
WxErrorExceptionvoid setRetrySleepMillis(int retrySleepMillis)
设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试 默认：1000ms
void setMaxRetryTimes(int maxRetryTimes)
设置当微信系统响应系统繁忙时，最大重试次数 默认：5次
WxMpConfigStorage getWxMpConfigStorage()
void setWxMpConfigStorage(WxMpConfigStorage wxConfigProvider)
WxMpConfigStorage 的实现WxMpKefuService getKefuService()
WxMpMaterialService getMaterialService()
WxMpMenuService getMenuService()
WxMpUserService getUserService()
WxMpUserTagService getUserTagService()
WxMpQrcodeService getQrcodeService()
WxMpCardService getCardService()
WxMpDataCubeService getDataCubeService()
WxMpUserBlacklistService getBlackListService()
WxMpStoreService getStoreService()
WxMpTemplateMsgService getTemplateMsgService()
WxMpDeviceService getDeviceService()
WxMpShakeService getShakeService()
void initHttp()
RequestHttp getRequestHttp()
Copyright © 2017. All rights reserved.