me.chanjar.weixin.cp.tp.service

接口 WxCpTpService

所有已知实现类:

BaseWxCpTpServiceImpl, WxCpTpServiceApacheHttpClientImpl, WxCpTpServiceImpl

public interface WxCpTpService

企业微信第三方应用API的Service.

作者:

zhenjun cai

方法概要

限定符和类型	方法和说明
boolean	checkSignature(String msgSignature, String timestamp, String nonce, String data) 验证推送过来的消息的正确性 详情请见: https://work.weixin.qq.com/api/doc#90000/90139/90968/消息体签名校验
<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	getAuthCorpJsApiTicket(String authCorpId) 获取授权企业的 jsapi ticket
WxCpTpAuthInfo	getAuthInfo(String authCorpId, String permanentCode) 获取企业的授权信息
WxAccessToken	getCorpToken(String authCorpid, String permanentCode) 获取企业凭证
WxCpTpCorp	getPermanentCode(String authCode) 已过时。
WxCpTpPermanentCodeInfo	getPermanentCodeInfo(String authCode) 获取企业永久授权码信息 原来的方法实现不全
String	getPreAuthUrl(String redirectUri, String state) 获取预授权链接
String	getPreAuthUrl(String redirectUri, String state, int authType) 获取预授权链接，测试环境下使用
RequestHttp<?,?>	getRequestHttp() http请求对象.
WxSessionManager	getSessionManager() 获取WxSessionManager 对象
String	getSuiteAccessToken() 获取suite_access_token, 不强制刷新suite_access_token
String	getSuiteAccessToken(boolean forceRefresh) 获取suite_access_token，本方法线程安全 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限 另：本service的所有方法都会在suite_access_token过期是调用此方法 程序员在非必要情况下尽量不要主动调用此方法 详情请见: https://work.weixin.qq.com/api/doc#90001/90143/90600
String	getSuiteJsApiTicket(String authCorpId) 获取应用的 jsapi ticket
String	getSuiteTicket() 获得suite_ticket,不强制刷新suite_ticket
String	getSuiteTicket(boolean forceRefresh) 已过时。
WxCpTpUserDetail	getUserDetail3rd(String userTicket) 获取访问用户敏感信息
WxCpTpUserInfo	getUserInfo3rd(String code) 获取访问用户身份
WxCpTpConfigStorage	getWxCpTpConfigStorage() 已过时。
void	initHttp() 初始化http请求对象
WxCpMaJsCode2SessionResult	jsCode2Session(String jsCode) 小程序登录凭证校验
String	post(String url, String postData) 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求.
void	setMaxRetryTimes(int maxRetryTimes) 设置当微信系统响应系统繁忙时，最大重试次数.
void	setRetrySleepMillis(int retrySleepMillis) 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试.
void	setSuiteTicket(String suiteTicket) 保存企业微信定时推送的suite_ticket,（每10分钟） 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628 注意：微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟 https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
void	setSuiteTicket(String suiteTicket, int expiresInSeconds) 保存企业微信定时推送的suite_ticket,（每10分钟） 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628 注意：微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟 https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
void	setWxCpTpConfigStorage(WxCpTpConfigStorage wxConfigProvider) 注入 WxCpTpConfigStorage 的实现.

方法详细资料

checkSignature

boolean checkSignature(String msgSignature,
                       String timestamp,
                       String nonce,
                       String data)

 验证推送过来的消息的正确性
 详情请见: https://work.weixin.qq.com/api/doc#90000/90139/90968/消息体签名校验
 

参数:

msgSignature - 消息签名

timestamp - 时间戳

nonce - 随机数

data - 微信传输过来的数据，有可能是echoStr，有可能是xml消息

返回:

the boolean

getSuiteAccessToken

String getSuiteAccessToken()
                    throws WxErrorException

获取suite_access_token, 不强制刷新suite_access_token

返回:

the suite access token

抛出:

WxErrorException - the wx error exception

另请参阅:

#getSuiteAccessToken(boolean)

getSuiteAccessToken

String getSuiteAccessToken(boolean forceRefresh)
                    throws WxErrorException

 获取suite_access_token，本方法线程安全
 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限
 另：本service的所有方法都会在suite_access_token过期是调用此方法
 程序员在非必要情况下尽量不要主动调用此方法
 详情请见: https://work.weixin.qq.com/api/doc#90001/90143/90600
 

参数:

forceRefresh - 强制刷新

返回:

the suite access token

抛出:

WxErrorException - the wx error exception

getSuiteTicket

String getSuiteTicket()
               throws WxErrorException

获得suite_ticket,不强制刷新suite_ticket

返回:

the suite ticket

抛出:

WxErrorException - the wx error exception

另请参阅:

#getSuiteTicket(boolean)

getSuiteTicket

@Deprecated
String getSuiteTicket(boolean forceRefresh)
                            throws WxErrorException

已过时。

 获得suite_ticket
 由于suite_ticket是微信服务器定时推送（每10分钟），不能主动获取，如果碰到过期只能抛异常

 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628
 

参数:

forceRefresh - 强制刷新

返回:

the suite ticket

抛出:

WxErrorException - the wx error exception

另请参阅:

setSuiteTicket(String)

setSuiteTicket

void setSuiteTicket(String suiteTicket)

 保存企业微信定时推送的suite_ticket,（每10分钟）
 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628

 注意：微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟
 https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
 

参数:

suiteTicket -

setSuiteTicket

void setSuiteTicket(String suiteTicket,
                    int expiresInSeconds)

 保存企业微信定时推送的suite_ticket,（每10分钟）
 详情请见：https://work.weixin.qq.com/api/doc#90001/90143/90628

 注意：微信不是固定10分钟推送suite_ticket的, 且suite_ticket的有效期为30分钟
 https://work.weixin.qq.com/api/doc/10975#%E8%8E%B7%E5%8F%96%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E5%87%AD%E8%AF%81
 

参数:

suiteTicket -

expiresInSeconds -

getSuiteJsApiTicket

String getSuiteJsApiTicket(String authCorpId)
                    throws WxErrorException

获取应用的 jsapi ticket

参数:

authCorpId - 授权企业的cropId

返回:

jsapi ticket

抛出:

WxErrorException

jsCode2Session

WxCpMaJsCode2SessionResult jsCode2Session(String jsCode)
                                   throws WxErrorException

小程序登录凭证校验

参数:

jsCode - 登录时获取的 code

返回:

the wx cp ma js code 2 session result

抛出:

WxErrorException - the wx error exception

getCorpToken

WxAccessToken getCorpToken(String authCorpid,
                           String permanentCode)
                    throws WxErrorException

获取企业凭证

参数:

authCorpid - 授权方corpid

permanentCode - 永久授权码，通过get_permanent_code获取

返回:

the corp token

抛出:

WxErrorException - the wx error exception

getPermanentCode

@Deprecated
WxCpTpCorp getPermanentCode(String authCode)
                                  throws WxErrorException

已过时。

获取企业永久授权码 .

参数:

authCode - .

返回:

. permanent code

抛出:

WxErrorException - the wx error exception

getPermanentCodeInfo

WxCpTpPermanentCodeInfo getPermanentCodeInfo(String authCode)
                                      throws WxErrorException

获取企业永久授权码信息

   原来的方法实现不全
 

参数:

authCode - the auth code

返回:

permanent code info

抛出:

WxErrorException - the wx error exception

从以下版本开始:

2020 -03-18

getPreAuthUrl

String getPreAuthUrl(String redirectUri,
                     String state)
              throws WxErrorException

   获取预授权链接
 

参数:

redirectUri - 授权完成后的回调网址

state - a-zA-Z0-9的参数值（不超过128个字节），用于第三方自行校验session，防止跨域攻击

返回:

pre auth url

抛出:

WxErrorException - the wx error exception

getPreAuthUrl

String getPreAuthUrl(String redirectUri,
                     String state,
                     int authType)
              throws WxErrorException

   获取预授权链接，测试环境下使用

参数:

redirectUri - 授权完成后的回调网址

state - a-zA-Z0-9的参数值（不超过128个字节），用于第三方自行校验session，防止跨域攻击

authType - 授权类型：0 正式授权， 1 测试授权。

返回:

pre auth url

抛出:

WxErrorException - the wx error exception

getAuthInfo

WxCpTpAuthInfo getAuthInfo(String authCorpId,
                           String permanentCode)
                    throws WxErrorException

获取企业的授权信息

参数:

authCorpId - 授权企业的corpId

permanentCode - 授权企业的永久授权码

返回:

auth info

抛出:

WxErrorException - the wx error exception

getAuthCorpJsApiTicket

String getAuthCorpJsApiTicket(String authCorpId)
                       throws WxErrorException

获取授权企业的 jsapi ticket

参数:

authCorpId - 授权企业的cropId

返回:

jsapi ticket

抛出:

WxErrorException

get

String get(String url,
           String queryParam)
    throws WxErrorException

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

参数:

url - 接口地址

queryParam - 请求参数

返回:

the string

抛出:

WxErrorException - the wx error exception

post

String post(String url,
            String postData)
     throws WxErrorException

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

参数:

url - 接口地址

postData - 请求body字符串

返回:

the string

抛出:

WxErrorException - the wx error exception

execute

<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的实现方法
 

类型参数:

T - 请求值类型

E - 返回值类型

参数:

executor - 执行器

uri - 请求地址

data - 参数

返回:

the t

抛出:

WxErrorException - the wx error exception

setRetrySleepMillis

void setRetrySleepMillis(int retrySleepMillis)

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

参数:

retrySleepMillis - 重试休息时间

setMaxRetryTimes

void setMaxRetryTimes(int maxRetryTimes)

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

参数:

maxRetryTimes - 最大重试次数

initHttp

void initHttp()

初始化http请求对象

getWxCpTpConfigStorage

@Deprecated
WxCpTpConfigStorage getWxCpTpConfigStorage()

已过时。

获取WxMpConfigStorage 对象.

返回:

WxMpConfigStorage wx cp tp config storage

setWxCpTpConfigStorage

void setWxCpTpConfigStorage(WxCpTpConfigStorage wxConfigProvider)

注入 WxCpTpConfigStorage 的实现.

参数:

wxConfigProvider - 配置对象

getRequestHttp

RequestHttp<?,?> getRequestHttp()

http请求对象.

返回:

the request http

getSessionManager

WxSessionManager getSessionManager()

获取WxSessionManager 对象

返回:

WxSessionManager session manager

getUserInfo3rd

WxCpTpUserInfo getUserInfo3rd(String code)
                       throws WxErrorException

 获取访问用户身份
 

参数:

code -

返回:

抛出:

WxErrorException

getUserDetail3rd

WxCpTpUserDetail getUserDetail3rd(String userTicket)
                           throws WxErrorException

 获取访问用户敏感信息
 

参数:

userTicket -

返回:

抛出:

WxErrorException