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