日历业务域概述
日历介绍
日历 API 基于 WPS 日历功能开放了对日历、日程、参与者、会议室、忙闲等资源的操作与查询能力。你能以应用或用户的身份调用日历 API 来实现多种功能。例如:
- 创建日历、设置日历权限
- 在日历下创建、更新日程
- 查询用户忙闲、邀请用户、预定会议室
- 同步用户的请假状态
资源关系说明:
- 日历:管理日程的容器。每个用户或应用身份都默认拥有一个主日历,也都可以创建多个自定义日历(例如,用于"工作"、"个人"或特定项目)。
- 忙闲:用户在特定时间段的日程占用状态。查询忙闲接口可以批量获取多个用户的空闲时间,便于安排会议和日程。
- 日程:日历中的具体事项,包含时间、标题、描述等信息。日程必须属于某一个日历。
- 日程参与者:被邀请参加日程的用户。可以是企业内部用户或通过邮箱地址邀请的外部参与者。
- 日程会议室:可被日程预订的物理空间资源。通过将会议室添加到日程中,实现会议场地的预订和管理。
- 日历权限:定义了其他用户对特定日历的访问权限级别(游客权限、订阅者权限、编辑者权限、所有者权限),是实现日历共享的基础。
用户或应用拥有并管理自己的日历。日历是日程的容器。日程可以邀请日程参与者并预订日程会议室。用户之间通过设置日历权限共享日历。

业务模块
日历
每个用户拥有一个主日历,同时可以创建多个自定义日历来组织不同类型的日程。支持创建、查询、更新、删除日历,查询主日历信息和忙闲状态。
日历权限
为不同用户设置不同的权限级别。支持创建、查询、删除日历权限,批量创建权限。
日程
日程代表在特定时间发生的活动或事件。支持单次日程和循环日程,包括创建、查询、更新、删除日程,批量创建日程。
日程参与者
支持添加个人用户和第三方邮箱作为参与者。支持添加、删除、查询日程参与者及其应答状态。
日程会议室
为日程预订会议室。支持添加、删除、查询日程会议室,自动预订和释放会议室。
请假日程
请假日程用于记录用户的请假、休假等时间。支持创建、删除请假日程,在协作中标识请假状态。
典型应用场景
1. 外部日程导入与同步
企业内有其他的系统和"类日程"的数据源,可以通过开放接口将数据导入到日历系统,如培训计划、值班排期等:
- 使用应用身份为项目创建独立日历
- 通过创建日程或者批量创建基础日程接口,导入计划或活动安排
- 可通过日历权限接口将课程日历直接共享给其他用户,接收者通过日历查看日程安排,接收日程提醒
- 如有更精细化的控制要求,可在创建日程后单独添加邀请其他用户参与
- 被邀请的用户可在日历中统一查看日程安排,实现时间管理和协作
2. 第三方会议预约信息同步到日程
企业内可能有独立的会议预约系统,可通过开放接口将预约结果同步到日历系统实现协作:
- 用户在企业内部预约系统创建会议预约,包含时间、参会人、会议室等信息
- 内部预约系统使用应用身份,在应用日历上创建日程、邀请参会人、添加会议室,完成会议信息的同步
- 所有被邀请的参会人可在自己的日历中看到会议安排和详情,实现团队协作
- 与企业现有会议管理规范和审批流程集成
3. 智能会议安排
帮助用户快速找到合适的会议时间和会议室,提升会议安排效率:
- 通过查询主日历忙闲接口,批量查询多个参会人和会议室在指定时间段的忙闲状态
- 根据参会人和会议室的空闲时间,智能推荐可用的会议时间段
- 确定会议时间和会议室后,通过创建日程接口创建会议
- 邀请参会人并添加会议室,完成会议预约
4. OA 请假系统集成
与 OA 考勤系统集成,实现请假信息的自动同步:
- OA 系统审批通过请假后,自动调用日历接口创建请假日程
- 请假日程会标记为"忙碌"状态,在用户日历中可见
- 企业内同事查看该用户日历时,可以看到请假时间段被占用
- 其他人安排会议或日程时,可避免邀请请假中的用户
- 实现请假信息在企业内的透明化和可见性