public interface WxCpService extends WxService
限定符和类型 | 方法和说明 |
---|---|
String |
buildQrConnectUrl(String redirectUri,
String state)
构造扫码登录链接 - 构造独立窗口登录二维码
|
boolean |
checkSignature(String msgSignature,
String timestamp,
String nonce,
String data)
验证推送过来的消息的正确性
详情请见: http://mp.weixin.qq.com/wiki/index.php?
|
WxCpAgentJsapiSignature |
createAgentJsapiSignature(String url)
创建调用wx.agentConfig时所需要的签名
详情请见:https://open.work.weixin.qq.com/api/doc/90000/90136/94313
|
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的时候,可以用这个,
比
WxService.get(java.lang.String, java.lang.String) 和WxService.post(java.lang.String, java.lang.String) 方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。 |
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()
Gets agent service.
|
String[] |
getCallbackIp()
获取微信服务器的ip段
http://qydev.weixin.qq.com/wiki/index.php?
|
WxCpChatService |
getChatService()
获取群聊服务
|
WxCpDepartmentService |
getDepartmentService()
获取部门相关接口的服务类对象
|
WxCpExportService |
getExportService()
获取异步导出服务
|
WxCpExternalContactService |
getExternalContactService()
Gets external contact service.
|
WxCpGroupRobotService |
getGroupRobotService()
获取群机器人消息推送服务
|
String |
getJsapiTicket()
获得jsapi_ticket,不强制刷新jsapi_ticket
|
String |
getJsapiTicket(boolean forceRefresh)
获得jsapi_ticket
获得时会检查jsapiToken是否过期,如果过期了,那么就刷新一下,否则就什么都不干
详情请见:http://qydev.weixin.qq.com/wiki/index.php?
|
WxCpKfService |
getKfService()
获取微信客服服务
|
WxCpLivingService |
getLivingService()
获取直播相关接口的服务类对象
|
WxCpMediaService |
getMediaService()
获取媒体相关接口的服务类对象
|
WxCpMenuService |
getMenuService()
获取菜单相关接口的服务类对象
|
WxCpMessageService |
getMessageService()
Gets message service.
|
WxCpMsgAuditService |
getMsgAuditService()
获取会话存档相关接口的服务类对象
|
WxCpOaAgentService |
getOaAgentService()
获取OA 自建应用相关接口的服务类对象
|
WxCpOaCalendarService |
getOaCalendarService()
获取日历相关接口的服务类对象
|
WxCpOaMeetingRoomService |
getOaMeetingRoomService()
获取会议室相关接口的服务类对象
|
WxCpOaScheduleService |
getOaScheduleService()
获取日程相关接口的服务类对象
|
WxCpOaService |
getOaService()
获取OA相关接口的服务类对象.
|
WxCpOAuth2Service |
getOauth2Service()
获取Oauth2相关接口的服务类对象
|
WxCpOaWeDriveService |
getOaWeDriveService()
获取OA效率工具 微盘的服务类对象
|
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请求对象
|
WxCpSchoolHealthService |
getSchoolHealthService()
获取家校应用健康上报的服务类对象
|
WxCpSchoolService |
getSchoolService()
获取家校应用复学码相关接口的服务类对象
|
WxCpSchoolUserService |
getSchoolUserService()
获取家校沟通相关接口的服务类对象
|
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 jobId)
获取异步任务结果
|
WxCpUserService |
getUserService()
获取用户相关接口的服务类对象
|
WxCpAgentWorkBenchService |
getWorkBenchService()
获取工作台服务
|
WxCpConfigStorage |
getWxCpConfigStorage()
获取WxCpConfigStorage 对象
|
void |
initHttp()
初始化http请求对象
|
WxCpMaJsCode2SessionResult |
jsCode2Session(String jsCode)
小程序登录凭证校验
|
String |
postWithoutToken(String url,
String postData)
当不需要自动带accessToken的时候,可以用这个发起post请求
|
String |
replaceParty(String mediaId)
上传部门列表覆盖企业号上的部门信息
|
String |
replaceUser(String mediaId)
上传用户列表覆盖企业号上的用户信息
|
void |
setDepartmentService(WxCpDepartmentService departmentService)
Sets department service.
|
void |
setExportService(WxCpExportService exportService)
设置异步导出服务
|
void |
setKfService(WxCpKfService kfService)
Sets kf service.
|
void |
setMaxRetryTimes(int maxRetryTimes)
设置当微信系统响应系统繁忙时,最大重试次数
默认:5次
|
void |
setMediaService(WxCpMediaService mediaService)
Sets media service.
|
void |
setMenuService(WxCpMenuService menuService)
Sets menu service.
|
void |
setOauth2Service(WxCpOAuth2Service oauth2Service)
Sets oauth 2 service.
|
void |
setRetrySleepMillis(int retrySleepMillis)
设置当微信系统响应系统繁忙时,要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试
默认:1000ms
|
void |
setSessionManager(WxSessionManager sessionManager)
设置WxSessionManager,只有当需要使用个性化的WxSessionManager的时候才需要调用此方法,
WxCpService默认使用的是
StandardSessionManager
|
void |
setTagService(WxCpTagService tagService)
Sets tag service.
|
void |
setUserService(WxCpUserService userService)
Sets user service.
|
void |
setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider)
注入
WxCpConfigStorage 的实现 |
String |
syncUser(String mediaId)
上传用户列表,增量更新成员
|
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消息String getAccessToken() throws WxErrorException
WxErrorException
- the wx error exception#getAccessToken(boolean)#getAccessToken(boolean)
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
- the wx error exceptionString getJsapiTicket() throws WxErrorException
WxErrorException
- the wx error exception#getJsapiTicket(boolean)#getJsapiTicket(boolean)
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
- the wx error exceptionString getAgentJsapiTicket() throws WxErrorException
签名的jsapi_ticket必须使用以下接口获取。且必须用wx.agentConfig中的agentid对应的应用secret去获取access_token。 签名用的noncestr和timestamp必须与wx.agentConfig中的nonceStr和timestamp相同。
WxErrorException
- the wx error exception#getJsapiTicket(boolean)#getJsapiTicket(boolean)
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
- the wx error exceptionWxJsapiSignature 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
- urlWxErrorException
- the wx error exceptionWxCpAgentJsapiSignature createAgentJsapiSignature(String url) throws WxErrorException
创建调用wx.agentConfig时所需要的签名 详情请见:https://open.work.weixin.qq.com/api/doc/90000/90136/94313
url
- urlWxErrorException
WxCpMaJsCode2SessionResult jsCode2Session(String jsCode) throws WxErrorException
jsCode
- 登录时获取的 codeWxErrorException
- the wx error exceptionString[] 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
WxErrorException
- the wx error exceptionWxCpProviderToken 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
- 服务商的corpidproviderSecret
- 服务商的secret,在服务商管理后台可见WxErrorException
- .String postWithoutToken(String url, String postData) throws WxErrorException
url
- 接口地址postData
- 请求body字符串WxErrorException
- the wx error exception<T,E> T execute(RequestExecutor<T,E> executor, String uri, E data) throws WxErrorException
Service没有实现某个API的时候,可以用这个, 比WxService.get(java.lang.String, java.lang.String)
和WxService.post(java.lang.String, java.lang.String)
方法更灵活,可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。 可以参考,MediaUploadRequestExecutor
的实现方法
T
- 请求值类型E
- 返回值类型executor
- 执行器uri
- 请求地址data
- 参数WxErrorException
- the wx error exceptionvoid setRetrySleepMillis(int retrySleepMillis)
设置当微信系统响应系统繁忙时,要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试 默认:1000ms
retrySleepMillis
- 重试休息时间void setMaxRetryTimes(int maxRetryTimes)
设置当微信系统响应系统繁忙时,最大重试次数 默认:5次
maxRetryTimes
- 最大重试次数WxSession getSession(String id)
id
- id可以为任意字符串,建议使用FromUserName作为idWxSession getSession(String id, boolean create)
id
- id可以为任意字符串,建议使用FromUserName作为idcreate
- 是否新建WxSessionManager getSessionManager()
void setSessionManager(WxSessionManager sessionManager)
设置WxSessionManager,只有当需要使用个性化的WxSessionManager的时候才需要调用此方法,
WxCpService默认使用的是StandardSessionManager
sessionManager
- 会话管理器String replaceParty(String mediaId) throws WxErrorException
mediaId
- 媒体idWxErrorException
- the wx error exceptionString syncUser(String mediaId) throws WxErrorException
mediaId
- 媒体idWxErrorException
- the wx error exceptionString replaceUser(String mediaId) throws WxErrorException
mediaId
- 媒体idWxErrorException
- the wx error exceptionString getTaskResult(String jobId) throws WxErrorException
jobId
- 异步任务idWxErrorException
- the wx error exceptionvoid initHttp()
WxCpConfigStorage getWxCpConfigStorage()
void setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider)
WxCpConfigStorage
的实现wxConfigProvider
- 配置对象String buildQrConnectUrl(String redirectUri, String state)
redirectUri
- 重定向地址,需要进行UrlEncodestate
- 用于保持请求和回调的状态,授权请求后原样带回给企业。该参数可用于防止csrf攻击(跨站请求伪造攻击),建议企业带上该参数,可设置为简单的随机数加session进行校验WxCpDepartmentService getDepartmentService()
WxCpMediaService getMediaService()
WxCpMenuService getMenuService()
WxCpOAuth2Service getOauth2Service()
WxCpTagService getTagService()
WxCpUserService getUserService()
WxCpExternalContactService getExternalContactService()
WxCpChatService getChatService()
WxCpTaskCardService getTaskCardService()
WxCpAgentService getAgentService()
WxCpMessageService getMessageService()
WxCpOaService getOaService()
WxCpSchoolService getSchoolService()
WxCpSchoolUserService getSchoolUserService()
WxCpSchoolHealthService getSchoolHealthService()
WxCpLivingService getLivingService()
WxCpOaAgentService getOaAgentService()
WxCpOaWeDriveService getOaWeDriveService()
WxCpMsgAuditService getMsgAuditService()
WxCpOaCalendarService getOaCalendarService()
WxCpOaMeetingRoomService getOaMeetingRoomService()
WxCpOaScheduleService getOaScheduleService()
WxCpGroupRobotService getGroupRobotService()
WxCpAgentWorkBenchService getWorkBenchService()
WxCpKfService getKfService()
RequestHttp<?,?> getRequestHttp()
void setUserService(WxCpUserService userService)
userService
- the user servicevoid setDepartmentService(WxCpDepartmentService departmentService)
departmentService
- the department servicevoid setMediaService(WxCpMediaService mediaService)
mediaService
- the media servicevoid setMenuService(WxCpMenuService menuService)
menuService
- the menu servicevoid setOauth2Service(WxCpOAuth2Service oauth2Service)
oauth2Service
- the oauth 2 servicevoid setTagService(WxCpTagService tagService)
tagService
- the tag servicevoid setKfService(WxCpKfService kfService)
kfService
- the kf serviceWxCpExportService getExportService()
void setExportService(WxCpExportService exportService)
exportService
- 异步导出服务Copyright © 2022. All rights reserved.