me.chanjar.weixin.cp.api.WxCpService Maven / Gradle / Ivy
package me.chanjar.weixin.cp.api;
import me.chanjar.weixin.common.bean.WxJsapiSignature;
import me.chanjar.weixin.common.bean.menu.WxMenu;
import me.chanjar.weixin.common.bean.result.WxMediaUploadResult;
import me.chanjar.weixin.common.exception.WxErrorException;
import me.chanjar.weixin.common.session.WxSession;
import me.chanjar.weixin.common.session.WxSessionManager;
import me.chanjar.weixin.common.util.http.MediaUploadRequestExecutor;
import me.chanjar.weixin.common.util.http.RequestExecutor;
import me.chanjar.weixin.common.util.http.RequestHttp;
import me.chanjar.weixin.cp.bean.*;
import me.chanjar.weixin.cp.config.WxCpConfigStorage;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
/**
* 微信API的Service
*/
public interface WxCpService {
/**
*
* 验证推送过来的消息的正确性
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=验证消息真实性
*
*
* @param msgSignature 消息签名
* @param timestamp 时间戳
* @param nonce 随机数
* @param data 微信传输过来的数据，有可能是echoStr，有可能是xml消息
*/
boolean checkSignature(String msgSignature, String timestamp, String nonce, String data);
/**
* 获取access_token, 不强制刷新access_token
*
* @see #getAccessToken(boolean)
*/
String getAccessToken() throws WxErrorException;
/**
*
* 获取access_token，本方法线程安全
* 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限
* 另：本service的所有方法都会在access_token过期是调用此方法
* 程序员在非必要情况下尽量不要主动调用此方法
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取access_token
*
*
* @param forceRefresh 强制刷新
*/
String getAccessToken(boolean forceRefresh) throws WxErrorException;
/**
* 获得jsapi_ticket,不强制刷新jsapi_ticket
*
* @see #getJsapiTicket(boolean)
*/
String getJsapiTicket() 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
*
*
* @param forceRefresh 强制刷新
*/
String getJsapiTicket(boolean forceRefresh) 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
*
*
* @param url url
*/
WxJsapiSignature createJsapiSignature(String url) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpMenuService#create(WxMenu)}
*/
@Deprecated
void menuCreate(WxMenu menu) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpMenuService#create(Integer, WxMenu)}
*/
@Deprecated
void menuCreate(Integer agentId, WxMenu menu) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpMenuService#delete()} }
*/
@Deprecated
void menuDelete() throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpMenuService#delete(Integer)}
*/
@Deprecated
void menuDelete(Integer agentId) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpMenuService#get() }
*/
@Deprecated
WxMenu menuGet() throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpMenuService#get(Integer)}
*/
@Deprecated
WxMenu menuGet(Integer agentId) 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
*
*
* @param message 要发送的消息对象
*/
WxCpMessageSendResult messageSend(WxCpMessage message) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpDepartmentService#create(WxCpDepart)}
*/
@Deprecated
Integer departCreate(WxCpDepart depart) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpDepartmentService#update(WxCpDepart)}
*/
@Deprecated
void departUpdate(WxCpDepart group) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpDepartmentService#delete(Integer)}
*/
@Deprecated
void departDelete(Integer departId) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpDepartmentService#listAll() }
*/
@Deprecated
List departGet() throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpMediaService#upload(String, String, InputStream)}
*/
@Deprecated
WxMediaUploadResult mediaUpload(String mediaType, String fileType, InputStream inputStream)
throws WxErrorException, IOException;
/**
* @deprecated 请使用 {@link WxCpMediaService#upload(String, File)}
*/
@Deprecated
WxMediaUploadResult mediaUpload(String mediaType, File file) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpMediaService#download(String)}
*/
@Deprecated
File mediaDownload(String mediaId) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpUserService#authenticate(String)}
*/
@Deprecated
void userAuthenticated(String userId) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpUserService#create(WxCpUser)}
*/
@Deprecated
void userCreate(WxCpUser user) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpUserService#update(WxCpUser)}
*/
@Deprecated
void userUpdate(WxCpUser user) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpUserService#delete(String...)}
*/
@Deprecated
void userDelete(String userid) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpUserService#delete(String...)}
*/
@Deprecated
void userDelete(String[] userids) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpUserService#getById(String)}
*/
@Deprecated
WxCpUser userGet(String userid) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpUserService#listByDepartment(Integer, Boolean, Integer)}
*/
@Deprecated
List userList(Integer departId, Boolean fetchChild, Integer status) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpUserService#listSimpleByDepartment(Integer, Boolean, Integer)}
*/
@Deprecated
List departGetUsers(Integer departId, Boolean fetchChild, Integer status) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpTagService#create(String)}
*/
@Deprecated
String tagCreate(String tagName) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpTagService#update(String, String)}
*/
@Deprecated
void tagUpdate(String tagId, String tagName) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpTagService#delete(String)}
*/
@Deprecated
void tagDelete(String tagId) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpTagService#listAll()}
*/
@Deprecated
List tagGet() throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpTagService#listUsersByTagId(String)}
*/
@Deprecated
List tagGetUsers(String tagId) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpTagService#addUsers2Tag(String, List, List)}
*/
@Deprecated
void tagAddUsers(String tagId, List userIds, List partyIds) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpTagService#removeUsersFromTag(String, List)}
*/
@Deprecated
void tagRemoveUsers(String tagId, List userIds) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpOAuth2Service#buildAuthorizationUrl(String)}
*/
@Deprecated
String oauth2buildAuthorizationUrl(String state);
/**
* @deprecated 请使用 {@link WxCpOAuth2Service#buildAuthorizationUrl(String, String)}
*/
@Deprecated
String oauth2buildAuthorizationUrl(String redirectUri, String state);
/**
* @deprecated 请使用 {@link WxCpOAuth2Service#getUserInfo(String)}
*/
@Deprecated
String[] oauth2getUserInfo(String code) throws WxErrorException;
/**
* @deprecated 请使用 {@link WxCpOAuth2Service#getUserInfo(Integer, String)}
*/
@Deprecated
String[] oauth2getUserInfo(Integer agentId, String code) 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
*
*
* @param userId 用户的userid
* @param inviteTips 推送到微信上的提示语（只有认证号可以使用）。当使用微信推送时，该字段默认为“请关注XXX企业号”，邮件邀请时，该字段无效。
* @return 1:微信邀请 2.邮件邀请
*/
int invite(String userId, String inviteTips) 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
*
*
* @return { "ip_list": ["101.226.103.*", "101.226.62.*"] }
*/
String[] getCallbackIp() throws WxErrorException;
/**
* 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的GET请求
*
* @param url 接口地址
* @param queryParam 请求参数
*/
String get(String url, String queryParam) throws WxErrorException;
/**
* 当本Service没有实现某个API的时候，可以用这个，针对所有微信API中的POST请求
*
* @param url 接口地址
* @param postData 请求body字符串
*/
String post(String url, String postData) throws WxErrorException;
/**
*
* Service没有实现某个API的时候，可以用这个，
* 比{@link #get}和{@link #post}方法更灵活，可以自己构造RequestExecutor用来处理不同的参数和不同的返回类型。
* 可以参考，{@link MediaUploadRequestExecutor}的实现方法
*
*
* @param executor 执行器
* @param uri 请求地址
* @param data 参数
* @param 请求值类型
* @param 返回值类型
*/
T execute(RequestExecutor executor, String uri, E data) throws WxErrorException;
/**
*
* 设置当微信系统响应系统繁忙时，要等待多少 retrySleepMillis(ms) * 2^(重试次数 - 1) 再发起重试
* 默认：1000ms
*
*
* @param retrySleepMillis 重试休息时间
*/
void setRetrySleepMillis(int retrySleepMillis);
/**
*
* 设置当微信系统响应系统繁忙时，最大重试次数
* 默认：5次
*
*
* @param maxRetryTimes 最大重试次数
*/
void setMaxRetryTimes(int maxRetryTimes);
/**
* 获取某个sessionId对应的session,如果sessionId没有对应的session，则新建一个并返回。
*
* @param id id可以为任意字符串，建议使用FromUserName作为id
*/
WxSession getSession(String id);
/**
* 获取某个sessionId对应的session,如果sessionId没有对应的session，若create为true则新建一个，否则返回null。
*
* @param id id可以为任意字符串，建议使用FromUserName作为id
* @param create 是否新建
*/
WxSession getSession(String id, boolean create);
/**
*
* 设置WxSessionManager，只有当需要使用个性化的WxSessionManager的时候才需要调用此方法，
* WxCpService默认使用的是{@link me.chanjar.weixin.common.session.StandardSessionManager}
*
*
* @param sessionManager 会话管理器
*/
void setSessionManager(WxSessionManager sessionManager);
/**
* 上传部门列表覆盖企业号上的部门信息
*
* @param mediaId 媒体id
*/
String replaceParty(String mediaId) throws WxErrorException;
/**
* 上传用户列表覆盖企业号上的用户信息
*
* @param mediaId 媒体id
*/
String replaceUser(String mediaId) throws WxErrorException;
/**
* 获取异步任务结果
*/
String getTaskResult(String joinId) throws WxErrorException;
/**
* 初始化http请求对象
*/
void initHttp();
/**
* 获取WxMpConfigStorage 对象
*
* @return WxMpConfigStorage
*/
WxCpConfigStorage getWxCpConfigStorage();
/**
* 注入 {@link WxCpConfigStorage} 的实现
*
* @param wxConfigProvider 配置对象
*/
void setWxCpConfigStorage(WxCpConfigStorage wxConfigProvider);
/**
* 获取部门相关接口的服务类对象
*/
WxCpDepartmentService getDepartmentService();
/**
* 获取媒体相关接口的服务类对象
*/
WxCpMediaService getMediaService();
/**
* 获取菜单相关接口的服务类对象
*/
WxCpMenuService getMenuService();
/**
* 获取Oauth2相关接口的服务类对象
*/
WxCpOAuth2Service getOauth2Service();
/**
* 获取标签相关接口的服务类对象
*/
WxCpTagService getTagService();
/**
* 获取用户相关接口的服务类对象
*/
WxCpUserService getUserService();
/**
* http请求对象
*/
RequestHttp getRequestHttp();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy