me.chanjar.weixin.cp.api.impl

类 WxCpOaServiceImpl

java.lang.Object

me.chanjar.weixin.cp.api.impl.WxCpOaServiceImpl

所有已实现的接口:

WxCpOaService

public class WxCpOaServiceImpl
extends Object
implements WxCpOaService

企业微信 OA 接口实现

作者:

Element

构造器概要

构造器

构造器和说明
WxCpOaServiceImpl()

方法概要

限定符和类型	方法和说明
String	apply(WxCpOaApplyEventRequest request) 提交审批申请 调试工具 企业可通过审批应用或自建应用Secret调用本接口，代应用可见范围内员工在企业微信“审批应用”内提交指定类型的审批申请。
WxCpApprovalDetailResult	getApprovalDetail(@NonNull String spNo) 获取审批申请详情 企业可通过审批应用或自建应用Secret调用本接口，根据审批单号查询企业微信“审批应用”的审批申请详情。
WxCpApprovalInfo	getApprovalInfo(@NonNull Date startTime, @NonNull Date endTime) short method
WxCpApprovalInfo	getApprovalInfo(@NonNull Date startTime, @NonNull Date endTime, Integer cursor, Integer size, List<WxCpApprovalInfoQueryFilter> filters) 批量获取审批单号 审批应用及有权限的自建应用，可通过Secret调用本接口，以获取企业一段时间内企业微信“审批应用”单据的审批编号，支持按模板类型、申请人、部门、申请单审批状态等条件筛选。
List<WxCpCheckinData>	getCheckinData(Integer openCheckinDataType, Date startTime, Date endTime, List<String> userIdList) 获取打卡数据 API doc : https://work.weixin.qq.com/api/doc#90000/90135/90262
List<WxCpCheckinOption>	getCheckinOption(Date datetime, List<String> userIdList) 获取打卡规则 API doc : https://work.weixin.qq.com/api/doc#90000/90135/90263
List<WxCpDialRecord>	getDialRecord(Date startTime, Date endTime, Integer offset, Integer limit) 获取公费电话拨打记录
WxCpTemplateResult	getTemplateDetail(@NonNull String templateId) 获取审批模板详情

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

WxCpOaServiceImpl

public WxCpOaServiceImpl()

方法详细资料

apply

public String apply(WxCpOaApplyEventRequest request)
             throws WxErrorException

从接口复制的说明: WxCpOaService

提交审批申请
 调试工具
 企业可通过审批应用或自建应用Secret调用本接口，代应用可见范围内员工在企业微信“审批应用”内提交指定类型的审批申请。

 请求方式：POST（HTTPS）
 请求地址： https://qyapi.weixin.qq.com/cgi-bin/oa/applyevent?access_token=ACCESS_TOKEN
 文档地址：https://work.weixin.qq.com/api/doc/90000/90135/91853
 

指定者:

apply 在接口中 WxCpOaService

参数:

request - 请求

返回:

表单提交成功后，返回的表单编号

抛出:

WxErrorException - .

getCheckinData

public List<WxCpCheckinData> getCheckinData(Integer openCheckinDataType,
                                            Date startTime,
                                            Date endTime,
                                            List<String> userIdList)
                                     throws WxErrorException

从接口复制的说明: WxCpOaService

  获取打卡数据
  API doc : https://work.weixin.qq.com/api/doc#90000/90135/90262
 

指定者:

getCheckinData 在接口中 WxCpOaService

参数:

openCheckinDataType - 打卡类型。1：上下班打卡；2：外出打卡；3：全部打卡

startTime - 获取打卡记录的开始时间

endTime - 获取打卡记录的结束时间

userIdList - 需要获取打卡记录的用户列表

返回:

打卡数据列表

抛出:

WxErrorException - 异常

getCheckinOption

public List<WxCpCheckinOption> getCheckinOption(Date datetime,
                                                List<String> userIdList)
                                         throws WxErrorException

从接口复制的说明: WxCpOaService

   获取打卡规则
   API doc : https://work.weixin.qq.com/api/doc#90000/90135/90263
 

指定者:

getCheckinOption 在接口中 WxCpOaService

参数:

datetime - 需要获取规则的当天日期

userIdList - 需要获取打卡规则的用户列表

返回:

打卡规则列表

抛出:

WxErrorException - .

getApprovalInfo

public WxCpApprovalInfo getApprovalInfo(@NonNull
                                        @NonNull Date startTime,
                                        @NonNull
                                        @NonNull Date endTime,
                                        Integer cursor,
                                        Integer size,
                                        List<WxCpApprovalInfoQueryFilter> filters)
                                 throws WxErrorException

从接口复制的说明: WxCpOaService

 批量获取审批单号

 审批应用及有权限的自建应用，可通过Secret调用本接口，以获取企业一段时间内企业微信“审批应用”单据的审批编号，支持按模板类型、申请人、部门、申请单审批状态等条件筛选。
 自建应用调用此接口，需在“管理后台-应用管理-审批-API-审批数据权限”中，授权应用允许提交审批单据。

 一次拉取调用最多拉取100个审批记录，可以通过多次拉取的方式来满足需求，但调用频率不可超过600次/分。

 API doc : https://work.weixin.qq.com/api/doc/90000/90135/91816
 

指定者:

getApprovalInfo 在接口中 WxCpOaService

参数:

startTime - 开始时间

endTime - 结束时间

cursor - 分页查询游标，默认为0，后续使用返回的next_cursor进行分页拉取

size - 一次请求拉取审批单数量，默认值为100，上限值为100

filters - 筛选条件，可对批量拉取的审批申请设置约束条件，支持设置多个条件,nullable

返回:

WxCpApprovalInfo

抛出:

WxErrorException - .

getApprovalInfo

public WxCpApprovalInfo getApprovalInfo(@NonNull
                                        @NonNull Date startTime,
                                        @NonNull
                                        @NonNull Date endTime)
                                 throws WxErrorException

从接口复制的说明: WxCpOaService

short method

指定者:

getApprovalInfo 在接口中 WxCpOaService

参数:

startTime - 开始时间

endTime - 结束时间

返回:

WxCpApprovalInfo

抛出:

WxErrorException - .

另请参阅:

WxCpOaService.getApprovalInfo(java.util.Date, java.util.Date, java.lang.Integer, java.lang.Integer, java.util.List<me.chanjar.weixin.cp.bean.oa.WxCpApprovalInfoQueryFilter>)

getApprovalDetail

public WxCpApprovalDetailResult getApprovalDetail(@NonNull
                                                  @NonNull String spNo)
                                           throws WxErrorException

从接口复制的说明: WxCpOaService

   获取审批申请详情

   企业可通过审批应用或自建应用Secret调用本接口，根据审批单号查询企业微信“审批应用”的审批申请详情。

   API Doc : https://work.weixin.qq.com/api/doc/90000/90135/91983
 

指定者:

getApprovalDetail 在接口中 WxCpOaService

参数:

spNo - 审批单编号。

返回:

WxCpApprovaldetail

抛出:

WxErrorException - .

getDialRecord

public List<WxCpDialRecord> getDialRecord(Date startTime,
                                          Date endTime,
                                          Integer offset,
                                          Integer limit)
                                   throws WxErrorException

从接口复制的说明: WxCpOaService

获取公费电话拨打记录

指定者:

getDialRecord 在接口中 WxCpOaService

参数:

startTime - 查询的起始时间戳

endTime - 查询的结束时间戳

offset - 分页查询的偏移量

limit - 分页查询的每页大小,默认为100条，如该参数大于100则按100处理

返回:

.

抛出:

WxErrorException - .

getTemplateDetail

public WxCpTemplateResult getTemplateDetail(@NonNull
                                            @NonNull String templateId)
                                     throws WxErrorException

从接口复制的说明: WxCpOaService

获取审批模板详情

指定者:

getTemplateDetail 在接口中 WxCpOaService

参数:

templateId - 模板ID

返回:

.

抛出:

WxErrorException - .