xiongwei.jiang.service

接口 WXWorkService

所有已知实现类:

WXWorkServiceImpl

public interface WXWorkService

企业微信服务接口

作者:

天之蓝

方法概要

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

方法详细资料

getToken

String getToken(WXWorkApiType type,
                String name,
                String corpId,
                String secret)

企业内部开发 / 服务端API / 开发指南 / 获取access_token

参数:

type - WXWorkApiType

name - 名称

corpId - 客户端编号

secret - 客户端密钥

返回:

令牌

getTokenCache

String getTokenCache(WXWorkApiType type,
                     String name,
                     String corpId,
                     String secret)

企业内部开发 / 服务端API / 开发指南 / 获取access_token

参数:

type - WXWorkApiType

name - 名称

corpId - 客户端编号

secret - 客户端密钥

返回:

令牌

另请参阅:

getToken(WXWorkApiType, String, String, String)

verifyUrl

void verifyUrl(String name,
               String msg_signature,
               String timestamp,
               String nonce,
               String echostr,
               javax.servlet.http.HttpServletResponse response)

企业内部开发 / 服务端API / 开发指南 / 回调配置 / 支持Http Get请求验证URL有效性

参数:

name - 名称

msg_signature - 企业微信加密签名，msg_signature计算结合了企业填写的token、请求中的timestamp、nonce、加密的消息体

timestamp - 时间戳（与nonce结合使用，用于防止请求重放攻击）

nonce - 随机数（与timestamp结合使用，用于防止请求重放攻击）

echostr - 加密的字符串（需要解密得到消息内容明文，解密后有random、msg_len、msg、receiveid四个字段，其中msg即为消息内容明文）

response - 响应

callback

Map<String,Object> callback(String name,
                            String msg_signature,
                            String timestamp,
                            String nonce,
                            String xml,
                            javax.servlet.http.HttpServletResponse response)

企业内部开发 / 服务端API / 开发指南 / 回调配置 / 支持Http Post请求接收业务数据

参数:

name - 名称

msg_signature - 企业微信加密签名，msg_signature结合了企业填写的token、请求中的timestamp、nonce参数、加密的消息体

timestamp - 时间戳（与nonce结合使用，用于防止请求重放攻击）

nonce - 随机数（与timestamp结合使用，用于防止请求重放攻击）

xml - 回调数据（放在 HTTP 请求体中，使用注解 RequestBody 接收）

response - 响应

返回:

Map

getUserInfo

UserInfo getUserInfo(WXWorkApiType type,
                     String name,
                     String userId)

企业内部开发 / 服务端API / 通讯录管理 / 成员管理 / 读取成员

参数:

type - WXWorkApiType，可选 WXWorkApiType.CONTACT 和 WXWorkApiType.APP

name - 名称

userId - 工号

返回:

UserInfo

getDepartmentUser

DepartmentUser getDepartmentUser(WXWorkApiType type,
                                 String name,
                                 int departmentId,
                                 State fetchChild)

企业内部开发 / 服务端API / 通讯录管理 / 成员管理 / 获取部门成员

参数:

type - WXWorkApiType，可选 WXWorkApiType.CONTACT 和 WXWorkApiType.APP

name - 名称

departmentId - 部门 id

fetchChild - 是否递归获取子部门下面的成员（1-递归获取，0-只获取本部门）

返回:

DepartmentUser

getDepartmentList

DepartmentList getDepartmentList(WXWorkApiType type,
                                 String name,
                                 int departmentId)

企业内部开发 / 服务端API / 通讯录管理 / 部门管理 / 获取部门列表

参数:

type - WXWorkApiType，可选 WXWorkApiType.CONTACT 和 WXWorkApiType.APP

name - 名称

departmentId - 部门 id，获取指定部门及其下的子部门（以及子部门的子部门等等，递归）；如果不填，默认获取全量组织架构

返回:

DepartmentList

getTagUser

TagUser getTagUser(WXWorkApiType type,
                   String name,
                   int tagId)

企业内部开发 / 服务端API / 通讯录管理 / 标签管理 / 获取标签成员

参数:

type - WXWorkApiType，可选 WXWorkApiType.CONTACT 和 WXWorkApiType.APP

name - 名称

tagId - 标签 id

返回:

TagUser

getTagList

TagList getTagList(WXWorkApiType type,
                   String name)

企业内部开发 / 服务端API / 通讯录管理 / 标签管理 / 获取标签列表

参数:

type - WXWorkApiType，可选 WXWorkApiType.CONTACT 和 WXWorkApiType.APP

name - 名称

返回:

TagList

getUser

User getUser(String name,
             String code)

企业内部开发 / 服务端API / 身份验证 / 网页授权登录 / 获取访问用户身份

参数:

name - 名称

code - 企业微信授权码，仅可使用一次，5 分钟内有效

返回:

User

sendAppTextMsg

AppMsg sendAppTextMsg(String name,
                      TextAppMsg object)

企业内部开发 / 服务端API / 消息推送 / 发送应用消息 / 文本消息

参数:

name - 名称

object - TextAppMsg

返回:

AppMsg

sendAppMarkdownMsg

AppMsg sendAppMarkdownMsg(String name,
                          MarkdownAppMsg object)

企业内部开发 / 服务端API / 消息推送 / 发送应用消息 / markdown消息

参数:

name - 名称

object - MarkdownAppMsg

返回:

AppMsg

uploadTemp

UploadTemp uploadTemp(String name,
                      UploadTempType tempType,
                      String filePath)

企业内部开发 / 服务端API / 素材管理 / 上传临时素材

参数:

name - 名称

tempType - UploadTempType

filePath - 临时素材绝对路径

返回:

UploadTemp

uploadImage

UploadImage uploadImage(String name,
                        String filePath)

企业内部开发 / 服务端API / 素材管理 / 上传图片

参数:

name - 名称

filePath - 图片绝对路径

返回:

UploadImage

downloadTemp

byte[] downloadTemp(String name,
                    String mediaId)

企业内部开发 / 服务端API / 素材管理 / 获取临时素材

参数:

name - 名称

mediaId - 媒体文件 id

返回:

字节数组

downloadVoice

byte[] downloadVoice(String name,
                     String mediaId)

企业内部开发 / 服务端API / 素材管理 / 获取高清语音素材

参数:

name - 名称

mediaId - 媒体文件 id

返回:

字节数组

getCheckinRecord

CheckinRecord getCheckinRecord(String name,
                               CheckinType openCheckinDataType,
                               long startTime,
                               long endTime,
                               List<String> userIdList)

企业内部开发 / 服务端API / OA / 打卡 / 获取打卡记录数据

参数:

name - 名称

openCheckinDataType - 打卡类型（1-上下班打卡，2-外出打卡，3-全部打卡）

startTime - 获取打卡记录的开始时间（10 位 Unix 时间戳）

endTime - 获取打卡记录的结束时间（10 位 Unix 时间戳）

userIdList - 工号集合（至多 100 个）

返回:

CheckinRecord

getCorpTicket

String getCorpTicket(String name)

企业内部开发 / 客户端API / JS-SDK / 附录 / JS-SDK使用权限签名算法 / 获取企业的jsapi_ticket

参数:

name - 名称

返回:

企业凭证

getCorpTicketCache

String getCorpTicketCache(String name)

企业内部开发 / 客户端API / JS-SDK / 附录 / JS-SDK使用权限签名算法 / 获取企业的jsapi_ticket

参数:

name - 名称

返回:

企业凭证

另请参阅:

getCorpTicket(String)

getAppTicket

String getAppTicket(String name)

企业内部开发 / 客户端API / JS-SDK / 附录 / JS-SDK使用权限签名算法 / 获取应用的jsapi_ticket

参数:

name - 名称

返回:

应用凭证

getAppTicketCache

String getAppTicketCache(String name)

企业内部开发 / 客户端API / JS-SDK / 附录 / JS-SDK使用权限签名算法 / 获取应用的jsapi_ticket

参数:

name - 名称

返回:

应用凭证

另请参阅:

getAppTicket(String)

getCorpConfig

Map<String,Object> getCorpConfig(String name,
                                 String webUrl)

企业内部开发 / 客户端API / JS-SDK / 开始开发 / 使用说明 / 通过config接口注入权限验证配置

参数:

name - 名称

webUrl - window.location.href

返回:

Map

getAppConfig

Map<String,Object> getAppConfig(String name,
                                String webUrl)

企业内部开发 / 客户端API / JS-SDK / 基础接口 / wx.agentConfig / 通过agentConfig注入应用的权限

参数:

name - 名称

webUrl - window.location.href

返回:

Map

sendBotTextMsg

Result sendBotTextMsg(String name,
                      TextBotMsg object)

企业内部开发 / 客户端API / 群机器人 / 群机器人配置说明 / 文本类型

参数:

name - 名称

object - TextBotMsg

返回:

Result

sendBotMarkdownMsg

Result sendBotMarkdownMsg(String name,
                          MarkdownBotMsg object)

企业内部开发 / 客户端API / 群机器人 / 群机器人配置说明 / markdown类型

参数:

name - 名称

object - MarkdownBotMsg

返回:

Result