me.chanjar.weixin.cp.api

接口 WxCpService

所有已知实现类:

WxCpServiceImpl

public interface WxCpService

微信API的Service

方法概要

方法

限定符和类型	方法和说明
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?
Integer	departCreate(WxCpDepart depart) 部门管理接口 - 创建部门 最多支持创建500个部门 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	departDelete(Integer departId) 部门管理接口 - 删除部门
List<WxCpDepart>	departGet() 部门管理接口 - 查询所有部门 详情请见: http://mp.weixin.qq.com/wiki/index.php?
List<WxCpUser>	departGetUsers(Integer departId, Boolean fetchChild, Integer status) 获取部门成员 http://qydev.weixin.qq.com/wiki/index.php?
void	departUpdate(WxCpDepart group) 部门管理接口 - 修改部门名 详情请见: http://mp.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[]	getCallbackIp() 获取微信服务器的ip段 http://qydev.weixin.qq.com/wiki/index.php?
String	getJsapiTicket() 获得jsapi_ticket,不强制刷新jsapi_ticket
String	getJsapiTicket(boolean forceRefresh) 获得jsapi_ticket 获得时会检查jsapiToken是否过期，如果过期了，那么就刷新一下，否则就什么都不干 详情请见：http://qydev.weixin.qq.com/wiki/index.php?
WxSession	getSession(String id) 获取某个sessionId对应的session,如果sessionId没有对应的session，则新建一个并返回。
WxSession	getSession(String id, boolean create) 获取某个sessionId对应的session,如果sessionId没有对应的session，若create为true则新建一个，否则返回null。
String	getTaskResult(String joinId) 获取异步任务结果
int	invite(String userId, String inviteTips) 邀请成员关注 http://qydev.weixin.qq.com/wiki/index.php?
File	mediaDownload(String media_id) 下载多媒体文件 根据微信文档，视频文件下载不了，会返回null 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMediaUploadResult	mediaUpload(String mediaType, File file)
WxMediaUploadResult	mediaUpload(String mediaType, String fileType, InputStream inputStream) 上传多媒体文件 上传的多媒体文件有格式和大小限制，如下： 图片（image）: 1M，支持JPG格式 语音（voice）：2M，播放长度不超过60s，支持AMR\MP3格式 视频（video）：10MB，支持MP4格式 缩略图（thumb）：64KB，支持JPG格式 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	menuCreate(String agentId, WxMenu menu) 自定义菜单创建接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	menuCreate(WxMenu menu) 自定义菜单创建接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	menuDelete() 自定义菜单删除接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	menuDelete(String agentId) 自定义菜单删除接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMenu	menuGet() 自定义菜单查询接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
WxMenu	menuGet(String agentId) 自定义菜单查询接口 详情请见: http://mp.weixin.qq.com/wiki/index.php?
void	messageSend(WxCpMessage message) 发送消息 详情请见: http://mp.weixin.qq.com/wiki/index.php?
String	oauth2buildAuthorizationUrl(String redirectUri, String state) 构造oauth2授权的url连接 详情请见: http://qydev.weixin.qq.com/wiki/index.php?
String[]	oauth2getUserInfo(String code) 用oauth2获取用户信息 http://qydev.weixin.qq.com/wiki/index.php?
String[]	oauth2getUserInfo(String agentId, String code) 用oauth2获取用户信息 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	setMaxRetryTimes(int maxRetryTimes) 设置当微信系统响应系统繁忙时，最大重试次数 默认：5次
void	setRetrySleepMillis(int retrySleepMillis) 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试 默认：1000ms
void	setSessionManager(WxSessionManager sessionManager) 设置WxSessionManager，只有当需要使用个性化的WxSessionManager的时候才需要调用此方法， WxCpService默认使用的是StandardSessionManager
void	setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider) 注入 WxCpConfigStorage 的实现
void	tagAddUsers(String tagId, List<String> userIds, List<String> partyIds) 增加标签成员
String	tagCreate(String tagName) 创建标签
void	tagDelete(String tagId) 删除标签
List<WxCpTag>	tagGet() 获得标签列表
List<WxCpUser>	tagGetUsers(String tagId) 获取标签成员
void	tagRemoveUsers(String tagId, List<String> userIds) 移除标签成员
void	tagUpdate(String tagId, String tagName) 更新标签
void	userAuthenticated(String userId) 用在二次验证的时候 企业在员工验证成功后，调用本方法告诉企业号平台该员工关注成功。
void	userCreate(WxCpUser user) 新建用户
void	userDelete(String userid) 删除用户
void	userDelete(String[] userids) 批量删除成员 http://qydev.weixin.qq.com/wiki/index.php?
WxCpUser	userGet(String userid) 获取用户
List<WxCpUser>	userList(Integer departId, Boolean fetchChild, Integer status) 获取部门成员(详情) http://qydev.weixin.qq.com/wiki/index.php?
void	userUpdate(WxCpUser user) 更新用户

方法详细资料

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消息

返回:

userAuthenticated

void userAuthenticated(String userId)
                       throws WxErrorException

   用在二次验证的时候
   企业在员工验证成功后，调用本方法告诉企业号平台该员工关注成功。
 

参数:

userId -

抛出:

WxErrorException

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

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

mediaUpload

WxMediaUploadResult mediaUpload(String mediaType,
                              String fileType,
                              InputStream inputStream)
                                throws WxErrorException,
                                       IOException

 上传多媒体文件
 上传的多媒体文件有格式和大小限制，如下：
   图片（image）: 1M，支持JPG格式
   语音（voice）：2M，播放长度不超过60s，支持AMR\MP3格式
   视频（video）：10MB，支持MP4格式
   缩略图（thumb）：64KB，支持JPG格式
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
 

参数:

mediaType - 媒体类型, 请看WxConsts

fileType - 文件类型，请看WxConsts

inputStream - 输入流

抛出:

WxErrorException

IOException

mediaUpload

WxMediaUploadResult mediaUpload(String mediaType,
                              File file)
                                throws WxErrorException

参数:

mediaType -

file -

抛出:

WxErrorException

另请参阅:

mediaUpload(String, String, InputStream)

mediaDownload

File mediaDownload(String media_id)
                   throws WxErrorException

 下载多媒体文件
 根据微信文档，视频文件下载不了，会返回null
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
 

返回:

保存到本地的临时文件

抛出:

WxErrorException

messageSend

void messageSend(WxCpMessage message)
                 throws WxErrorException

 发送消息
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=发送消息
 

参数:

message -

抛出:

WxErrorException

menuCreate

void menuCreate(WxMenu menu)
                throws WxErrorException

 自定义菜单创建接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口

 注意: 这个方法使用WxCpConfigStorage里的agentId
 

参数:

menu -

抛出:

WxErrorException

另请参阅:

menuCreate(String, me.chanjar.weixin.common.bean.WxMenu)

menuCreate

void menuCreate(String agentId,
              WxMenu menu)
                throws WxErrorException

 自定义菜单创建接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口

 注意: 这个方法不使用WxCpConfigStorage里的agentId，需要开发人员自己给出
 

参数:

agentId - 企业号应用的id

menu -

抛出:

WxErrorException

另请参阅:

menuCreate(me.chanjar.weixin.common.bean.WxMenu)

menuDelete

void menuDelete()
                throws WxErrorException

 自定义菜单删除接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口

 注意: 这个方法使用WxCpConfigStorage里的agentId
 

抛出:

WxErrorException

另请参阅:

menuDelete(String)

menuDelete

void menuDelete(String agentId)
                throws WxErrorException

 自定义菜单删除接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口

 注意: 这个方法不使用WxCpConfigStorage里的agentId，需要开发人员自己给出
 

参数:

agentId - 企业号应用的id

抛出:

WxErrorException

另请参阅:

menuDelete()

menuGet

WxMenu menuGet()
               throws WxErrorException

 自定义菜单查询接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口

 注意: 这个方法使用WxCpConfigStorage里的agentId
 

返回:

抛出:

WxErrorException

另请参阅:

menuGet(String)

menuGet

WxMenu menuGet(String agentId)
               throws WxErrorException

 自定义菜单查询接口
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口

 注意: 这个方法不使用WxCpConfigStorage里的agentId，需要开发人员自己给出
 

参数:

agentId - 企业号应用的id

返回:

抛出:

WxErrorException

另请参阅:

menuGet()

departCreate

Integer departCreate(WxCpDepart depart)
                     throws WxErrorException

 部门管理接口 - 创建部门
 最多支持创建500个部门
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=部门管理接口
 

参数:

depart - 部门

返回:

部门id

抛出:

WxErrorException

departGet

List<WxCpDepart> departGet()
                           throws WxErrorException

 部门管理接口 - 查询所有部门
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=部门管理接口
 

返回:

抛出:

WxErrorException

departUpdate

void departUpdate(WxCpDepart group)
                  throws WxErrorException

 部门管理接口 - 修改部门名
 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=部门管理接口
 如果id为0(未部门),1(黑名单),2(星标组)，或者不存在的id，微信会返回系统繁忙的错误
 

参数:

group - 要更新的group，group的id,name必须设置

抛出:

WxErrorException

departDelete

void departDelete(Integer departId)
                  throws WxErrorException

 部门管理接口 - 删除部门
 

参数:

departId -

抛出:

WxErrorException

userList

List<WxCpUser> userList(Integer departId,
                      Boolean fetchChild,
                      Integer status)
                        throws WxErrorException

 获取部门成员(详情)

 http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E8.8E.B7.E5.8F.96.E9.83.A8.E9.97.A8.E6.88.90.E5.91.98.28.E8.AF.A6.E6.83.85.29
 

参数:

departId - 必填。部门id

fetchChild - 非必填。1/0：是否递归获取子部门下面的成员

status - 非必填。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加

返回:

抛出:

WxErrorException

departGetUsers

List<WxCpUser> departGetUsers(Integer departId,
                            Boolean fetchChild,
                            Integer status)
                              throws WxErrorException

 获取部门成员

 http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E8.8E.B7.E5.8F.96.E9.83.A8.E9.97.A8.E6.88.90.E5.91.98
 

参数:

departId - 必填。部门id

fetchChild - 非必填。1/0：是否递归获取子部门下面的成员

status - 非必填。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加

返回:

抛出:

WxErrorException

userCreate

void userCreate(WxCpUser user)
                throws WxErrorException

新建用户

参数:

user -

抛出:

WxErrorException

userUpdate

void userUpdate(WxCpUser user)
                throws WxErrorException

更新用户

参数:

user -

抛出:

WxErrorException

userDelete

void userDelete(String userid)
                throws WxErrorException

删除用户

参数:

userid -

抛出:

WxErrorException

userDelete

void userDelete(String[] userids)
                throws WxErrorException

 批量删除成员

 http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E6.89.B9.E9.87.8F.E5.88.A0.E9.99.A4.E6.88.90.E5.91.98
 

参数:

userids - 员工UserID列表。对应管理端的帐号

抛出:

WxErrorException

userGet

WxCpUser userGet(String userid)
                 throws WxErrorException

获取用户

参数:

userid -

返回:

抛出:

WxErrorException

tagCreate

String tagCreate(String tagName)
                 throws WxErrorException

创建标签

参数:

tagName -

返回:

抛出:

WxErrorException

tagUpdate

void tagUpdate(String tagId,
             String tagName)
               throws WxErrorException

更新标签

参数:

tagId -

tagName -

抛出:

WxErrorException

tagDelete

void tagDelete(String tagId)
               throws WxErrorException

删除标签

参数:

tagId -

抛出:

WxErrorException

tagGet

List<WxCpTag> tagGet()
                     throws WxErrorException

获得标签列表

返回:

抛出:

WxErrorException

tagGetUsers

List<WxCpUser> tagGetUsers(String tagId)
                           throws WxErrorException

获取标签成员

参数:

tagId -

返回:

抛出:

WxErrorException

tagAddUsers

void tagAddUsers(String tagId,
               List<String> userIds,
               List<String> partyIds)
                 throws WxErrorException

增加标签成员

参数:

tagId -

userIds -

抛出:

WxErrorException

oauth2buildAuthorizationUrl

String oauth2buildAuthorizationUrl(String redirectUri,
                                 String state)

 构造oauth2授权的url连接
 详情请见: http://qydev.weixin.qq.com/wiki/index.php?title=企业获取code
 

参数:

redirectUri -

state -

返回:

url

oauth2getUserInfo

String[] oauth2getUserInfo(String code)
                           throws WxErrorException

 用oauth2获取用户信息
 http://qydev.weixin.qq.com/wiki/index.php?title=根据code获取成员信息
 因为企业号oauth2.0必须在应用设置里设置通过ICP备案的可信域名，所以无法测试，因此这个方法很可能是坏的。

 注意: 这个方法使用WxCpConfigStorage里的agentId
 

参数:

code -

返回:

[userid, deviceid]

抛出:

WxErrorException

另请参阅:

oauth2getUserInfo(String, String)

oauth2getUserInfo

String[] oauth2getUserInfo(String agentId,
                         String code)
                           throws WxErrorException

 用oauth2获取用户信息
 http://qydev.weixin.qq.com/wiki/index.php?title=根据code获取成员信息
 因为企业号oauth2.0必须在应用设置里设置通过ICP备案的可信域名，所以无法测试，因此这个方法很可能是坏的。

 注意: 这个方法不使用WxCpConfigStorage里的agentId，需要开发人员自己给出
 

参数:

agentId - 企业号应用的id

code -

返回:

[userid, deviceid]

抛出:

WxErrorException

另请参阅:

oauth2getUserInfo(String)

tagRemoveUsers

void tagRemoveUsers(String tagId,
                  List<String> userIds)
                    throws WxErrorException

移除标签成员

参数:

tagId -

userIds -

抛出:

WxErrorException

invite

int invite(String userId,
         String inviteTips)
           throws WxErrorException

 邀请成员关注
 http://qydev.weixin.qq.com/wiki/index.php?title=管理成员#.E9.82.80.E8.AF.B7.E6.88.90.E5.91.98.E5.85.B3.E6.B3.A8
 

参数:

userId - 用户的userid

inviteTips - 推送到微信上的提示语（只有认证号可以使用）。当使用微信推送时，该字段默认为“请关注XXX企业号”，邮件邀请时，该字段无效。

返回:

1:微信邀请 2.邮件邀请

抛出:

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

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 -

返回:

抛出:

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

setWxCpConfigStorage

void setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider)

注入 WxCpConfigStorage 的实现

参数:

wxConfigProvider -

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 -

返回:

setSessionManager

void setSessionManager(WxSessionManager sessionManager)

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

参数:

sessionManager -

replaceParty

String replaceParty(String mediaId)
                    throws WxErrorException

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

参数:

mediaId -

抛出:

WxErrorException

replaceUser

String replaceUser(String mediaId)
                   throws WxErrorException

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

参数:

mediaId -

抛出:

WxErrorException

getTaskResult

String getTaskResult(String joinId)
                     throws WxErrorException

获取异步任务结果

参数:

joinId -

返回:

抛出:

WxErrorException