me.chanjar.weixin.cp.api

接口 WxCpService

所有已知实现类:

BaseWxCpServiceImpl, WxCpServiceApacheHttpClientImpl, WxCpServiceImpl, WxCpServiceJoddHttpImpl, WxCpServiceOkHttpImpl, WxCpServiceOnTpImpl

public interface WxCpService

微信API的Service.

作者:

chanjaster

方法概要

限定符和类型	方法和说明
boolean	checkSignature(String msgSignature, String timestamp, String nonce, String data) 验证推送过来的消息的正确性 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxJsapiSignature	createJsapiSignature(String url) 创建调用jsapi时所需要的签名 详情请见：http://qydev.weixin.qq.com/wiki/index.php?
<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/index.php?
String	getAgentJsapiTicket() 获得jsapi_ticket,不强制刷新jsapi_ticket 应用的jsapi_ticket用于计算agentConfig（参见“通过agentConfig注入应用的权限”）的签名，签名计算方法与上述介绍的config的签名算法完全相同，但需要注意以下区别： 签名的jsapi_ticket必须使用以下接口获取。
String	getAgentJsapiTicket(boolean forceRefresh) 获取应用的jsapi_ticket 应用的jsapi_ticket用于计算agentConfig（参见“通过agentConfig注入应用的权限”）的签名，签名计算方法与上述介绍的config的签名算法完全相同，但需要注意以下区别： 签名的jsapi_ticket必须使用以下接口获取。
WxCpAgentService	getAgentService()
String[]	getCallbackIp() 获取微信服务器的ip段 http://qydev.weixin.qq.com/wiki/index.php?
WxCpChatService	getChatService() 获取群聊服务
WxCpDepartmentService	getDepartmentService() 获取部门相关接口的服务类对象
WxCpExternalContactService	getExternalContactService()
String	getJsapiTicket() 获得jsapi_ticket,不强制刷新jsapi_ticket
String	getJsapiTicket(boolean forceRefresh) 获得jsapi_ticket 获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干 详情请见：http://qydev.weixin.qq.com/wiki/index.php?
WxCpMediaService	getMediaService() 获取媒体相关接口的服务类对象
WxCpMenuService	getMenuService() 获取菜单相关接口的服务类对象
WxCpOaService	getOAService()
WxCpOAuth2Service	getOauth2Service() 获取Oauth2相关接口的服务类对象
WxCpProviderToken	getProviderToken(String corpId, String providerSecret) 获取服务商凭证 文档地址：https://work.weixin.qq.com/api/doc#90001/90143/91200 请求方式：POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/service/get_provider_token
RequestHttp<?,?>	getRequestHttp() http请求对象
WxSession	getSession(String id) 获取某个sessionId对应的session,如果sessionId没有对应的session，则新建一个并返回。
WxSession	getSession(String id, boolean create) 获取某个sessionId对应的session,如果sessionId没有对应的session，若create为true则新建一个，否则返回null。
WxSessionManager	getSessionManager() 获取WxSessionManager 对象
WxCpTagService	getTagService() 获取标签相关接口的服务类对象
WxCpTaskCardService	getTaskCardService() 获取任务卡片服务
String	getTaskResult(String joinId) 获取异步任务结果
WxCpUserService	getUserService() 获取用户相关接口的服务类对象
WxCpConfigStorage	getWxCpConfigStorage() 获取WxMpConfigStorage 对象
void	initHttp() 初始化http请求对象
WxCpMaJsCode2SessionResult	jsCode2Session(String jsCode) 小程序登录凭证校验
WxCpMessageSendResult	messageSend(WxCpMessage message) 发送消息 详情请见: http://qydev.weixin.qq.com/wiki/index.php?
String	post(String url, String postData) 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求
String	replaceParty(String mediaId) 上传部门列表覆盖企业号上的部门信息
String	replaceUser(String mediaId) 上传用户列表覆盖企业号上的用户信息
void	setDepartmentService(WxCpDepartmentService departmentService)
void	setMaxRetryTimes(int maxRetryTimes) 设置当微信系统响应系统繁忙时，最大重试次数 默认：5次
void	setMediaService(WxCpMediaService mediaService)
void	setMenuService(WxCpMenuService menuService)
void	setOauth2Service(WxCpOAuth2Service oauth2Service)
void	setRetrySleepMillis(int retrySleepMillis) 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试 默认：1000ms
void	setSessionManager(WxSessionManager sessionManager) 设置WxSessionManager，只有当需要使用个性化的WxSessionManager的时候才需要调用此方法， WxCpService默认使用的是StandardSessionManager
void	setTagService(WxCpTagService tagService)
void	setUserService(WxCpUserService userService)
void	setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider) 注入 WxCpConfigStorage 的实现

方法详细资料

checkSignature

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

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

参数:

msgSignature - 消息签名

timestamp - 时间戳

nonce - 随机数

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

getAccessToken

String getAccessToken()
               throws WxErrorException

获取access_token, 不强制刷新access_token

抛出:

WxErrorException

另请参阅:

getAccessToken(boolean)

getAccessToken

String getAccessToken(boolean forceRefresh)
               throws WxErrorException

 获取access_token，本方法线程安全
 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限
 另：本service的所有方法都会在access_token过期是调用此方法
 程序员在非必要情况下尽量不要主动调用此方法
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取access_token
 

参数:

forceRefresh - 强制刷新

抛出:

WxErrorException

getJsapiTicket

String getJsapiTicket()
               throws WxErrorException

获得jsapi_ticket,不强制刷新jsapi_ticket

抛出:

WxErrorException

另请参阅:

getJsapiTicket(boolean)

getJsapiTicket

String getJsapiTicket(boolean forceRefresh)
               throws WxErrorException

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

 详情请见：http://qydev.weixin.qq.com/wiki/index.php?title=微信JS接口#.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
 

参数:

forceRefresh - 强制刷新

抛出:

WxErrorException

getAgentJsapiTicket

String getAgentJsapiTicket()
                    throws WxErrorException

获得jsapi_ticket,不强制刷新jsapi_ticket 应用的jsapi_ticket用于计算agentConfig（参见“通过agentConfig注入应用的权限”）的签名，签名计算方法与上述介绍的config的签名算法完全相同，但需要注意以下区别：

签名的jsapi_ticket必须使用以下接口获取。且必须用wx.agentConfig中的agentid对应的应用secret去获取access_token。 签名用的noncestr和timestamp必须与wx.agentConfig中的nonceStr和timestamp相同。

抛出:

WxErrorException

另请参阅:

getJsapiTicket(boolean)

getAgentJsapiTicket

String getAgentJsapiTicket(boolean forceRefresh)
                    throws WxErrorException

 获取应用的jsapi_ticket
 应用的jsapi_ticket用于计算agentConfig（参见“通过agentConfig注入应用的权限”）的签名，签名计算方法与上述介绍的config的签名算法完全相同，但需要注意以下区别：

 签名的jsapi_ticket必须使用以下接口获取。且必须用wx.agentConfig中的agentid对应的应用secret去获取access_token。
 签名用的noncestr和timestamp必须与wx.agentConfig中的nonceStr和timestamp相同。

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

 详情请见：https://work.weixin.qq.com/api/doc#10029/%E8%8E%B7%E5%8F%96%E5%BA%94%E7%94%A8%E7%9A%84jsapi_ticket
 

参数:

forceRefresh - 强制刷新

抛出:

WxErrorException

createJsapiSignature

WxJsapiSignature createJsapiSignature(String url)
                               throws WxErrorException

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

 详情请见：http://qydev.weixin.qq.com/wiki/index.php?title=微信JS接口#.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
 

参数:

url - url

抛出:

WxErrorException

messageSend

WxCpMessageSendResult messageSend(WxCpMessage message)
                           throws WxErrorException

 发送消息
 详情请见: http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E
 

参数:

message - 要发送的消息对象

抛出:

WxErrorException

jsCode2Session

WxCpMaJsCode2SessionResult jsCode2Session(String jsCode)
                                   throws WxErrorException

小程序登录凭证校验

参数:

jsCode - 登录时获取的 code

抛出:

WxErrorException

getCallbackIp

String[] getCallbackIp()
                throws WxErrorException

 获取微信服务器的ip段
 http://qydev.weixin.qq.com/wiki/index.php?title=回调模式#.E8.8E.B7.E5.8F.96.E5.BE.AE.E4.BF.A1.E6.9C.8D.E5.8A.A1.E5.99.A8.E7.9A.84ip.E6.AE.B5
 

返回:

{ "ip_list": ["101.226.103.*", "101.226.62.*"] }

抛出:

WxErrorException

getProviderToken

WxCpProviderToken getProviderToken(String corpId,
                                   String providerSecret)
                            throws WxErrorException

 获取服务商凭证
 文档地址：https://work.weixin.qq.com/api/doc#90001/90143/91200
 请求方式：POST（HTTPS）
 请求地址： https://qyapi.weixin.qq.com/cgi-bin/service/get_provider_token
 

参数:

corpId - 服务商的corpid

providerSecret - 服务商的secret，在服务商管理后台可见

返回:

{ "errcode":0 , "errmsg":"ok" , "provider_access_token":"enLSZ5xxxxxxJRL", "expires_in":7200 }

抛出:

WxErrorException - .

get

String get(String url,
           String queryParam)
    throws WxErrorException

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

参数:

url - 接口地址

queryParam - 请求参数

抛出:

WxErrorException

post

String post(String url,
            String postData)
     throws WxErrorException

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

参数:

url - 接口地址

postData - 请求body字符串

抛出:

WxErrorException

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 - 参数

抛出:

WxErrorException

setRetrySleepMillis

void setRetrySleepMillis(int retrySleepMillis)

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

参数:

retrySleepMillis - 重试休息时间

setMaxRetryTimes

void setMaxRetryTimes(int maxRetryTimes)

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

参数:

maxRetryTimes - 最大重试次数

getSession

WxSession getSession(String id)

获取某个sessionId对应的session,如果sessionId没有对应的session，则新建一个并返回。

参数:

id - id可以为任意字符串，建议使用FromUserName作为id

getSession

WxSession getSession(String id,
                     boolean create)

获取某个sessionId对应的session,如果sessionId没有对应的session，若create为true则新建一个，否则返回null。

参数:

id - id可以为任意字符串，建议使用FromUserName作为id

create - 是否新建

getSessionManager

WxSessionManager getSessionManager()

获取WxSessionManager 对象

返回:

WxSessionManager

setSessionManager

void setSessionManager(WxSessionManager sessionManager)

 设置WxSessionManager，只有当需要使用个性化的WxSessionManager的时候才需要调用此方法，
 WxCpService默认使用的是StandardSessionManager
 

参数:

sessionManager - 会话管理器

replaceParty

String replaceParty(String mediaId)
             throws WxErrorException

上传部门列表覆盖企业号上的部门信息

参数:

mediaId - 媒体id

抛出:

WxErrorException

replaceUser

String replaceUser(String mediaId)
            throws WxErrorException

上传用户列表覆盖企业号上的用户信息

参数:

mediaId - 媒体id

抛出:

WxErrorException

getTaskResult

String getTaskResult(String joinId)
              throws WxErrorException

获取异步任务结果

抛出:

WxErrorException

initHttp

void initHttp()

初始化http请求对象

getWxCpConfigStorage

WxCpConfigStorage getWxCpConfigStorage()

获取WxMpConfigStorage 对象

返回:

WxMpConfigStorage

setWxCpConfigStorage

void setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider)

注入 WxCpConfigStorage 的实现

参数:

wxConfigProvider - 配置对象

getDepartmentService

WxCpDepartmentService getDepartmentService()

获取部门相关接口的服务类对象

getMediaService

WxCpMediaService getMediaService()

获取媒体相关接口的服务类对象

getMenuService

WxCpMenuService getMenuService()

获取菜单相关接口的服务类对象

getOauth2Service

WxCpOAuth2Service getOauth2Service()

获取Oauth2相关接口的服务类对象

getTagService

WxCpTagService getTagService()

获取标签相关接口的服务类对象

getUserService

WxCpUserService getUserService()

获取用户相关接口的服务类对象

getExternalContactService

WxCpExternalContactService getExternalContactService()

getChatService

WxCpChatService getChatService()

获取群聊服务

返回:

群聊服务

getTaskCardService

WxCpTaskCardService getTaskCardService()

获取任务卡片服务

返回:

任务卡片服务

getAgentService

WxCpAgentService getAgentService()

getOAService

WxCpOaService getOAService()

getRequestHttp

RequestHttp<?,?> getRequestHttp()

http请求对象

setUserService

void setUserService(WxCpUserService userService)

setDepartmentService

void setDepartmentService(WxCpDepartmentService departmentService)

setMediaService

void setMediaService(WxCpMediaService mediaService)

setMenuService

void setMenuService(WxCpMenuService menuService)

setOauth2Service

void setOauth2Service(WxCpOAuth2Service oauth2Service)

setTagService

void setTagService(WxCpTagService tagService)