WxPubServicesUtil (chiship-sdk-third 2.6.3 API)

java.lang.Object
- cn.chiship.sdk.third.wx.network.WxPubServicesUtil

```
public class WxPubServicesUtil
extends Object
```
微信服务工具类

作者:

lijian WxPubServicesUtil.getInstance().config().token()

字段概要

字段
限定符和类型字段和说明

protected static org.slf4j.Logger LOGGER

字段
限定符和类型	字段和说明
`protected static org.slf4j.Logger`	`LOGGER`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`BaseResult`	`addMaterial(File file, String title, String desc, WxPubMaterialTypeEnum wxPubMaterialTypeEnum)` 新增其他类型永久素材
`BaseResult`	`addMaterial(File file, WxPubMaterialTypeEnum wxPubMaterialTypeEnum)` 新增其他类型永久素材
`WxPubServicesUtil`	`config()`
`WxPubServicesUtil`	`config(WeiXinConfig weiXinConfig)`
`BaseResult`	`createMenu(Menu menu)` 创建自定义菜单 1.自定义菜单最多包括3个一级菜单，每个一级菜单最多包含5个二级菜单。
`BaseResult`	`createTag(String tagName)` 创建微信用户标签
`BaseResult`	`deleteTag(String tagId)` 删除用户标签
`BaseResult`	`deleteTemplate(String templateId)` 删除消息模板
`String`	`getAccessToken()`
`BaseResult`	`getAccessUserInfo(String token, String openId)` 拉取用户信息(需scope为 snsapi_userinfo) 获得授权的用户信息
`BaseResult`	`getAllPrivateMessageTemplate()` 获取模板列表
`BaseResult`	`getBatchMaterial(Integer pageIndex, WxPubMaterialTypeEnum wxPubMaterialTypeEnum)` 素材列表
`String`	`getConnectOauth2Url(String redirectUri, String params, Boolean isSilence)` 获得授权认证连接网页授权第一步
`static WxPubServicesUtil`	`getInstance()`
`BaseResult`	`getMaterial(String mediaId)` 获取永久素材
`BaseResult`	`getQrCodeByForever(String sceneStr)` 永久二维码
`BaseResult`	`getQrCodeByTemporary(Integer expireSeconds, String sceneStr)` 临时二维码
`BaseResult`	`getTags()` 获得微信标签
`BaseResult`	`getToken()` 获得accessToken 1.access_token是公众号的全局唯一接口调用凭据，公众号调用各接口时都需使用access_token。
`BaseResult`	`getUserInfo(String openId)` 获取用户基本信息 1.在关注者与公众号产生消息交互后，公众号可获得关注者的OpenID（加密后的微信号，每个用户对每个公众号的OpenID是唯一的。
`BaseResult`	`getUserInfo(String openId, WeiXinLanguageEnum weiXinLanguageEnum)` 获得用户基本信息
`BaseResult`	`memberBatchTag(List<String> openIds, String tagId)` 用户绑定标签
`BaseResult`	`memberBatchTag(String openId, String tagId)` 用户绑定标签
`BaseResult`	`memberBatchUnTag(List<String> openIds, String tagId)` 用户取消绑定标签
`BaseResult`	`memberBatchUnTag(String openId, String tagId)` 用户取消绑定标签
`BaseResult`	`messageTemplateSend(MessageTemplateSend messageTemplateSend)` 模板消息发送
`BaseResult`	`oauth2AccessToken(String code)` 通过code换取网页授权access_token 网页授权第二步
`BaseResult`	`syncUser()` 第一个拉取的OPENID，不填默认从头开始拉取 1.公众号可通过本接口来获取帐号的关注者列表，关注者列表由一串OpenID（加密后的微信号，每个用户对每个公众号的OpenID是唯一的）组成。
`BaseResult`	`syncUser(String nextOpenId)`
`BaseResult`	`tagGetUser(String tagId)` 获得标签下用户
`BaseResult`	`tagGetUser(String tagId, String nextOpenId)` 获得标签下用户
`WxPubServicesUtil`	`token()`
`BaseResult`	`updateTag(String tagId, String tagName)` 编辑用户标签
`BaseResult`	`updateUserRemark(String openId, String remark)` 设置用户备注名
`BaseResult`	`uploadMedia(InputStream inputStream, String fileName, String title, String introduction, String fileType)` 上传文件流到素材

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

- 字段详细资料
  - LOGGER
```
protected static final org.slf4j.Logger LOGGER
```
- 方法详细资料
  - getInstance
```
public static WxPubServicesUtil getInstance()
```
  - config
```
public WxPubServicesUtil config()
```
  - config
```
public WxPubServicesUtil config(WeiXinConfig weiXinConfig)
```
  - token
```
public WxPubServicesUtil token()
```
  - getToken
```
public BaseResult getToken()
```
    获得accessToken 1.access_token是公众号的全局唯一接口调用凭据，公众号调用各接口时都需使用access_token。 2.开发者需要进行妥善保存。 3.access_token的存储至少要保留512个字符空间。 4.access_token的有效期目前为2个小时，需定时刷新，重复获取将导致上次获取的access_token失效。
    
    返回:
    
    结果返回token
  - getUserInfo
```
public BaseResult getUserInfo(String openId)
```
    获取用户基本信息 1.在关注者与公众号产生消息交互后，公众号可获得关注者的OpenID（加密后的微信号，每个用户对每个公众号的OpenID是唯一的。对于不同公众号，同一用户的openid不同）。 2.公众号可通过本接口来根据OpenID获取用户基本信息，包括语言和关注时间。
    
    参数:
    
    openId - 用户标识
    
    返回:
    
    结果
  - getUserInfo
```
public BaseResult getUserInfo(String openId,
                              WeiXinLanguageEnum weiXinLanguageEnum)
```
    获得用户基本信息
    
    参数:
    
    openId - 用户标识
    
    weiXinLanguageEnum - 语言
    
    返回:
    
    结果
  - updateUserRemark
```
public BaseResult updateUserRemark(String openId,
                                   String remark)
```
    设置用户备注名
    
    参数:
    
    openId -
    
    remark - 新的备注名，长度必须小于30字节，大于30个字节，将会自动截取,自动截取有可能会出现乱码
    
    返回:
    
    结果
  - syncUser
```
public BaseResult syncUser()
```
    第一个拉取的OPENID，不填默认从头开始拉取 1.公众号可通过本接口来获取帐号的关注者列表，关注者列表由一串OpenID（加密后的微信号，每个用户对每个公众号的OpenID是唯一的）组成。 2.一次拉取调用最多拉取10000个关注者的OpenID，可以通过多次拉取的方式来满足需求。
    
    返回:
    
    结果
  - syncUser
```
public BaseResult syncUser(String nextOpenId)
```
  - createMenu
```
public BaseResult createMenu(Menu menu)
```
    创建自定义菜单 1.自定义菜单最多包括3个一级菜单，每个一级菜单最多包含5个二级菜单。 2.一级菜单最多4个汉字，二级菜单最多8个汉字，多出来的部分将会以“...”代替。 3.创建自定义菜单后，菜单的刷新策略是，在用户进入公众号会话页或公众号profile页时，如果发现上一次拉取菜单的请求在5分钟以前，就会拉取一下菜单，如果菜单有更新，就会刷新客户端的菜单。测试时可以尝试取消关注公众账号后再次关注，则可以看到创建后的效果。
    
    参数:
    
    menu - 菜单实体
    
    返回:
    
    结果
  - getTags
```
public BaseResult getTags()
```
    获得微信标签
    
    返回:
    
    结果 Example {"code":200,"data":{"tags":[{"name":"星标组","count":0,"id":2}]},"success":true,"message":"操作成功"}
  - createTag
```
public BaseResult createTag(String tagName)
```
    创建微信用户标签
    
    参数:
    
    tagName - 标签名称
    
    返回:
    
    结果 Example {"code":200,"data":{"tag":{"name":"特别关注","id":100}},"success":true,"message":"操作成功"}
  - updateTag
```
public BaseResult updateTag(String tagId,
                            String tagName)
```
    编辑用户标签
    
    参数:
    
    tagId - 标签ID
    
    tagName - 标签名称
    
    返回:
    
    结果 Example {"code":200,"data":{"errcode":0,"errmsg":"ok"},"success":true,"message":"操作成功"}
  - deleteTag
```
public BaseResult deleteTag(String tagId)
```
    删除用户标签
    
    参数:
    
    tagId - 标签ID
    
    返回:
    
    结果 Example {"code":200,"data":{"errcode":0,"errmsg":"ok"},"success":true,"message":"操作成功"}
  - tagGetUser
```
public BaseResult tagGetUser(String tagId)
```
    获得标签下用户
    
    参数:
    
    tagId - 标签ID
    
    返回:
    
    结果 Example {"code":200,"data":{"data":{"openid":["ofZpz1tFF7Ek0C5ci4VJ398upvEo"]},"count":1,"next_openid":"ofZpz1tFF7Ek0C5ci4VJ398upvEo"},"success":true,"message":"操作成功"}
  - tagGetUser
```
public BaseResult tagGetUser(String tagId,
                             String nextOpenId)
```
    获得标签下用户
    
    参数:
    
    tagId - 标签ID
    
    nextOpenId - 下一个用户标识
    
    返回:
    
    结果
  - memberBatchTag
```
public BaseResult memberBatchTag(String openId,
                                 String tagId)
```
    用户绑定标签
    
    参数:
    
    openId - 用户标识
    
    tagId - 标签ID
    
    返回:
    
    结果
  - memberBatchTag
```
public BaseResult memberBatchTag(List<String> openIds,
                                 String tagId)
```
    用户绑定标签
    
    参数:
    
    openIds - 用户集合
    
    tagId - 标签ID
    
    返回:
    
    结果
  - memberBatchUnTag
```
public BaseResult memberBatchUnTag(String openId,
                                   String tagId)
```
    用户取消绑定标签
    
    参数:
    
    openId - 用户标识
    
    tagId - 标签ID
    
    返回:
    
    结果
  - memberBatchUnTag
```
public BaseResult memberBatchUnTag(List<String> openIds,
                                   String tagId)
```
    用户取消绑定标签
    
    参数:
    
    openIds - 用户集合
    
    tagId - 标签ID
    
    返回:
    
    结果
  - getQrCodeByForever
```
public BaseResult getQrCodeByForever(String sceneStr)
```
    永久二维码
    
    参数:
    
    sceneStr - 场景长度1-64
    
    返回:
    
    结果
  - getQrCodeByTemporary
```
public BaseResult getQrCodeByTemporary(Integer expireSeconds,
                                       String sceneStr)
```
    临时二维码
    
    参数:
    
    expireSeconds - 单位s 二维码有效时间二维码生成后的30天（即2592000秒）后过期;若超过30天自动设置30天
    
    sceneStr - 场景长度1-64
    
    返回:
    
    结果
  - getAllPrivateMessageTemplate
```
public BaseResult getAllPrivateMessageTemplate()
```
    获取模板列表
    
    返回:
    
    结果
  - deleteTemplate
```
public BaseResult deleteTemplate(String templateId)
```
    删除消息模板
    
    参数:
    
    templateId - 模板ID
    
    返回:
    
    结果
  - messageTemplateSend
```
public BaseResult messageTemplateSend(MessageTemplateSend messageTemplateSend)
```
    模板消息发送
    
    参数:
    
    messageTemplateSend - 模板
    
    返回:
    
    结果
  - getConnectOauth2Url
```
public String getConnectOauth2Url(String redirectUri,
                                  String params,
                                  Boolean isSilence)
```
    获得授权认证连接网页授权第一步
    
    参数:
    
    redirectUri - 重定向的域名一定要在公众号内进行配置
    
    params -
    
    isSilence - 是否静默授权 true：snsapi_base，false：snsapi_userinfo
    
    返回:
    
    结果
  - oauth2AccessToken
```
public BaseResult oauth2AccessToken(String code)
```
    通过code换取网页授权access_token 网页授权第二步
    
    参数:
    
    code -
    
    返回:
    
    结果
  - getAccessUserInfo
```
public BaseResult getAccessUserInfo(String token,
                                    String openId)
```
    拉取用户信息(需scope为 snsapi_userinfo) 获得授权的用户信息
    
    参数:
    
    openId -
    
    token -
    
    返回:
    
    结果
  - addMaterial
```
public BaseResult addMaterial(File file,
                              WxPubMaterialTypeEnum wxPubMaterialTypeEnum)
```
    新增其他类型永久素材
    
    参数:
    
    file - 文件
    
    wxPubMaterialTypeEnum - 类型
    
    返回:
    
    结果
  - addMaterial
```
public BaseResult addMaterial(File file,
                              String title,
                              String desc,
                              WxPubMaterialTypeEnum wxPubMaterialTypeEnum)
```
    新增其他类型永久素材
    
    参数:
    
    file - 文件
    
    title - 标题
    
    desc - 描述
    
    wxPubMaterialTypeEnum - 类型
    
    返回:
    
    结果 {"success":true, "code":200, "message":"操作成功", "data":{"item":[],"media_id":"","url":""}}
  - uploadMedia
```
public BaseResult uploadMedia(InputStream inputStream,
                              String fileName,
                              String title,
                              String introduction,
                              String fileType)
                       throws IOException
```
    上传文件流到素材
    
    参数:
    
    inputStream - 文件流
    
    fileName - 文件名称
    
    title - 标题
    
    introduction - 描述
    
    fileType - 素材类型图片（image）、语音（voice）、视频（video）
    
    返回:
    
    结果
    
    抛出:
    
    Exception - 异常
    
    IOException
  - getMaterial
```
public BaseResult getMaterial(String mediaId)
```
    获取永久素材
    
    参数:
    
    mediaId - 媒体ID
    
    返回:
    
    结果
  - getBatchMaterial
```
public BaseResult getBatchMaterial(Integer pageIndex,
                                   WxPubMaterialTypeEnum wxPubMaterialTypeEnum)
```
    素材列表
    
    参数:
    
    pageIndex - 第几页
    
    wxPubMaterialTypeEnum - 类型
    
    返回:
    
    结果
  - getAccessToken
```
public String getAccessToken()
```

类 WxPubServicesUtil

字段概要

方法概要

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

字段详细资料

LOGGER

方法详细资料

getInstance

config

config

token

getToken

getUserInfo

getUserInfo

updateUserRemark

syncUser

syncUser

createMenu

getTags

createTag

updateTag

deleteTag

tagGetUser

tagGetUser

memberBatchTag

memberBatchTag

memberBatchUnTag

memberBatchUnTag

getQrCodeByForever

getQrCodeByTemporary

getAllPrivateMessageTemplate

deleteTemplate

messageTemplateSend

getConnectOauth2Url

oauth2AccessToken

getAccessUserInfo

addMaterial

addMaterial

uploadMedia

getMaterial

getBatchMaterial

getAccessToken