me.chanjar.weixin.cp.api

接口 WxCpOaScheduleService

所有已知实现类:

WxCpOaOaScheduleServiceImpl

public interface WxCpOaScheduleService

企业微信日程接口. 官方文档：https://work.weixin.qq.com/api/doc/90000/90135/93648

作者:

Binary Wang created on 2020 -12-25

方法概要

限定符和类型	方法和说明
String	add(WxCpOaSchedule schedule, Integer agentId) 创建日程 该接口用于在日历中创建一个日程。
void	delete(String scheduleId) 取消日程 该接口用于取消指定的日程。
List<WxCpOaSchedule>	getDetails(List<String> scheduleIds) 获取日程详情 该接口用于获取指定的日程详情。
List<WxCpOaSchedule>	listByCalendar(String calId, Integer offset, Integer limit) 获取日历下的日程列表 该接口用于获取指定的日历下的日程列表。
void	update(WxCpOaSchedule schedule) 更新日程 该接口用于在日历中更新指定的日程。

方法详细资料

add

String add(WxCpOaSchedule schedule,
           Integer agentId)
    throws WxErrorException

创建日程

该接口用于在日历中创建一个日程。

请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/oa/schedule/add?access_token=ACCESS_TOKEN

参数:

schedule - the schedule

agentId - 授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数

返回:

日程ID string

抛出:

WxErrorException - the wx error exception

update

void update(WxCpOaSchedule schedule)
     throws WxErrorException

更新日程

该接口用于在日历中更新指定的日程。

注意，更新操作是覆盖式，而不是增量式 不可更新组织者和日程所属日历ID

请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/oa/schedule/update?access_token=ACCESS_TOKEN

参数:

schedule - the schedule

抛出:

WxErrorException - the wx error exception

getDetails

List<WxCpOaSchedule> getDetails(List<String> scheduleIds)
                         throws WxErrorException

获取日程详情

该接口用于获取指定的日程详情。

请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/oa/schedule/get?access_token=ACCESS_TOKEN

参数:

scheduleIds - the schedule ids

返回:

the details

抛出:

WxErrorException - the wx error exception

delete

void delete(String scheduleId)
     throws WxErrorException

取消日程 该接口用于取消指定的日程。

请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/oa/schedule/del?access_token=ACCESS_TOKEN

参数:

scheduleId - 日程id

抛出:

WxErrorException - the wx error exception

listByCalendar

List<WxCpOaSchedule> listByCalendar(String calId,
                                    Integer offset,
                                    Integer limit)
                             throws WxErrorException

获取日历下的日程列表 该接口用于获取指定的日历下的日程列表。 仅可获取应用自己创建的日历下的日程。

请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/oa/schedule/get_by_calendar?access_token=ACCESS_TOKEN

参数:

calId - 日历ID

offset - 分页，偏移量, 默认为0

limit - 分页，预期请求的数据量，默认为500，取值范围 1 ~ 1000

返回:

the string

抛出:

WxErrorException - the wx error exception