279 lines
9.0 KiB
Java
279 lines
9.0 KiB
Java
package chanjarster.weixin.api;
|
||
|
||
import java.io.File;
|
||
import java.io.IOException;
|
||
import java.io.InputStream;
|
||
import java.util.List;
|
||
|
||
import chanjarster.weixin.bean.WxCustomMessage;
|
||
import chanjarster.weixin.bean.WxGroup;
|
||
import chanjarster.weixin.bean.WxMassGroupMessage;
|
||
import chanjarster.weixin.bean.WxMassNews;
|
||
import chanjarster.weixin.bean.WxMassOpenIdsMessage;
|
||
import chanjarster.weixin.bean.WxMassVideo;
|
||
import chanjarster.weixin.bean.WxMenu;
|
||
import chanjarster.weixin.bean.result.WxMassSendResult;
|
||
import chanjarster.weixin.bean.result.WxMassUploadResult;
|
||
import chanjarster.weixin.bean.result.WxMediaUploadResult;
|
||
import chanjarster.weixin.bean.result.WxUser;
|
||
import chanjarster.weixin.bean.result.WxUserList;
|
||
import chanjarster.weixin.exception.WxErrorException;
|
||
|
||
/**
|
||
* 微信API的Service
|
||
*/
|
||
public interface WxService {
|
||
|
||
/**
|
||
* <pre>
|
||
* 验证推送过来的消息的正确性
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=验证消息真实性
|
||
* </pre>
|
||
* @param timestamp
|
||
* @param nonce
|
||
* @param signature
|
||
* @return
|
||
*/
|
||
public boolean checkSignature(String timestamp, String nonce, String signature);
|
||
|
||
/**
|
||
* <pre>
|
||
* 获取access_token，本方法线程安全
|
||
* 且在多线程同时刷新时只刷新一次，避免超出2000次/日的调用次数上限
|
||
*
|
||
* 另：本service的所有方法都会在access_token过期是调用此方法
|
||
*
|
||
* 程序员在非必要情况下尽量不要主动调用此方法
|
||
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取access_token
|
||
* </pre>
|
||
* @throws WxErrorException
|
||
*/
|
||
public void accessTokenRefresh() throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 上传多媒体文件
|
||
*
|
||
* 上传的多媒体文件有格式和大小限制，如下：
|
||
* 图片（image）: 1M，支持JPG格式
|
||
* 语音（voice）：2M，播放长度不超过60s，支持AMR\MP3格式
|
||
* 视频（video）：10MB，支持MP4格式
|
||
* 缩略图（thumb）：64KB，支持JPG格式
|
||
*
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
|
||
* </pre>
|
||
* @param mediaType 媒体类型, 请看{@link WxConsts}
|
||
* @param fileType 文件类型，请看{@link WxConsts}
|
||
* @param inputStream 输入流
|
||
* @throws WxErrorException
|
||
*/
|
||
public WxMediaUploadResult mediaUpload(String mediaType, String fileType, InputStream inputStream) throws WxErrorException, IOException;
|
||
|
||
/**
|
||
* @see #mediaUpload(String, String, InputStream)
|
||
* @param mediaType
|
||
* @param file
|
||
* @throws WxErrorException
|
||
*/
|
||
public WxMediaUploadResult mediaUpload(String mediaType, File file) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 下载多媒体文件
|
||
*
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
|
||
* </pre>
|
||
* @params media_id
|
||
* @return 保存到本地的临时文件
|
||
* @throws WxErrorException
|
||
*/
|
||
public File mediaDownload(String media_id) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 发送客服消息
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
|
||
* </pre>
|
||
* @param message
|
||
* @throws WxErrorException
|
||
*/
|
||
public void customMessageSend(WxCustomMessage message) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 上传群发用的图文消息，上传后才能群发图文消息
|
||
*
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
|
||
* </pre>
|
||
* @param news
|
||
* @throws WxErrorException
|
||
* @see #massGroupMessageSend(WxMassGroupMessage)
|
||
* @see #massOpenIdsMessageSend(WxMassOpenIdsMessage)
|
||
*/
|
||
public WxMassUploadResult massNewsUpload(WxMassNews news) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 上传群发用的视频，上传后才能群发视频消息
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
|
||
* </pre>
|
||
* @return
|
||
* @throws WxErrorException
|
||
* @see #massGroupMessageSend(WxMassGroupMessage)
|
||
* @see #massOpenIdsMessageSend(WxMassOpenIdsMessage)
|
||
*/
|
||
public WxMassUploadResult massVideoUpload(WxMassVideo video) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 分组群发消息
|
||
* 如果发送图文消息，必须先使用 {@link #massNewsUpload(WxMassNews)} 获得media_id，然后再发送
|
||
* 如果发送视频消息，必须先使用 {@link #massVideoUpload(WxMassVideo)} 获得media_id，然后再发送
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
|
||
* </pre>
|
||
* @param message
|
||
* @throws WxErrorException
|
||
* @return
|
||
*/
|
||
public WxMassSendResult massGroupMessageSend(WxMassGroupMessage message) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 按openId列表群发消息
|
||
* 如果发送图文消息，必须先使用 {@link #massNewsUpload(WxMassNews)} 获得media_id，然后再发送
|
||
* 如果发送视频消息，必须先使用 {@link #massVideoUpload(WxMassVideo)} 获得media_id，然后再发送
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=高级群发接口
|
||
* </pre>
|
||
* @param message
|
||
* @return
|
||
* @throws WxErrorException
|
||
*/
|
||
public WxMassSendResult massOpenIdsMessageSend(WxMassOpenIdsMessage message) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 自定义菜单创建接口
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口
|
||
* </pre>
|
||
* @param menu
|
||
* @throws WxErrorException
|
||
*/
|
||
public void menuCreate(WxMenu menu) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 自定义菜单删除接口
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口
|
||
* </pre>
|
||
* @throws WxErrorException
|
||
*/
|
||
public void menuDelete() throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 自定义菜单查询接口
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口
|
||
* </pre>
|
||
* @return
|
||
* @throws WxErrorException
|
||
*/
|
||
public WxMenu menuGet() throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 分组管理接口 - 创建分组
|
||
* 最多支持创建500个分组
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
|
||
* </pre>
|
||
* @param name 分组名字（30个字符以内）
|
||
* @throws WxErrorException
|
||
*/
|
||
public WxGroup groupCreate(String name) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 分组管理接口 - 查询所有分组
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
|
||
* </pre>
|
||
* @return
|
||
* @throws WxErrorException
|
||
*/
|
||
public List<WxGroup> groupGet() throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 分组管理接口 - 查询用户所在分组
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
|
||
* </pre>
|
||
* @param openid 微信用户的openid
|
||
* @throws WxErrorException
|
||
*/
|
||
public long groupQueryUserGroup(String openid) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 分组管理接口 - 修改分组名
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
|
||
*
|
||
* 如果id为0(未分组),1(黑名单),2(星标组)，或者不存在的id，微信会返回系统繁忙的错误
|
||
* </pre>
|
||
* @param group 要更新的group，group的id,name必须设置
|
||
* @throws WxErrorException
|
||
*/
|
||
public void groupUpdate(WxGroup group) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 分组管理接口 - 移动用户分组
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
|
||
*
|
||
* 如果to_groupid为0(未分组),1(黑名单),2(星标组)，或者不存在的id，微信会返回系统繁忙的错误
|
||
* </pre>
|
||
* @param openid 用户openid
|
||
* @param to_groupid 移动到的分组id
|
||
* @throws WxErrorException
|
||
*/
|
||
public void userUpdateGroup(String openid, long to_groupid) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 设置用户备注名接口
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=设置用户备注名接口
|
||
* </pre>
|
||
* @param openid 用户openid
|
||
* @param remark 备注名
|
||
* @throws WxErrorException
|
||
*/
|
||
public void userUpdateRemark(String openid, String remark) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 获取用户基本信息
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取用户基本信息
|
||
* </pre>
|
||
* @param openid 用户openid
|
||
* @param lang 语言，zh_CN 简体(默认)，zh_TW 繁体，en 英语
|
||
* @return
|
||
* @throws WxErrorException
|
||
*/
|
||
public WxUser userInfo(String openid, String lang) throws WxErrorException;
|
||
|
||
/**
|
||
* <pre>
|
||
* 获取关注者列表
|
||
* 详情请见: http://mp.weixin.qq.com/wiki/index.php?title=获取关注者列表
|
||
* </pre>
|
||
* @param next_openid 可选，第一个拉取的OPENID，null为从头开始拉取
|
||
* @return
|
||
* @throws WxErrorException
|
||
*/
|
||
public WxUserList userList(String next_openid) throws WxErrorException;
|
||
|
||
/**
|
||
* 注入 {@link WxConfigStorage} 的实现
|
||
* @param wxConfigProvider
|
||
*/
|
||
public void setWxConfigStorage(WxConfigStorage wxConfigProvider);
|
||
}
|