public interface WxMpService extends WxService
String genShorten(String longData, Integer expireSeconds) throws WxErrorException
短key托管 类似于短链API. 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Account_Management/KEY_Shortener.html
longData - 需要转换的长信息,不超过4KBexpireSeconds - 短key有效期(单位秒),最大值为2592000(即30天),默认为2592000(30天)WxErrorException - 微信API调用异常WxMpShortKeyResult fetchShorten(String shortKey) throws WxErrorException
短key解析 将短key还原为长信息。 详情请见: https://developers.weixin.qq.com/doc/offiaccount/Account_Management/KEY_Shortener.html
shortKey - 短key,15字节,base62编码(0-9/a-z/A-Z)WxErrorException - 微信API调用异常boolean checkSignature(String timestamp, String nonce, String signature)
详情请见: <a href="http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421135319&token=&lang=zh_CN">接入指南</a>
timestamp - 时间戳,字符串格式nonce - 随机串,字符串格式signature - 签名,字符串格式String getAccessToken() throws WxErrorException
WxErrorException - 微信API调用异常获取access_token,可选择是否强制刷新String getAccessToken(boolean forceRefresh) throws WxErrorException
且在多线程同时刷新时只刷新一次,避免超出2000次/日的调用次数上限
另:本service的所有方法都会在access_token过期时调用此方法
程序员在非必要情况下尽量不要主动调用此方法
详情请见: <a href="http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183&token=&lang=zh_CN">获取access_token</a>
forceRefresh - 是否强制刷新,true表示强制刷新,false表示使用缓存WxErrorException - 微信API调用异常String getTicket(TicketType ticketType) throws WxErrorException
ticketType - ticket 类型,通过TicketType枚举指定WxErrorException - 微信API调用异常获得ticket,可选择是否强制刷新String getTicket(TicketType ticketType, boolean forceRefresh) throws WxErrorException
获得ticket. 获得时会检查 Token是否过期,如果过期了,那么就刷新一下,否则就什么都不干
ticketType - ticket类型,通过TicketType枚举指定forceRefresh - 强制刷新,true表示强制刷新,false表示使用缓存WxErrorException - 微信API调用异常String getJsapiTicket() throws WxErrorException
WxErrorException - 微信API调用异常获得jsapi_ticket,可选择是否强制刷新String getJsapiTicket(boolean forceRefresh) throws WxErrorException
获得时会检查jsapiToken是否过期,如果过期了,那么就刷新一下,否则就什么都不干
详情请见:<a href="http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN">JS-SDK使用权限签名算法</a>
forceRefresh - 强制刷新,true表示强制刷新,false表示使用缓存WxErrorException - 微信API调用异常WxJsapiSignature createJsapiSignature(String url) throws WxErrorException
详情请见:<a href="http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115&token=&lang=zh_CN">JS-SDK使用权限签名算法</a>
url - 当前网页的URL,不包括#及其后面部分WxErrorException - 微信API调用异常@Deprecated String shortUrl(String longUrl) throws WxErrorException
genShorten(String, Integer) 方法详情请见: 长链接转短链接接口
longUrl - 长url,需要转换的原始URLWxErrorException - 微信API调用异常WxMpSemanticQueryResult semanticQuery(WxMpSemanticQuery semanticQuery) throws WxErrorException
详情请见:语义理解
semanticQuery - 查询条件,包含查询内容、类型等信息WxErrorException - 微信API调用异常String buildQrConnectUrl(String redirectUri, String scope, String state)
详情请见: <a href="https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1419316505&token=&lang=zh_CN">网站应用微信登录开发指南</a>
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[] getCallbackIP() throws WxErrorException
WxErrorException - 微信API调用异常WxNetCheckResult netCheck(String action, String operator) throws WxErrorException
为了帮助开发者排查回调连接失败的问题,提供这个网络检测的API。它可以对开发者URL做域名解析,然后对所有IP进行一次ping操作,得到丢包率和耗时。
action - 执行的检测动作,可选值:all(全部检测)、dns(仅域名解析)、ping(仅网络连通性检测)operator - 指定平台从某个运营商进行检测,可选值:CHINANET(中国电信)、UNICOM(中国联通)、CAP(中国联通)、CUCC(中国联通)WxErrorException - 微信API调用异常WxMpCurrentAutoReplyInfo getCurrentAutoReplyInfo() throws WxErrorException
获取公众号的自动回复规则. https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Getting_Rules_for_Auto_Replies.html 开发者可以通过该接口,获取公众号当前使用的自动回复规则,包括关注后自动回复、消息自动回复(60分钟内触发一次)、关键词自动回复。 请注意: 1、第三方平台开发者可以通过本接口,在旗下公众号将业务授权给你后,立即通过本接口检测公众号的自动回复配置,并通过接口再次给公众号设置好自动回复规则,以提升公众号运营者的业务体验。 2、本接口仅能获取公众号在公众平台官网的自动回复功能中设置的自动回复规则,若公众号自行开发实现自动回复,或通过第三方平台开发者来实现,则无法获取。 3、认证/未认证的服务号/订阅号,以及接口测试号,均拥有该接口权限。 4、从第三方平台的公众号登录授权机制上来说,该接口从属于消息与菜单权限集。 5、本接口中返回的图片/语音/视频为临时素材(临时素材每次获取都不同,3天内有效,通过素材管理-获取临时素材接口来获取这些素材),本接口返回的图文消息为永久素材素材(通过素材管理-获取永久素材接口来获取这些素材)。 接口调用请求说明 http请求方式: GET(请使用https协议) https://api.weixin.qq.com/cgi-bin/get_current_autoreply_info?access_token=ACCESS_TOKEN
WxErrorException - 微信API调用异常void clearQuota(String appid) throws WxErrorException
HTTP调用:https://api.weixin.qq.com/cgi-bin/clear_quota?access_token=ACCESS_TOKEN
接口文档地址:https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433744592
appid - 公众号的APPID,需要清零调用的公众号的appidWxErrorException - 微信API调用异常<T,E> T execute(RequestExecutor<T,E> executor, String url, E data) throws WxErrorException
get(me.chanjar.weixin.mp.enums.WxMpApiUrl, java.lang.String)和post(me.chanjar.weixin.mp.enums.WxMpApiUrl, java.lang.String)方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
可以参考,MediaUploadRequestExecutor的实现方法T - 返回值类型E - 参数类型executor - 执行器,用于处理请求和响应url - 接口地址,字符串格式data - 参数数据,根据API不同可能是不同类型WxErrorException - 微信API调用异常String get(WxMpApiUrl url, String queryParam) throws WxErrorException
url - 请求接口地址,通过WxMpApiUrl枚举指定queryParam - 参数,字符串格式,通常是URL查询参数WxErrorException - 微信API调用异常String post(WxMpApiUrl url, String postData) throws WxErrorException
url - 请求接口地址,通过WxMpApiUrl枚举指定postData - 请求参数json值,字符串格式WxErrorException - 微信API调用异常String post(WxMpApiUrl url, Object obj) throws WxErrorException
url - 请求接口地址,通过WxMpApiUrl枚举指定obj - 请求参数,对象格式,会被序列化为JSONWxErrorException - 微信API调用异常String post(WxMpApiUrl url, com.google.gson.JsonObject jsonObject) throws WxErrorException
url - 请求接口地址,通过WxMpApiUrl枚举指定jsonObject - 请求参数json对象,JSON格式WxErrorException - 微信API调用异常<T,E> T execute(RequestExecutor<T,E> executor, WxMpApiUrl url, E data) throws WxErrorException
Service没有实现某个API的时候,可以用这个, 比get(me.chanjar.weixin.mp.enums.WxMpApiUrl, java.lang.String)和post(me.chanjar.weixin.mp.enums.WxMpApiUrl, java.lang.String)方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。 可以参考,MediaUploadRequestExecutor的实现方法
T - 返回值类型E - 参数类型executor - 执行器,用于处理请求和响应url - 接口地址,通过WxMpApiUrl枚举指定data - 参数数据,根据API不同可能是不同类型WxErrorException - 微信API调用异常void setRetrySleepMillis(int retrySleepMillis)
retrySleepMillis - 重试等待时间,单位毫秒,默认1000msvoid setMaxRetryTimes(int maxRetryTimes)
设置当微信系统响应系统繁忙时,最大重试次数. 默认:5次
maxRetryTimes - 最大重试次数,默认5次WxMpConfigStorage getWxMpConfigStorage()
void setWxMpConfigStorage(WxMpConfigStorage wxConfigProvider)
WxMpConfigStorage 的实现. 兼容老版本wxConfigProvider - 微信公众号配置存储对象void addConfigStorage(String mpId, WxMpConfigStorage configStorage)
WxMpConfigStorage,适用于动态添加新的微信公众号配置.mpId - 公众号id,用于标识不同的公众号configStorage - 新的微信配置,微信公众号配置存储对象void removeConfigStorage(String mpId)
mpId 所对应的 WxMpConfigStorage,适用于动态移除微信公众号配置.mpId - 对应公众号的标识,用于标识不同的公众号void setMultiConfigStorages(Map<String,WxMpConfigStorage> configStorages)
configStorages - WxMpConfigStorage map,公众号id到配置存储对象的映射void setMultiConfigStorages(Map<String,WxMpConfigStorage> configStorages, String defaultMpId)
configStorages - WxMpConfigStorage map,公众号id到配置存储对象的映射defaultMpId - 设置一个WxMpConfigStorage 所对应的mpId进行Http初始化boolean switchover(String mpId)
mpId - 公众号标识,用于标识不同的公众号boolean switchover(String mpId, java.util.function.Function<String,WxMpConfigStorage> func)
mpId - 公众号标识,用于标识不同的公众号func - 自定义配置获取函数,当配置不存在时使用WxMpService switchoverTo(String mpId)
mpId - 公众号标识,用于标识不同的公众号WxMpService switchoverTo(String mpId, java.util.function.Function<String,WxMpConfigStorage> func)
mpId - 公众号标识,用于标识不同的公众号func - 自定义配置获取函数,当配置不存在时使用WxMpKefuService getKefuService()
WxMpMaterialService getMaterialService()
WxMpMenuService getMenuService()
WxMpUserService getUserService()
WxMpUserTagService getUserTagService()
WxMpQrcodeService getQrcodeService()
WxMpCardService getCardService()
WxMpDataCubeService getDataCubeService()
WxMpUserBlacklistService getBlackListService()
WxMpStoreService getStoreService()
WxMpTemplateMsgService getTemplateMsgService()
WxMpSubscribeMsgService getSubscribeMsgService()
WxMpDeviceService getDeviceService()
WxMpShakeService getShakeService()
WxMpMemberCardService getMemberCardService()
WxMpMarketingService getMarketingService()
void initHttp()
RequestHttp<?,?> getRequestHttp()
WxMpMassMessageService getMassMessageService()
WxMpAiOpenService getAiOpenService()
WxMpWifiService getWifiService()
WxOcrService getOcrService()
WxImgProcService getImgProcService()
WxMpReimburseInvoiceService getReimburseInvoiceService()
WxMpDraftService getDraftService()
WxMpFreePublishService getFreePublishService()
void setReimburseInvoiceService(WxMpReimburseInvoiceService reimburseInvoiceService)
reimburseInvoiceService - 电子发票报销方服务接口void setKefuService(WxMpKefuService kefuService)
kefuService - 客服服务接口void setMaterialService(WxMpMaterialService materialService)
materialService - 素材服务接口void setMenuService(WxMpMenuService menuService)
menuService - 菜单服务接口void setUserService(WxMpUserService userService)
userService - 用户服务接口void setUserTagService(WxMpUserTagService userTagService)
userTagService - 用户标签服务接口void setQrcodeService(WxMpQrcodeService qrcodeService)
qrcodeService - 二维码服务接口void setCardService(WxMpCardService cardService)
cardService - 卡券服务接口void setStoreService(WxMpStoreService storeService)
storeService - 门店服务接口void setDataCubeService(WxMpDataCubeService dataCubeService)
dataCubeService - 数据分析服务接口void setBlackListService(WxMpUserBlacklistService blackListService)
blackListService - 用户黑名单服务接口void setTemplateMsgService(WxMpTemplateMsgService templateMsgService)
templateMsgService - 模板消息服务接口void setDeviceService(WxMpDeviceService deviceService)
deviceService - 硬件平台服务接口void setShakeService(WxMpShakeService shakeService)
shakeService - 摇一摇周边服务接口void setMemberCardService(WxMpMemberCardService memberCardService)
memberCardService - 会员卡服务接口void setMassMessageService(WxMpMassMessageService massMessageService)
massMessageService - 群发消息服务接口void setAiOpenService(WxMpAiOpenService aiOpenService)
aiOpenService - AI开放服务接口void setMarketingService(WxMpMarketingService marketingService)
marketingService - 营销服务接口void setOcrService(WxOcrService ocrService)
ocrService - OCR服务接口void setImgProcService(WxImgProcService imgProcService)
imgProcService - 图像处理服务接口WxMpCommentService getCommentService()
void setCommentService(WxMpCommentService commentService)
commentService - 评论数据管理服务接口WxOAuth2Service getOAuth2Service()
void setOAuth2Service(WxOAuth2Service oAuth2Service)
oAuth2Service - OAuth2服务接口WxMpGuideService getGuideService()
void setGuideService(WxMpGuideService guideService)
guideService - 微信导购服务接口WxMpGuideBuyerService getGuideBuyerService()
void setGuideBuyerService(WxMpGuideBuyerService guideBuyerService)
guideBuyerService - 微信导购买家服务接口WxMpGuideTagService getGuideTagService()
void setGuideTagService(WxMpGuideTagService guideTagService)
guideTagService - 微信导购标签服务接口WxMpGuideMaterialService getGuideMaterialService()
void setGuideMaterialService(WxMpGuideMaterialService guideMaterialService)
guideMaterialService - 微信导购素材服务接口WxMpGuideMassedJobService getGuideMassedJobService()
void setGuideMassedJobService(WxMpGuideMassedJobService guideMassedJobService)
guideMassedJobService - 微信导购批量任务服务接口WxMpMerchantInvoiceService getMerchantInvoiceService()
void setMerchantInvoiceService(WxMpMerchantInvoiceService merchantInvoiceService)
merchantInvoiceService - 微信商户发票服务接口void setDraftService(WxMpDraftService draftService)
draftService - 草稿箱服务接口void setFreePublishService(WxMpFreePublishService freePublishService)
freePublishService - 发布能力服务接口Copyright © 2026. All rights reserved.