WXWorkServiceImpl (wxwork-spring-boot-starter 1.1.7 API)

java.lang.Object
- xiongwei.jiang.service.impl.WXWorkServiceImpl

所有已实现的接口:: org.springframework.beans.factory.InitializingBean, WXWorkService

@EnableConfigurationProperties(value=WXWorkProperties.class)
 @Service
public class WXWorkServiceImpl
extends Object
implements WXWorkService, org.springframework.beans.factory.InitializingBean

企业微信服务接口实现类

作者:: 天之蓝

嵌套类概要

嵌套类
限定符和类型类和说明

static class WXWorkServiceImpl.NodeName
自定义节点名称对象

static class WXWorkServiceImpl.UploadTypeEnum
媒体文件类型

嵌套类
限定符和类型	类和说明
`static class`	`WXWorkServiceImpl.NodeName` 自定义节点名称对象
`static class`	`WXWorkServiceImpl.UploadTypeEnum` 媒体文件类型

字段概要

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

static com.google.gson.Gson GSON

static String WXWORK_ALIAS

字段
限定符和类型	字段和说明
`static com.google.gson.Gson`	`GSON`
`static String`	`WXWORK_ALIAS`

构造器概要

构造器
构造器和说明

WXWorkServiceImpl()

构造器
构造器和说明
`WXWorkServiceImpl()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`afterPropertiesSet()`
`com.google.common.collect.Multimap<String,String>`	`callback(Integer appIndex, String msg_signature, String timestamp, String nonce, String xml, javax.servlet.http.HttpServletResponse response)` 处理 callback
`byte[]`	`downloadTemp(Integer appIndex, String mediaId)` 获取临时素材
`byte[]`	`downloadVoice(Integer appIndex, String mediaId)` 获取高清语音素材
`AgentConfigSignatureResponseDTO`	`getAgentConfigSignature(Integer appIndex, String currentPageUrl)` 获取 agentConfig 签名
`CallbackIpResponseDTO`	`getCallbackIp(Integer appIndex)` 获取企业微信服务器的 ip 段
`CheckinDataResponseDTO`	`getCheckinData(Integer openCheckinDataType, Long startTime, Long endTime, List<String> userIdList)` 获取打卡信息（token 必须由打卡 secret 获取）
`ConfigSignatureResponseDTO`	`getConfigSignature(Integer appIndex, String currentPageUrl)` 获取 config 签名
`DepartmentDataResponseDTO`	`getDepartmentData(Integer appIndex, Integer departmentId)` 获取 department 部门列表
`DepartmentUserResponseDTO`	`getDepartmentUser(Integer appIndex, Integer departmentId, Integer fetchChild)` 获取 department 部门 user 简单信息
`static void`	`getFullyQualifiedNodeName(org.dom4j.Element node, WXWorkServiceImpl.NodeName nodeName)` 递归获取完全限定节点名称，以英文点“.”分隔（例如：grandparentNodeName.parentNodeName.nodeName）
`String`	`getJsapiTicket(Integer appIndex)` 获取 jsapi_ticket
`String`	`getJsapiTicketAgent(Integer appIndex)` 获取 jsapi_ticket
`String`	`getJsapiTicketAgentCache(Integer appIndex)` 获取 jsapi_ticket_agent 缓存
`String`	`getJsapiTicketCache(Integer appIndex)` 获取 jsapi_ticket 缓存
`TagDataResponseDTO`	`getTagData()` 获取 tag 标签列表（token 必须由通讯录 secret 获取）
`TagUserResponseDTO`	`getTagUser(Integer tagId)` 获取 tag 标签 user 简单信息（token 必须由通讯录 secret 获取）
`String`	`getToken(Integer appIndex)` 获取 token
`String`	`getTokenCache(Integer appIndex)` 获取 token 缓存
`UserIdResponseDTO`	`getUserId(Integer appIndex, String code)` 获取工号
`UserInfoResponseDTO`	`getUserInfo(Integer appIndex, String userId)` 获取 user 信息
`static void`	`listNodes(org.dom4j.Element node, com.google.common.collect.Multimap<String,String> map)` 递归遍历 xml 节点
`AppMsgResponseDTO`	`sendAppTextMsgToDepartment(Integer appIndex, List<String> departmentIdList, String content)` 发送应用文本消息
`AppMsgResponseDTO`	`sendAppTextMsgToDepartment(Integer appIndex, String departmentId, String content)` 发送应用文本消息
`AppMsgResponseDTO`	`sendAppTextMsgToTag(Integer appIndex, List<String> tagIdList, String content)` 发送应用文本消息
`AppMsgResponseDTO`	`sendAppTextMsgToTag(Integer appIndex, String tagId, String content)` 发送应用文本消息
`AppMsgResponseDTO`	`sendAppTextMsgToUser(Integer appIndex, List<String> userIdList, String content)` 发送应用文本消息
`AppMsgResponseDTO`	`sendAppTextMsgToUser(Integer appIndex, String userId, String content)` 发送应用文本消息
`BotMsgResponseDTO`	`sendBotTextMsg(Integer appIndex, String content)` 发送机器人文本消息
`BotMsgResponseDTO`	`sendBotTextMsgAtMobileNo(Integer appIndex, List<String> mobileNoList, String content)` 发送机器人文本消息
`BotMsgResponseDTO`	`sendBotTextMsgAtUserId(Integer appIndex, List<String> userIdList, String content)` 发送机器人文本消息
`AppUploadImageResponseDTO`	`uploadImage(Integer appIndex, String filePath)` 上传图片
`AppUploadTempResponseDTO`	`uploadTemp(Integer appIndex, WXWorkServiceImpl.UploadTypeEnum typeEnum, String filePath)` 上传临时素材
`boolean`	`verifyUrl(Integer appIndex, String msg_signature, String timestamp, String nonce, String echostr, javax.servlet.http.HttpServletResponse response)` 验证 url
`static com.google.common.collect.Multimap<String,String>`	`xmlToMultimap(String xmlStr)` xml 转 map

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

- 字段详细资料
  - GSON
```
public static final com.google.gson.Gson GSON
```
  - WXWORK_ALIAS
```
public static final String WXWORK_ALIAS
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - WXWorkServiceImpl
```
public WXWorkServiceImpl()
```
- 方法详细资料
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    指定者:
    
    afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean
  - getUserId
```
public UserIdResponseDTO getUserId(Integer appIndex,
                                   String code)
```
    从接口复制的说明: WXWorkService
    
    获取工号
    
    指定者:
    
    getUserId 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    code - 企业微信返回一次性 code，5 分钟内有效
    
    返回:
    
    对象
  - getUserInfo
```
public UserInfoResponseDTO getUserInfo(Integer appIndex,
                                       String userId)
```
    从接口复制的说明: WXWorkService
    
    获取 user 信息
    
    指定者:
    
    getUserInfo 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    userId - 工号
    
    返回:
    
    对象
  - getDepartmentData
```
public DepartmentDataResponseDTO getDepartmentData(Integer appIndex,
                                                   Integer departmentId)
```
    从接口复制的说明: WXWorkService
    
    获取 department 部门列表
    
    指定者:
    
    getDepartmentData 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    departmentId - 部门 id，获取指定部门及其下的子部门（以及及子部门的子部门等等，递归），如果不填，默认获取全量组织架构
    
    返回:
    
    对象
  - getDepartmentUser
```
public DepartmentUserResponseDTO getDepartmentUser(Integer appIndex,
                                                   Integer departmentId,
                                                   Integer fetchChild)
```
    从接口复制的说明: WXWorkService
    
    获取 department 部门 user 简单信息
    
    指定者:
    
    getDepartmentUser 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    departmentId - 部门 id
    
    fetchChild - 是否递归获取子部门下面的成员（1-递归获取，0-只获取本部门）
    
    返回:
    
    对象
  - getTagData
```
public TagDataResponseDTO getTagData()
```
    从接口复制的说明: WXWorkService
    
    获取 tag 标签列表（token 必须由通讯录 secret 获取）
    
    指定者:
    
    getTagData 在接口中 WXWorkService
    
    返回:
    
    对象
  - getTagUser
```
public TagUserResponseDTO getTagUser(Integer tagId)
```
    从接口复制的说明: WXWorkService
    
    获取 tag 标签 user 简单信息（token 必须由通讯录 secret 获取）
    
    指定者:
    
    getTagUser 在接口中 WXWorkService
    
    参数:
    
    tagId - 标签 id
    
    返回:
    
    对象
  - sendAppTextMsgToUser
```
public AppMsgResponseDTO sendAppTextMsgToUser(Integer appIndex,
                                              String userId,
                                              String content)
```
    从接口复制的说明: WXWorkService
    
    发送应用文本消息
    
    指定者:
    
    sendAppTextMsgToUser 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    userId - 工号（多个工号之间用“|”隔开，不允许加空格，最多支持 1000 个）
    
    content - 文本内容
    
    返回:
    
    对象
  - sendAppTextMsgToUser
```
public AppMsgResponseDTO sendAppTextMsgToUser(Integer appIndex,
                                              List<String> userIdList,
                                              String content)
```
    从接口复制的说明: WXWorkService
    
    发送应用文本消息
    
    指定者:
    
    sendAppTextMsgToUser 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    userIdList - 工号集合（最多支持 1000 个）
    
    content - 文本内容
    
    返回:
    
    对象
  - sendAppTextMsgToDepartment
```
public AppMsgResponseDTO sendAppTextMsgToDepartment(Integer appIndex,
                                                    String departmentId,
                                                    String content)
```
    从接口复制的说明: WXWorkService
    
    发送应用文本消息
    
    指定者:
    
    sendAppTextMsgToDepartment 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    departmentId - 部门 id（多个部门 id 之间用“|”隔开，不允许加空格，最多支持 100 个）
    
    content - 文本内容
    
    返回:
    
    对象
  - sendAppTextMsgToDepartment
```
public AppMsgResponseDTO sendAppTextMsgToDepartment(Integer appIndex,
                                                    List<String> departmentIdList,
                                                    String content)
```
    从接口复制的说明: WXWorkService
    
    发送应用文本消息
    
    指定者:
    
    sendAppTextMsgToDepartment 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    departmentIdList - 部门 id 集合（最多支持 100 个）
    
    content - 文本内容
    
    返回:
    
    对象
  - sendAppTextMsgToTag
```
public AppMsgResponseDTO sendAppTextMsgToTag(Integer appIndex,
                                             String tagId,
                                             String content)
```
    从接口复制的说明: WXWorkService
    
    发送应用文本消息
    
    指定者:
    
    sendAppTextMsgToTag 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    tagId - 标签 id（多个标签 id 之间用“|”隔开，不允许加空格，最多支持 100 个）
    
    content - 文本内容
    
    返回:
    
    对象
  - sendAppTextMsgToTag
```
public AppMsgResponseDTO sendAppTextMsgToTag(Integer appIndex,
                                             List<String> tagIdList,
                                             String content)
```
    从接口复制的说明: WXWorkService
    
    发送应用文本消息
    
    指定者:
    
    sendAppTextMsgToTag 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    tagIdList - 标签 id 集合（最多支持 100 个）
    
    content - 文本内容
    
    返回:
    
    对象
  - uploadTemp
```
public AppUploadTempResponseDTO uploadTemp(Integer appIndex,
                                           WXWorkServiceImpl.UploadTypeEnum typeEnum,
                                           String filePath)
                                    throws IOException
```
    从接口复制的说明: WXWorkService
    
    上传临时素材
    
    指定者:
    
    uploadTemp 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    typeEnum - 临时素材类型
    
    filePath - 临时素材绝对路径
    
    返回:
    
    对象
    
    抛出:
    
    IOException - 异常
  - uploadImage
```
public AppUploadImageResponseDTO uploadImage(Integer appIndex,
                                             String filePath)
                                      throws IOException
```
    从接口复制的说明: WXWorkService
    
    上传图片
    
    指定者:
    
    uploadImage 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    filePath - 图片绝对路径
    
    返回:
    
    对象
    
    抛出:
    
    IOException - 异常
  - downloadTemp
```
public byte[] downloadTemp(Integer appIndex,
                           String mediaId)
```
    从接口复制的说明: WXWorkService
    
    获取临时素材
    
    指定者:
    
    downloadTemp 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    mediaId - 媒体文件 id
    
    返回:
    
    字节数组
  - downloadVoice
```
public byte[] downloadVoice(Integer appIndex,
                            String mediaId)
```
    从接口复制的说明: WXWorkService
    
    获取高清语音素材
    
    指定者:
    
    downloadVoice 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    mediaId - 媒体文件 id
    
    返回:
    
    字节数组
  - getCheckinData
```
public CheckinDataResponseDTO getCheckinData(Integer openCheckinDataType,
                                             Long startTime,
                                             Long endTime,
                                             List<String> userIdList)
```
    从接口复制的说明: WXWorkService
    
    获取打卡信息（token 必须由打卡 secret 获取）
    
    指定者:
    
    getCheckinData 在接口中 WXWorkService
    
    参数:
    
    openCheckinDataType - 打卡类型（1-上下班打卡，2-外出打卡，3-全部打卡）
    
    startTime - 获取打卡记录的开始时间（10 位 Unix 时间戳）
    
    endTime - 获取打卡记录的结束时间（10 位 Unix 时间戳）
    
    userIdList - 工号集合（至多 100 个）
    
    返回:
    
    对象
  - getTokenCache
```
public String getTokenCache(Integer appIndex)
```
    从接口复制的说明: WXWorkService
    
    获取 token 缓存
    
    指定者:
    
    getTokenCache 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    token
  - getToken
```
public String getToken(Integer appIndex)
```
    获取 token
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    token
  - getJsapiTicketCache
```
public String getJsapiTicketCache(Integer appIndex)
```
    从接口复制的说明: WXWorkService
    
    获取 jsapi_ticket 缓存
    
    指定者:
    
    getJsapiTicketCache 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    JsapiTicket
  - getJsapiTicket
```
public String getJsapiTicket(Integer appIndex)
```
    获取 jsapi_ticket
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    jsapiTicket
  - getJsapiTicketAgentCache
```
public String getJsapiTicketAgentCache(Integer appIndex)
```
    从接口复制的说明: WXWorkService
    
    获取 jsapi_ticket_agent 缓存
    
    指定者:
    
    getJsapiTicketAgentCache 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    JsapiTicketAgent
  - getJsapiTicketAgent
```
public String getJsapiTicketAgent(Integer appIndex)
```
    获取 jsapi_ticket
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    jsapiTicketAgent
  - verifyUrl
```
public boolean verifyUrl(Integer appIndex,
                         String msg_signature,
                         String timestamp,
                         String nonce,
                         String echostr,
                         javax.servlet.http.HttpServletResponse response)
```
    从接口复制的说明: WXWorkService
    
    验证 url
    
    指定者:
    
    verifyUrl 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    msg_signature - 企业微信加密签名，msg_signature计算结合了企业填写的token、请求中的timestamp、nonce、加密的消息体
    
    timestamp - 时间戳（与nonce结合使用，用于防止请求重放攻击）
    
    nonce - 随机数（与timestamp结合使用，用于防止请求重放攻击）
    
    echostr - 加密的字符串（需要解密得到消息内容明文，解密后有random、msg_len、msg、receiveid四个字段，其中msg即为消息内容明文）
    
    response - 响应
    
    返回:
    
    true-成功，false-失败
  - callback
```
public com.google.common.collect.Multimap<String,String> callback(Integer appIndex,
                                                                  String msg_signature,
                                                                  String timestamp,
                                                                  String nonce,
                                                                  String xml,
                                                                  javax.servlet.http.HttpServletResponse response)
```
    从接口复制的说明: WXWorkService
    
    处理 callback
    
    指定者:
    
    callback 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    msg_signature - 企业微信加密签名，msg_signature结合了企业填写的token、请求中的timestamp、nonce参数、加密的消息体
    
    timestamp - 时间戳（与nonce结合使用，用于防止请求重放攻击）
    
    nonce - 随机数（与timestamp结合使用，用于防止请求重放攻击）
    
    xml - 回调数据（放在 HTTP 请求体中，使用 @RequestBody 注解接收）
    
    response - 响应
    
    返回:
    
    k-v（LinkedHashMultimap，k 为完全限定节点名称，例如：grandparentNodeName.parentNodeName.nodeName）
  - xmlToMultimap
```
public static com.google.common.collect.Multimap<String,String> xmlToMultimap(String xmlStr)
```
    xml 转 map
    
    参数:
    
    xmlStr - xml 字符串
    
    返回:
    
    k-v（LinkedHashMultimap，k 为完全限定节点名称，例如：grandparentNodeName.parentNodeName.nodeName）
  - listNodes
```
public static void listNodes(org.dom4j.Element node,
                             com.google.common.collect.Multimap<String,String> map)
```
    递归遍历 xml 节点
    
    参数:
    
    node - xml 节点
    
    map - 载体
  - getFullyQualifiedNodeName
```
public static void getFullyQualifiedNodeName(org.dom4j.Element node,
                                             WXWorkServiceImpl.NodeName nodeName)
```
    递归获取完全限定节点名称，以英文点“.”分隔（例如：grandparentNodeName.parentNodeName.nodeName）
    
    参数:
    
    node - 节点
    
    nodeName - 自定义节点名称对象
  - getConfigSignature
```
public ConfigSignatureResponseDTO getConfigSignature(Integer appIndex,
                                                     String currentPageUrl)
```
    从接口复制的说明: WXWorkService
    
    获取 config 签名
    
    指定者:
    
    getConfigSignature 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    currentPageUrl - 当前页面 url
    
    返回:
    
    对象
  - getAgentConfigSignature
```
public AgentConfigSignatureResponseDTO getAgentConfigSignature(Integer appIndex,
                                                               String currentPageUrl)
```
    从接口复制的说明: WXWorkService
    
    获取 agentConfig 签名
    
    指定者:
    
    getAgentConfigSignature 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    currentPageUrl - 当前页面 url
    
    返回:
    
    对象
  - getCallbackIp
```
public CallbackIpResponseDTO getCallbackIp(Integer appIndex)
```
    从接口复制的说明: WXWorkService
    
    获取企业微信服务器的 ip 段
    
    指定者:
    
    getCallbackIp 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    对象
  - sendBotTextMsg
```
public BotMsgResponseDTO sendBotTextMsg(Integer appIndex,
                                        String content)
```
    从接口复制的说明: WXWorkService
    
    发送机器人文本消息
    
    指定者:
    
    sendBotTextMsg 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    content - 文本内容
    
    返回:
    
    对象
  - sendBotTextMsgAtUserId
```
public BotMsgResponseDTO sendBotTextMsgAtUserId(Integer appIndex,
                                                List<String> userIdList,
                                                String content)
```
    从接口复制的说明: WXWorkService
    
    发送机器人文本消息
    
    指定者:
    
    sendBotTextMsgAtUserId 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    userIdList - 工号集合，提醒群中的指定成员(@某个成员)，@all表示提醒所有人
    
    content - 文本内容
    
    返回:
    
    对象
  - sendBotTextMsgAtMobileNo
```
public BotMsgResponseDTO sendBotTextMsgAtMobileNo(Integer appIndex,
                                                  List<String> mobileNoList,
                                                  String content)
```
    从接口复制的说明: WXWorkService
    
    发送机器人文本消息
    
    指定者:
    
    sendBotTextMsgAtMobileNo 在接口中 WXWorkService
    
    参数:
    
    appIndex - 索引
    
    mobileNoList - 手机号码集合，提醒手机号对应的群成员(@某个成员)，@all表示提醒所有人
    
    content - 文本内容
    
    返回:
    
    对象

类 WXWorkServiceImpl

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

GSON

WXWORK_ALIAS

构造器详细资料

WXWorkServiceImpl

方法详细资料

afterPropertiesSet

getUserId

getUserInfo

getDepartmentData

getDepartmentUser

getTagData

getTagUser

sendAppTextMsgToUser

sendAppTextMsgToUser

sendAppTextMsgToDepartment

sendAppTextMsgToDepartment

sendAppTextMsgToTag

sendAppTextMsgToTag

uploadTemp

uploadImage

downloadTemp

downloadVoice

getCheckinData

getTokenCache

getToken

getJsapiTicketCache

getJsapiTicket

getJsapiTicketAgentCache

getJsapiTicketAgent

verifyUrl

callback

xmlToMultimap

listNodes

getFullyQualifiedNodeName

getConfigSignature

getAgentConfigSignature

getCallbackIp

sendBotTextMsg

sendBotTextMsgAtUserId

sendBotTextMsgAtMobileNo