WXWorkService (wxwork-spring-boot-starter 1.2.4 API)

所有已知实现类:

WXWorkServiceImpl
```
public interface WXWorkService
```
企业微信服务接口

作者:

天之蓝

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`Map<String,Object>`	`callback(int callbackIndex, String msg_signature, String timestamp, String nonce, String xml, javax.servlet.http.HttpServletResponse response)` 企业内部开发 > 服务端API > 开发指南 > 回调配置 > 支持Http Post请求接收业务数据
`byte[]`	`downloadTemp(int appIndex, String mediaId)` 企业内部开发 > 服务端API > 素材管理 > 获取临时素材
`byte[]`	`downloadVoice(int appIndex, String mediaId)` 企业内部开发 > 服务端API > 素材管理 > 获取高清语音素材
`Map<String,Object>`	`getAppConfig(int appIndex, String webUrl)` 企业内部开发 > 客户端API > JS-SDK > 基础接口 > wx.agentConfig > 通过agentConfig注入应用的权限
`String`	`getAppTicket(int appIndex)` 企业内部开发 > 客户端API > JS-SDK > 附录 > JS-SDK使用权限签名算法 > 获取应用的jsapi_ticket
`String`	`getAppTicketCache(int appIndex)` 企业内部开发 > 客户端API > JS-SDK > 附录 > JS-SDK使用权限签名算法 > 获取应用的jsapi_ticket
`CheckinRecord`	`getCheckinRecord(int openCheckinDataType, long startTime, long endTime, List<String> userIdList)` 企业内部开发 > 服务端API > OA > 打卡 > 获取打卡记录数据
`Map<String,Object>`	`getCorpConfig(int appIndex, String webUrl)` 企业内部开发 > 客户端API > JS-SDK > 开始开发 > 使用说明 > 通过config接口注入权限验证配置
`String`	`getCorpTicket(int appIndex)` 企业内部开发 > 客户端API > JS-SDK > 附录 > JS-SDK使用权限签名算法 > 获取企业的jsapi_ticket
`String`	`getCorpTicketCache(int appIndex)` 企业内部开发 > 客户端API > JS-SDK > 附录 > JS-SDK使用权限签名算法 > 获取企业的jsapi_ticket
`DepartmentList`	`getDepartmentList(int appIndex, int departmentId)` 企业内部开发 > 服务端API > 通讯录管理 > 部门管理 > 获取部门列表
`DepartmentUser`	`getDepartmentUser(int appIndex, int departmentId, int fetchChild)` 企业内部开发 > 服务端API > 通讯录管理 > 成员管理 > 获取部门成员
`TagList`	`getTagList()` 企业内部开发 > 服务端API > 通讯录管理 > 标签管理 > 获取标签列表
`TagUser`	`getTagUser(int tagId)` 企业内部开发 > 服务端API > 通讯录管理 > 标签管理 > 获取标签成员
`String`	`getToken(int appIndex)` 企业内部开发 > 服务端API > 开发指南 > 获取access_token
`String`	`getTokenCache(int appIndex)` 企业内部开发 > 服务端API > 开发指南 > 获取access_token
`User`	`getUser(int appIndex, String code)` 企业内部开发 > 服务端API > 身份验证 > 网页授权登录 > 获取访问用户身份
`UserInfo`	`getUserInfo(int appIndex, String userId)` 企业内部开发 > 服务端API > 通讯录管理 > 成员管理 > 读取成员
`AppMsg`	`sendAppMarkdownMsg(int appIndex, AppMarkdownMsg object)` 企业内部开发 > 服务端API > 消息推送 > 发送应用消息 > markdown消息
`AppMsg`	`sendAppTextMsg(int appIndex, AppTextMsg object)` 企业内部开发 > 服务端API > 消息推送 > 发送应用消息 > 文本消息
`BotMsg`	`sendBotMarkdownMsg(int botIndex, BotMarkdownMsg object)` 企业内部开发 > 客户端API > 群机器人 > 群机器人配置说明 > markdown类型
`BotMsg`	`sendBotTextMsg(int botIndex, BotTextMsg object)` 企业内部开发 > 客户端API > 群机器人 > 群机器人配置说明 > 文本类型
`UploadImage`	`uploadImage(int appIndex, String filePath)` 企业内部开发 > 服务端API > 素材管理 > 上传图片
`UploadTemp`	`uploadTemp(int appIndex, UploadTempType tempType, String filePath)` 企业内部开发 > 服务端API > 素材管理 > 上传临时素材
`void`	`verifyUrl(int callbackIndex, String msg_signature, String timestamp, String nonce, String echostr, javax.servlet.http.HttpServletResponse response)` 企业内部开发 > 服务端API > 开发指南 > 回调配置 > 支持Http Get请求验证URL有效性

- 方法详细资料
  - getToken
```
String getToken(int appIndex)
```
    企业内部开发 > 服务端API > 开发指南 > 获取access_token
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    访问令牌
  - getTokenCache
```
String getTokenCache(int appIndex)
```
    企业内部开发 > 服务端API > 开发指南 > 获取access_token
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    访问令牌
    
    另请参阅:
    
    getToken(int)
  - verifyUrl
```
void verifyUrl(int callbackIndex,
               String msg_signature,
               String timestamp,
               String nonce,
               String echostr,
               javax.servlet.http.HttpServletResponse response)
```
    企业内部开发 > 服务端API > 开发指南 > 回调配置 > 支持Http Get请求验证URL有效性
    
    参数:
    
    callbackIndex - 索引
    
    msg_signature - 企业微信加密签名，msg_signature计算结合了企业填写的token、请求中的timestamp、nonce、加密的消息体
    
    timestamp - 时间戳（与nonce结合使用，用于防止请求重放攻击）
    
    nonce - 随机数（与timestamp结合使用，用于防止请求重放攻击）
    
    echostr - 加密的字符串（需要解密得到消息内容明文，解密后有random、msg_len、msg、receiveid四个字段，其中msg即为消息内容明文）
    
    response - 响应
  - callback
```
Map<String,Object> callback(int callbackIndex,
                            String msg_signature,
                            String timestamp,
                            String nonce,
                            String xml,
                            javax.servlet.http.HttpServletResponse response)
```
    企业内部开发 > 服务端API > 开发指南 > 回调配置 > 支持Http Post请求接收业务数据
    
    参数:
    
    callbackIndex - 索引
    
    msg_signature - 企业微信加密签名，msg_signature结合了企业填写的token、请求中的timestamp、nonce参数、加密的消息体
    
    timestamp - 时间戳（与nonce结合使用，用于防止请求重放攻击）
    
    nonce - 随机数（与timestamp结合使用，用于防止请求重放攻击）
    
    xml - 回调数据（放在 HTTP 请求体中，使用注解 RequestBody 接收）
    
    response - 响应
    
    返回:
    
    Map
  - getUserInfo
```
UserInfo getUserInfo(int appIndex,
                     String userId)
```
    企业内部开发 > 服务端API > 通讯录管理 > 成员管理 > 读取成员
    
    参数:
    
    appIndex - 索引
    
    userId - 工号
    
    返回:
    
    UserInfo
  - getDepartmentUser
```
DepartmentUser getDepartmentUser(int appIndex,
                                 int departmentId,
                                 int fetchChild)
```
    企业内部开发 > 服务端API > 通讯录管理 > 成员管理 > 获取部门成员
    
    参数:
    
    appIndex - 索引
    
    departmentId - 部门 id
    
    fetchChild - 是否递归获取子部门下面的成员（1-递归获取，0-只获取本部门）
    
    返回:
    
    DepartmentUser
  - getDepartmentList
```
DepartmentList getDepartmentList(int appIndex,
                                 int departmentId)
```
    企业内部开发 > 服务端API > 通讯录管理 > 部门管理 > 获取部门列表
    
    参数:
    
    appIndex - 索引
    
    departmentId - 部门 id，获取指定部门及其下的子部门（以及子部门的子部门等等，递归）；如果不填，默认获取全量组织架构
    
    返回:
    
    DepartmentList
  - getTagUser
```
TagUser getTagUser(int tagId)
```
    企业内部开发 > 服务端API > 通讯录管理 > 标签管理 > 获取标签成员
    
    参数:
    
    tagId - 标签 id
    
    返回:
    
    TagUser
  - getTagList
```
TagList getTagList()
```
    企业内部开发 > 服务端API > 通讯录管理 > 标签管理 > 获取标签列表
    
    返回:
    
    TagList
  - getUser
```
User getUser(int appIndex,
             String code)
```
    企业内部开发 > 服务端API > 身份验证 > 网页授权登录 > 获取访问用户身份
    
    参数:
    
    appIndex - 索引
    
    code - 企业微信授权码，仅可使用一次，5 分钟内有效
    
    返回:
    
    User
  - sendAppTextMsg
```
AppMsg sendAppTextMsg(int appIndex,
                      AppTextMsg object)
```
    企业内部开发 > 服务端API > 消息推送 > 发送应用消息 > 文本消息
    
    参数:
    
    appIndex - 索引
    
    object - AppTextMsg
    
    返回:
    
    AppMsg
  - sendAppMarkdownMsg
```
AppMsg sendAppMarkdownMsg(int appIndex,
                          AppMarkdownMsg object)
```
    企业内部开发 > 服务端API > 消息推送 > 发送应用消息 > markdown消息
    
    参数:
    
    appIndex - 索引
    
    object - AppMarkdownMsg
    
    返回:
    
    AppMsg
  - uploadTemp
```
UploadTemp uploadTemp(int appIndex,
                      UploadTempType tempType,
                      String filePath)
```
    企业内部开发 > 服务端API > 素材管理 > 上传临时素材
    
    参数:
    
    appIndex - 索引
    
    tempType - UploadTempType
    
    filePath - 临时素材绝对路径
    
    返回:
    
    UploadTemp
  - uploadImage
```
UploadImage uploadImage(int appIndex,
                        String filePath)
```
    企业内部开发 > 服务端API > 素材管理 > 上传图片
    
    参数:
    
    appIndex - 索引
    
    filePath - 图片绝对路径
    
    返回:
    
    UploadImage
  - downloadTemp
```
byte[] downloadTemp(int appIndex,
                    String mediaId)
```
    企业内部开发 > 服务端API > 素材管理 > 获取临时素材
    
    参数:
    
    appIndex - 索引
    
    mediaId - 媒体文件 id
    
    返回:
    
    字节数组
  - downloadVoice
```
byte[] downloadVoice(int appIndex,
                     String mediaId)
```
    企业内部开发 > 服务端API > 素材管理 > 获取高清语音素材
    
    参数:
    
    appIndex - 索引
    
    mediaId - 媒体文件 id
    
    返回:
    
    字节数组
  - getCheckinRecord
```
CheckinRecord getCheckinRecord(int openCheckinDataType,
                               long startTime,
                               long endTime,
                               List<String> userIdList)
```
    企业内部开发 > 服务端API > OA > 打卡 > 获取打卡记录数据
    
    参数:
    
    openCheckinDataType - 打卡类型（1-上下班打卡，2-外出打卡，3-全部打卡）
    
    startTime - 获取打卡记录的开始时间（10 位 Unix 时间戳）
    
    endTime - 获取打卡记录的结束时间（10 位 Unix 时间戳）
    
    userIdList - 工号集合（至多 100 个）
    
    返回:
    
    CheckinRecord
  - getCorpConfig
```
Map<String,Object> getCorpConfig(int appIndex,
                                 String webUrl)
```
    企业内部开发 > 客户端API > JS-SDK > 开始开发 > 使用说明 > 通过config接口注入权限验证配置
    
    参数:
    
    appIndex - 索引
    
    webUrl - window.location.href
    
    返回:
    
    Map
  - getAppConfig
```
Map<String,Object> getAppConfig(int appIndex,
                                String webUrl)
```
    企业内部开发 > 客户端API > JS-SDK > 基础接口 > wx.agentConfig > 通过agentConfig注入应用的权限
    
    参数:
    
    appIndex - 索引
    
    webUrl - window.location.href
    
    返回:
    
    Map
  - getCorpTicket
```
String getCorpTicket(int appIndex)
```
    企业内部开发 > 客户端API > JS-SDK > 附录 > JS-SDK使用权限签名算法 > 获取企业的jsapi_ticket
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    企业凭证
  - getCorpTicketCache
```
String getCorpTicketCache(int appIndex)
```
    企业内部开发 > 客户端API > JS-SDK > 附录 > JS-SDK使用权限签名算法 > 获取企业的jsapi_ticket
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    企业凭证
    
    另请参阅:
    
    getCorpTicket(int)
  - getAppTicket
```
String getAppTicket(int appIndex)
```
    企业内部开发 > 客户端API > JS-SDK > 附录 > JS-SDK使用权限签名算法 > 获取应用的jsapi_ticket
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    应用凭证
  - getAppTicketCache
```
String getAppTicketCache(int appIndex)
```
    企业内部开发 > 客户端API > JS-SDK > 附录 > JS-SDK使用权限签名算法 > 获取应用的jsapi_ticket
    
    参数:
    
    appIndex - 索引
    
    返回:
    
    应用凭证
    
    另请参阅:
    
    getAppTicket(int)
  - sendBotTextMsg
```
BotMsg sendBotTextMsg(int botIndex,
                      BotTextMsg object)
```
    企业内部开发 > 客户端API > 群机器人 > 群机器人配置说明 > 文本类型
    
    参数:
    
    botIndex - 索引
    
    object - BotTextMsg
    
    返回:
    
    BotMsg
  - sendBotMarkdownMsg
```
BotMsg sendBotMarkdownMsg(int botIndex,
                          BotMarkdownMsg object)
```
    企业内部开发 > 客户端API > 群机器人 > 群机器人配置说明 > markdown类型
    
    参数:
    
    botIndex - 索引
    
    object - BotMarkdownMsg
    
    返回:
    
    BotMsg

接口 WXWorkService

方法概要

方法详细资料

getToken

getTokenCache

verifyUrl

callback

getUserInfo

getDepartmentUser

getDepartmentList

getTagUser

getTagList

getUser

sendAppTextMsg

sendAppMarkdownMsg

uploadTemp

uploadImage

downloadTemp

downloadVoice

getCheckinRecord

getCorpConfig

getAppConfig

getCorpTicket

getCorpTicketCache

getAppTicket

getAppTicketCache

sendBotTextMsg

sendBotMarkdownMsg