WeChatAPI (wechat 1.2.1 API)

java.lang.Object
- cc.jinglupeng.wechat.api.WeChatAPI

```
public class WeChatAPI
extends Object
```
为所有API提供一个统一的入口，并且提供一些简化的方法

作者:

jinglupeng.cc

方法概要

方法
限定符和类型	方法和说明
`boolean`	`checkSignature(String token, String signature, String timestamp, String nonce)` 用于和微信公众平台对接，验证消息是否来自微信公众平台
`Group`	`createGroup(String name)` 创建分组
`Boolean`	`createMenu(String menu)` 自定义菜单创建
`Qrcode`	`createQrcode(Integer sceneId, Integer seconds)` 创建二维码ticket，当seconds为0的或者空时，创建永久有效二维码
`Boolean`	`deleteMenu()` 删除菜单
`boolean`	`deleteMessage(String msgId)` 删除群发
`Media`	`downMedia(String mediaId)` 从微信服务器下载多媒体文件，该方法将文件数据缓存到内存中不做进一步处理，因此当从附件对象中读取数据结束后应该迅速将附件对象置空。
`String`	`generateOAuth2BaseUrl(String uri)` 获取OAuth2授权API，不弹出授权页面，直接跳转，只能获取用户openid
`String`	`generateOAuth2UserInfoUrl(String uri)` 获取OAuth2授权API，弹出授权页面，可通过openid拿到昵称、性别、所在地。
`String`	`getAccessToken()` 获取AccessToken，优先从缓存获取。
`static WeChatAPI`	`getAPI(String appId)`
`List<Group>`	`getGroups()` 查询所有分组
`Map<String,String>`	`getJSAPIConfig(String url)` 签名URL
`String`	`getJSAPITicket()` 获取 JS SDK Ticket
`Menu`	`getMenu()` 自定义菜单查询接口
`OAuthAccessToken`	`getOAuthAccessToken(String code)` 通过code换取网页授权access_token
`OAuthUser`	`getOAuthUserInfo(String accessToken, String openId)` 通过网页授权AccessToken拉取用户信息
`String`	`getOpenIdByCode(String code)` 通过Code换取OpenId
`String`	`getQrCodeURL(String ticket)` 通过ticket换取二维码
`String`	`getUserGroupId(String openId)` 查询用户所在分组
`User`	`getUserInfo(String openId)` 获取用户基本信息
`Users`	`getUserList(String nextOpenId)` 获取关注者列表
`boolean`	`moveMemberGroup(String openId, String groupId)` 移动用户分组
`MsgId`	`previewMessage(MessageType type, String mediaId, String openId)` 预览接口
`boolean`	`queryMessageStatus(String msgId)` 查询群发消息发送状态
`OAuthAccessToken`	`refreshAccessToken(String refreshToken)` 刷新网页授权access_token
`boolean`	`sendCustomMessage(CustomMessage message, String openId)` 发送客服消息
`boolean`	`sendCustomMessage(String message)` 发送客服消息
`MsgId`	`sendMassMessage(MessageType type, String mediaId)` 高级群发消息
`MsgId`	`sendMassMessage(MessageType type, String mediaId, List<String> openIds)` 按openId列表进行高级群发
`MsgId`	`sendMassMessage(MessageType type, String mediaId, String groupId)` 根据分组过滤进行高级群发
`String`	`toShortUrl(String longUrl)` 长链接转短链接
`boolean`	`updateGroup(Group group)` 修改分组名
`boolean`	`updateUserRemark(String openId, String remark)` 设置备注名
`MediaId`	`uploadMedia(File file, MediaType type)` 上传多媒体文件到微信服务器
`MediaId`	`uploadNews(List<Article> articles)` 上传图文消息素材
`MediaId`	`uploadVideo(String mediaId, String title, String description)` 上传视频

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getAPI
```
public static WeChatAPI getAPI(String appId)
```
  - getAccessToken
```
public String getAccessToken()
```
    获取AccessToken，优先从缓存获取。获取AccessToken接口每天可获取2000次，每次有效期7200秒，获取新的AccessToken后旧的立刻失效。所以需要对AccessToken进行缓存，如果多个系统需要同时调用微信接口，则必须对AccessToken进行统一管理
    
    返回:
  - uploadMedia
```
public MediaId uploadMedia(File file,
                  MediaType type)
```
    上传多媒体文件到微信服务器
    
    参数:
    file - -文件
    type - -媒体文件类型，分别有图片（image）、语音（voice）、视频（video）和缩略图（thumb）
    
    返回:
  - downMedia
```
public Media downMedia(String mediaId)
```
    从微信服务器下载多媒体文件，该方法将文件数据缓存到内存中不做进一步处理，因此当从附件对象中读取数据结束后应该迅速将附件对象置空。
    
    参数:
    mediaId - -媒体文件ID
    
    返回:
  - checkSignature
```
public final boolean checkSignature(String token,
                     String signature,
                     String timestamp,
                     String nonce)
```
    用于和微信公众平台对接，验证消息是否来自微信公众平台
    
    参数:
    token -
    signature - -微信加密签名，signature结合了开发者填写的token参数和请求中的timestamp参数、nonce参数。
    timestamp - -时间戳
    nonce - -随机数
    
    返回:
  - createGroup
```
public Group createGroup(String name)
```
    创建分组
    
    参数:
    name - -分组名字（30个字符以内）
    
    返回:
  - getGroups
```
public List<Group> getGroups()
```
    查询所有分组
    
    返回:
  - getUserGroupId
```
public String getUserGroupId(String openId)
```
    查询用户所在分组
    
    参数:
    openId - -用户的OpenID
    
    返回:
  - updateGroup
```
public boolean updateGroup(Group group)
```
    修改分组名
    
    参数:
    group - -分组信息
    
    返回:
  - moveMemberGroup
```
public boolean moveMemberGroup(String openId,
                      String groupId)
```
    移动用户分组
    
    参数:
    openId - -用户唯一标识符
    groupId - -分组id
    
    返回:
  - getMenu
```
public Menu getMenu()
```
    自定义菜单查询接口
    
    返回:
  - deleteMenu
```
public Boolean deleteMenu()
```
    删除菜单
    
    返回:
  - createMenu
```
public Boolean createMenu(String menu)
```
    自定义菜单创建
    
    参数:
    menu - -JSON形式的菜单
    
    返回:
  - sendCustomMessage
```
public boolean sendCustomMessage(String message)
```
    发送客服消息
    
    参数:
    message - -JSON形式的客服消息
    
    返回:
  - sendCustomMessage
```
public boolean sendCustomMessage(CustomMessage message,
                        String openId)
```
    发送客服消息
    
    参数:
    message - -客服消息
    openId - -普通用户openid
    
    返回:
  - sendMassMessage
```
public MsgId sendMassMessage(MessageType type,
                    String mediaId)
```
    高级群发消息
    
    参数:
    type - -消息类型
    mediaId - -文本类型为文本内容，其它类型为消息Id
    
    返回:
  - sendMassMessage
```
public MsgId sendMassMessage(MessageType type,
                    String mediaId,
                    List<String> openIds)
```
    按openId列表进行高级群发
    
    参数:
    type - -消息类型
    mediaId - -文本类型为文本内容，其它类型为消息Id
    openIds - -消息的接收者，一串OpenID列表，OpenID最少1个，最多10000个
    
    返回:
  - sendMassMessage
```
public MsgId sendMassMessage(MessageType type,
                    String mediaId,
                    String groupId)
```
    根据分组过滤进行高级群发
    
    参数:
    type - -消息类型
    mediaId - -文本类型为文本内容，其它类型为消息Id
    groupId - -群发到的分组的group_id
    
    返回:
  - uploadNews
```
public MediaId uploadNews(List<Article> articles)
```
    上传图文消息素材
    
    参数:
    articles - -图文消息，一个图文消息支持1到10条图文
    
    返回:
  - uploadVideo
```
public MediaId uploadVideo(String mediaId,
                  String title,
                  String description)
```
    上传视频
    
    参数:
    mediaId - -通过基础支持中的上传下载多媒体文件来得到
    title - -消息的标题
    description - -消息的描述
    
    返回:
  - previewMessage
```
public MsgId previewMessage(MessageType type,
                   String mediaId,
                   String openId)
```
    预览接口
    
    参数:
    type - -消息类型
    mediaId - -文本类型为文本内容，其它类型为消息Id
    openId - -接收消息用户对应该公众号的openid
  - deleteMessage
```
public boolean deleteMessage(String msgId)
```
    删除群发
    
    参数:
    msgId - -发送出去的消息ID
    
    返回:
  - queryMessageStatus
```
public boolean queryMessageStatus(String msgId)
```
    查询群发消息发送状态
    
    参数:
    msgId - -发送出去的消息ID
    
    返回:
  - generateOAuth2BaseUrl
```
public String generateOAuth2BaseUrl(String uri)
```
    获取OAuth2授权API，不弹出授权页面，直接跳转，只能获取用户openid
    
    参数:
    uri - -授权后重定向的回调链接地址
    
    返回:
  - generateOAuth2UserInfoUrl
```
public String generateOAuth2UserInfoUrl(String uri)
```
    获取OAuth2授权API，弹出授权页面，可通过openid拿到昵称、性别、所在地。并且，即使在未关注的情况下，只要用户授权，也能获取其信息
    
    参数:
    uri - -授权后重定向的回调链接地址
    
    返回:
  - getOAuthAccessToken
```
public OAuthAccessToken getOAuthAccessToken(String code)
```
    通过code换取网页授权access_token
    
    参数:
    code - -code
    
    返回:
  - getOpenIdByCode
```
public String getOpenIdByCode(String code)
```
    通过Code换取OpenId
    
    参数:
    code - -code
    
    返回:
  - refreshAccessToken
```
public OAuthAccessToken refreshAccessToken(String refreshToken)
```
    刷新网页授权access_token
    
    参数:
    refreshToken - -refreshToken
    
    返回:
  - getOAuthUserInfo
```
public OAuthUser getOAuthUserInfo(String accessToken,
                         String openId)
```
    通过网页授权AccessToken拉取用户信息
    
    参数:
    accessToken -
  - createQrcode
```
public Qrcode createQrcode(Integer sceneId,
                  Integer seconds)
```
    创建二维码ticket，当seconds为0的或者空时，创建永久有效二维码
    
    参数:
    sceneId - -场景值ID，临时二维码时为32位非0整型，永久二维码时最大值为100000（目前参数只支持1--100000）
    seconds - -该二维码有效时间，以秒为单位。最大不超过1800。当为0或者空的时候，则创建永久有效二维码
    
    返回:
  - getQrCodeURL
```
public String getQrCodeURL(String ticket)
```
    通过ticket换取二维码
    
    参数:
    ticket - -二维码ticket
    
    返回:
  - toShortUrl
```
public String toShortUrl(String longUrl)
```
    长链接转短链接
    
    参数:
    url - -长链接
    
    返回:
  - getUserInfo
```
public User getUserInfo(String openId)
```
    获取用户基本信息
    
    参数:
    openId - -普通用户的标识，对当前公众号唯一
    
    返回:
  - updateUserRemark
```
public boolean updateUserRemark(String openId,
                       String remark)
```
    设置备注名
    
    参数:
    openId - -用户标识
    remark - -新的备注名，长度必须小于30字符
    
    返回:
  - getUserList
```
public Users getUserList(String nextOpenId)
```
    获取关注者列表
    
    参数:
    nextOpenId - -拉取列表的后一个用户的OPENID
    
    返回:
  - getJSAPITicket
```
public String getJSAPITicket()
```
    获取 JS SDK Ticket
    
    返回:
  - getJSAPIConfig
```
public Map<String,String> getJSAPIConfig(String url)
```
    签名URL
    
    参数:
    url - 需要被签名的URL
    
    返回:

类 WeChatAPI

方法概要

从类继承的方法 java.lang.Object

方法详细资料

getAPI

getAccessToken

uploadMedia

downMedia

checkSignature

createGroup

getGroups

getUserGroupId

updateGroup

moveMemberGroup

getMenu

deleteMenu

createMenu

sendCustomMessage

sendCustomMessage

sendMassMessage

sendMassMessage

sendMassMessage

uploadNews

uploadVideo

previewMessage

deleteMessage

queryMessageStatus

generateOAuth2BaseUrl

generateOAuth2UserInfoUrl

getOAuthAccessToken

getOpenIdByCode

refreshAccessToken

getOAuthUserInfo

createQrcode

getQrCodeURL

toShortUrl

getUserInfo

updateUserRemark

getUserList

getJSAPITicket

getJSAPIConfig