cn.felord.reactive.api

Interface CheckinApi

public interface CheckinApi

打卡API

Since:

2024/9/25

Author:

dax

Method Summary

Modifier and Type	Method and Description
io.reactivex.rxjava3.core.Single<WeComResponse>	addCheckinOption(CheckinOptionRequest request) 创建打卡规则
io.reactivex.rxjava3.core.Single<WeComResponse>	addCheckinUserface(CheckinUserfaceRequest request) 录入打卡人员人脸信息
io.reactivex.rxjava3.core.Single<DeviceCheckinDataResponse>	addCheckinUserface(DeviceCheckinQueryRequest request) 获取设备打卡数据
io.reactivex.rxjava3.core.Single<CheckinDataResponse>	getCheckinData(CheckinDataRequest request) 获取打卡记录数据 获取记录时间跨度不超过30天 用户列表不超过100个。若用户超过100个，请分批获取 有打卡记录即可获取打卡数据，与当前"打卡应用"是否开启无关 标准打卡时间只对于固定排班和自定义排班两种类型有效 接口调用频率限制为600次/分钟
io.reactivex.rxjava3.core.Single<CheckinStatisticsResponse<CheckinDayData>>	getCheckinDayData(CheckinQueryRequest request) 获取打卡日报数据
io.reactivex.rxjava3.core.Single<CheckinStatisticsResponse<CheckinMonthData>>	getCheckinMonthData(CheckinQueryRequest request) 获取打卡月报数据
io.reactivex.rxjava3.core.Single<UserCheckinOptionResponse>	getCheckinOption(UserCheckinOptionRequest request) 获取员工打卡规则 用户列表不超过100个，若用户超过100个，请分批获取。 用户在不同日期的规则不一定相同，请按天获取。
io.reactivex.rxjava3.core.Single<ScheduleListResponse>	getCheckinScheduList(CheckinQueryRequest request) 获取打卡人员排班信息
io.reactivex.rxjava3.core.Single<CheckinOptionResponse>	getCorpCheckinOption() 获取企业所有打卡规则
io.reactivex.rxjava3.core.Single<WeComResponse>	punchCorrection(PunchCorrectionRequest request) 为打卡人员补卡
io.reactivex.rxjava3.core.Single<WeComResponse>	setCheckinScheduList(UserScheduleRequest request) 为打卡人员排班
io.reactivex.rxjava3.core.Single<WeComResponse>	updateCheckinOption(CheckinOptionRequest request) 修改打卡规则

Method Detail

getCorpCheckinOption

@POST(value="checkin/getcorpcheckinoption")
io.reactivex.rxjava3.core.Single<CheckinOptionResponse> getCorpCheckinOption()

获取企业所有打卡规则

Returns:

the corp checkin option

getCheckinOption

@POST(value="checkin/getcheckinoption")
io.reactivex.rxjava3.core.Single<UserCheckinOptionResponse> getCheckinOption(@Body
                                                                                                                     UserCheckinOptionRequest request)

获取员工打卡规则

1. 用户列表不超过100个，若用户超过100个，请分批获取。
2. 用户在不同日期的规则不一定相同，请按天获取。

Parameters:

request - the request

Returns:

the checkin option

addCheckinOption

@POST(value="checkin/add_checkin_option")
io.reactivex.rxjava3.core.Single<WeComResponse> addCheckinOption(@Body
                                                                                                           CheckinOptionRequest request)

创建打卡规则

企业可通过打卡应用或授权的代开发应用，为企业添加打卡规则。

Parameters:

request - the request

Returns:

the user checkin option response

updateCheckinOption

@POST(value="checkin/update_checkin_option")
io.reactivex.rxjava3.core.Single<WeComResponse> updateCheckinOption(@Body
                                                                                                                 CheckinOptionRequest request)

修改打卡规则

企业可通过打卡应用或授权的代开发应用，修改该应用为企业创建的打卡规则。

Parameters:

request - the request

Returns:

the we com response

getCheckinData

@POST(value="checkin/getcheckindata")
io.reactivex.rxjava3.core.Single<CheckinDataResponse> getCheckinData(@Body
                                                                                                           CheckinDataRequest request)

获取打卡记录数据

1. 获取记录时间跨度不超过30天
2. 用户列表不超过100个。若用户超过100个，请分批获取
3. 有打卡记录即可获取打卡数据，与当前"打卡应用"是否开启无关
4. 标准打卡时间只对于固定排班和自定义排班两种类型有效
5. 接口调用频率限制为600次/分钟

Parameters:

request - the request

Returns:

the checkin data

getCheckinDayData

@POST(value="checkin/getcheckin_daydata")
io.reactivex.rxjava3.core.Single<CheckinStatisticsResponse<CheckinDayData>> getCheckinDayData(@Body
                                                                                                                                        CheckinQueryRequest request)

获取打卡日报数据

企业可通过打卡应用Secret调用本接口，获取指定员工指定时间段内的打卡日报统计数据。 第三方应用可获取应用可见范围内指定员工指定日期内的打卡日报统计数据。

Parameters:

request - the request

Returns:

the checkin day data

getCheckinMonthData

@POST(value="checkin/getcheckin_monthdata")
io.reactivex.rxjava3.core.Single<CheckinStatisticsResponse<CheckinMonthData>> getCheckinMonthData(@Body
                                                                                                                                              CheckinQueryRequest request)

获取打卡月报数据

Parameters:

request - the request

Returns:

the checkin month data

getCheckinScheduList

@POST(value="checkin/getcheckinschedulist")
io.reactivex.rxjava3.core.Single<ScheduleListResponse> getCheckinScheduList(@Body
                                                                                                                        CheckinQueryRequest request)

获取打卡人员排班信息

仅支持为打卡规则为“按班次上下班”

企业可通过打卡应用Secret调用本接口，获取打卡规则为“按班次上下班”规则的指定员工指定时间段内的排班信息。 第三方应用获取应用可见范围内、打卡规则为“按班次上下班”规则的指定员工指定时间段内的排班信息。

Parameters:

request - the request

Returns:

the checkin schedulist

setCheckinScheduList

@POST(value="checkin/setcheckinschedulist")
io.reactivex.rxjava3.core.Single<WeComResponse> setCheckinScheduList(@Body
                                                                                                                 UserScheduleRequest request)

为打卡人员排班

企业可通过打卡应用Secret调用本接口，为打卡规则为“按班次上下班”规则的指定员工排班。 第三方应用可通过本接口为应用可见范围内、打卡规则为“按班次上下班”规则的指定员工排班。

Parameters:

request - the request

Returns:

the checkin schedu list

punchCorrection

@POST(value="checkin/punch_correction")
io.reactivex.rxjava3.core.Single<WeComResponse> punchCorrection(@Body
                                                                                                        PunchCorrectionRequest request)

为打卡人员补卡

暂不支持第三方调用

Parameters:

request - the request

Returns:

the checkin schedu list

addCheckinUserface

@POST(value="checkin/addcheckinuserface")
io.reactivex.rxjava3.core.Single<WeComResponse> addCheckinUserface(@Body
                                                                                                             CheckinUserfaceRequest request)

录入打卡人员人脸信息

企业可通过打卡应用Secret调用本接口，为企业打卡人员录入人脸信息，人脸信息仅用于人脸打卡。

注意：对于已有人脸的用户，使用此接口将使用传入的人脸覆盖原有人脸，请谨慎操作。

Parameters:

request - the request

Returns:

the we com response

addCheckinUserface

@POST(value="checkin/addcheckinuserface")
io.reactivex.rxjava3.core.Single<DeviceCheckinDataResponse> addCheckinUserface(@Body
                                                                                                                         DeviceCheckinQueryRequest request)

获取设备打卡数据

可通过此接口，获取考勤设备上产生的所有原始打卡记录，包括未被打卡应用记录的不符合打卡规则的记录。 第三方应用可获取应用可见范围内员工在考勤设备上产生的所有原始打卡记录，包括未被打卡应用记录的不符合打卡规则的记录。

1. 获取记录时间跨度不超过一个月
2. 用户列表不超过100个。若用户超过100个，请分批获取
3. 获取的是通过考勤设备打卡的原始记录，不包含企业微信app手机打卡的记录
4. userid无效时，忽略该参数，不报错

Parameters:

request - the request

Returns:

the device checkin data response