com.kdayun.wecom.cp.api

接口 WxCpOaService

所有已知实现类:

WxCpOaServiceImpl

public interface WxCpOaService

企业微信OA相关接口.

方法概要

限定符和类型	方法和说明
java.lang.String	apply(WxCpOaApplyEventRequest request) 提交审批申请 调试工具 企业可通过审批应用或自建应用Secret调用本接口，代应用可见范围内员工在企业微信“审批应用”内提交指定类型的审批申请。
WxCpApprovalDetailResult	getApprovalDetail(@NonNull java.lang.String spNo) 获取审批申请详情 企业可通过审批应用或自建应用Secret调用本接口，根据审批单号查询企业微信“审批应用”的审批申请详情。
WxCpApprovalInfo	getApprovalInfo(@NonNull java.util.Date startTime, @NonNull java.util.Date endTime) short method
WxCpApprovalInfo	getApprovalInfo(@NonNull java.util.Date startTime, @NonNull java.util.Date endTime, java.lang.Integer cursor, java.lang.Integer size, java.util.List<WxCpApprovalInfoQueryFilter> filters) 批量获取审批单号 审批应用及有权限的自建应用，可通过Secret调用本接口，以获取企业一段时间内企业微信“审批应用”单据的审批编号，支持按模板类型、申请人、部门、申请单审批状态等条件筛选。
java.util.List<WxCpCheckinData>	getCheckinData(java.lang.Integer openCheckinDataType, java.util.Date startTime, java.util.Date endTime, java.util.List<java.lang.String> userIdList) 获取打卡数据 API doc : https://work.weixin.qq.com/api/doc#90000/90135/90262
java.util.List<WxCpCheckinDayData>	getCheckinDayData(java.util.Date startTime, java.util.Date endTime, java.util.List<java.lang.String> userIdList) 获取打卡日报数据
java.util.List<WxCpCheckinMonthData>	getCheckinMonthData(java.util.Date startTime, java.util.Date endTime, java.util.List<java.lang.String> userIdList) 获取打卡月报数据
java.util.List<WxCpCheckinOption>	getCheckinOption(java.util.Date datetime, java.util.List<java.lang.String> userIdList) 获取打卡规则 API doc : https://work.weixin.qq.com/api/doc#90000/90135/90263
java.util.List<WxCpCheckinSchedule>	getCheckinScheduleList(java.util.Date startTime, java.util.Date endTime, java.util.List<java.lang.String> userIdList) 获取打卡人员排班信息
WxCpCorpConfInfo	getCorpConf() 获取企业假期管理配置 企业可通过审批应用或自建应用Secret调用本接口，获取可见范围内员工的“假期管理”配置，包括：各个假期的id、名称、请假单位、时长计算方式、发放规则等。
java.util.List<WxCpCropCheckinOption>	getCropCheckinOption() 获取企业所有打卡规则 API doc : https://work.weixin.qq.com/api/doc/90000/90135/93384
java.util.List<WxCpDialRecord>	getDialRecord(java.util.Date startTime, java.util.Date endTime, java.lang.Integer offset, java.lang.Integer limit) 获取公费电话拨打记录
WxCpTemplateResult	getTemplateDetail(@NonNull java.lang.String templateId) 获取审批模板详情
void	setCheckinScheduleList(WxCpSetCheckinSchedule wxCpSetCheckinSchedule) 为打卡人员排班

方法详细资料

apply

java.lang.String apply(WxCpOaApplyEventRequest request)
                throws me.chanjar.weixin.common.error.WxErrorException

提交审批申请
 调试工具
 企业可通过审批应用或自建应用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
 

参数:

request - 请求

返回:

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

抛出:

me.chanjar.weixin.common.error.WxErrorException - .

getCheckinData

java.util.List<WxCpCheckinData> getCheckinData(java.lang.Integer openCheckinDataType,
                                               java.util.Date startTime,
                                               java.util.Date endTime,
                                               java.util.List<java.lang.String> userIdList)
                                        throws me.chanjar.weixin.common.error.WxErrorException

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

参数:

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

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

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

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

返回:

打卡数据列表 checkin data

抛出:

me.chanjar.weixin.common.error.WxErrorException - 异常

getCheckinOption

java.util.List<WxCpCheckinOption> getCheckinOption(java.util.Date datetime,
                                                   java.util.List<java.lang.String> userIdList)
                                            throws me.chanjar.weixin.common.error.WxErrorException

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

参数:

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

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

返回:

打卡规则列表 checkin option

抛出:

me.chanjar.weixin.common.error.WxErrorException - .

getCropCheckinOption

java.util.List<WxCpCropCheckinOption> getCropCheckinOption()
                                                    throws me.chanjar.weixin.common.error.WxErrorException

   获取企业所有打卡规则
   API doc : https://work.weixin.qq.com/api/doc/90000/90135/93384
 

返回:

打卡规则列表

抛出:

me.chanjar.weixin.common.error.WxErrorException - the wx error exception

getApprovalInfo

WxCpApprovalInfo getApprovalInfo(@NonNull
                                 @NonNull java.util.Date startTime,
                                 @NonNull
                                 @NonNull java.util.Date endTime,
                                 java.lang.Integer cursor,
                                 java.lang.Integer size,
                                 java.util.List<WxCpApprovalInfoQueryFilter> filters)
                          throws me.chanjar.weixin.common.error.WxErrorException

 批量获取审批单号

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

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

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

参数:

startTime - 开始时间

endTime - 结束时间

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

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

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

返回:

WxCpApprovalInfo approval info

抛出:

me.chanjar.weixin.common.error.WxErrorException - .

getApprovalInfo

WxCpApprovalInfo getApprovalInfo(@NonNull
                                 @NonNull java.util.Date startTime,
                                 @NonNull
                                 @NonNull java.util.Date endTime)
                          throws me.chanjar.weixin.common.error.WxErrorException

short method

参数:

startTime - 开始时间

endTime - 结束时间

返回:

WxCpApprovalInfo approval info

抛出:

me.chanjar.weixin.common.error.WxErrorException - .

另请参阅:

com.kdayun.wecom.cp.api.WxCpOaService#getApprovalInfo

getApprovalDetail

WxCpApprovalDetailResult getApprovalDetail(@NonNull
                                           @NonNull java.lang.String spNo)
                                    throws me.chanjar.weixin.common.error.WxErrorException

   获取审批申请详情

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

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

参数:

spNo - 审批单编号。

返回:

WxCpApprovaldetail approval detail

抛出:

me.chanjar.weixin.common.error.WxErrorException - .

getCorpConf

WxCpCorpConfInfo getCorpConf()
                      throws me.chanjar.weixin.common.error.WxErrorException

获取企业假期管理配置 企业可通过审批应用或自建应用Secret调用本接口，获取可见范围内员工的“假期管理”配置，包括：各个假期的id、名称、请假单位、时长计算方式、发放规则等。 第三方应用可获取应用可见范围内员工的“假期管理”配置，包括：各个假期的id、名称、请假单位、时长计算方式、发放规则等。 请求方式：GET(HTTPS) 请求地址：https://qyapi.weixin.qq.com/cgi-bin/oa/vacation/getcorpconf?access_token=ACCESS_TOKEN

返回:

管理配置

抛出:

me.chanjar.weixin.common.error.WxErrorException - 出错抛出异常

getDialRecord

java.util.List<WxCpDialRecord> getDialRecord(java.util.Date startTime,
                                             java.util.Date endTime,
                                             java.lang.Integer offset,
                                             java.lang.Integer limit)
                                      throws me.chanjar.weixin.common.error.WxErrorException

获取公费电话拨打记录

参数:

startTime - 查询的起始时间戳

endTime - 查询的结束时间戳

offset - 分页查询的偏移量

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

返回:

. dial record

抛出:

me.chanjar.weixin.common.error.WxErrorException - .

getTemplateDetail

WxCpTemplateResult getTemplateDetail(@NonNull
                                     @NonNull java.lang.String templateId)
                              throws me.chanjar.weixin.common.error.WxErrorException

获取审批模板详情

参数:

templateId - 模板ID

返回:

. template detail

抛出:

me.chanjar.weixin.common.error.WxErrorException - .

getCheckinDayData

java.util.List<WxCpCheckinDayData> getCheckinDayData(java.util.Date startTime,
                                                     java.util.Date endTime,
                                                     java.util.List<java.lang.String> userIdList)
                                              throws me.chanjar.weixin.common.error.WxErrorException

获取打卡日报数据

参数:

startTime - 获取日报的开始时间

endTime - 获取日报的结束时间

userIdList - 获取日报的userid列表

返回:

日报数据列表 checkin day data

抛出:

me.chanjar.weixin.common.error.WxErrorException - the wx error exception

getCheckinMonthData

java.util.List<WxCpCheckinMonthData> getCheckinMonthData(java.util.Date startTime,
                                                         java.util.Date endTime,
                                                         java.util.List<java.lang.String> userIdList)
                                                  throws me.chanjar.weixin.common.error.WxErrorException

获取打卡月报数据

参数:

startTime - 获取月报的开始时间

endTime - 获取月报的结束时间

userIdList - 获取月报的userid列表

返回:

月报数据列表

抛出:

me.chanjar.weixin.common.error.WxErrorException - the wx error exception

getCheckinScheduleList

java.util.List<WxCpCheckinSchedule> getCheckinScheduleList(java.util.Date startTime,
                                                           java.util.Date endTime,
                                                           java.util.List<java.lang.String> userIdList)
                                                    throws me.chanjar.weixin.common.error.WxErrorException

获取打卡人员排班信息

参数:

startTime - 获取排班信息的开始时间。Unix时间戳

endTime - 获取排班信息的结束时间。Unix时间戳（与starttime跨度不超过一个月）

userIdList - 需要获取排班信息的用户列表（不超过100个）

返回:

排班表信息

抛出:

me.chanjar.weixin.common.error.WxErrorException - the wx error exception

setCheckinScheduleList

void setCheckinScheduleList(WxCpSetCheckinSchedule wxCpSetCheckinSchedule)
                     throws me.chanjar.weixin.common.error.WxErrorException

为打卡人员排班

参数:

wxCpSetCheckinSchedule - the wx cp set checkin schedule

抛出:

me.chanjar.weixin.common.error.WxErrorException - the wx error exception