Skip to content

日历 SDK 接口文档

概述

日历 SDK 提供了飞书日历的完整 API 封装,支持日历管理、日程操作、访问控制、忙闲查询等功能,帮助开发者构建企业级日历管理应用。

主要功能:

  • 日历创建、删除、查询与更新
  • 日历搜索与订阅管理
  • 日程 CRUD 与搜索
  • 日程参与人管理
  • 日历访问控制(ACL)管理
  • 会议室忙闲查询
  • 日程回复与会议纪要

适用场景:

  • 企业日历管理系统集成
  • 日程安排与会议室预定自动化
  • 团队协作日程共享
  • 日历权限管理

文档使用指引:

本索引文档提供了所有日历相关 API 的导航入口。每个 API 文档包含接口名称、功能描述、函数签名、参数说明及请求示例。点击各 API 链接可查看详细文档。

快速开始

安装

bash
dotnet add package Mud.Feishu

配置文件

appsettings.json 中添加飞书应用配置:

json
{
  "FeishuApps": [
    {
      "AppKey": "default",
      "AppId": "cli_xxx",
      "AppSecret": "your_app_secret",
      "BaseUrl": "https://open.feishu.cn",
      "IsDefault": true
    }
  ]
}

注册服务

Program.cs 中注册飞书服务:

csharp
// 添加飞书服务
builder.Services.AddFeishuApp(builder.Configuration, "FeishuApps");

// 注册 API 服务
builder.Services.CreateFeishuServicesBuilder()
    .AddModules(FeishuModule.All)
    .Build();

依赖注入使用

在 Controller 或服务中通过构造函数注入接口:

csharp
using Mud.Feishu;

public class CalendarController : ControllerBase
{
    private readonly IFeishuTenantV4Calendar _calendarApi;

    public CalendarController(IFeishuTenantV4Calendar calendarApi)
    {
        _calendarApi = calendarApi;
    }

    [HttpGet("calendars")]
    public async Task<IActionResult> GetCalendarList()
    {
        var result = await _calendarApi.GetCalendarPageListAsync();
        return Ok(result);
    }
}

API 接口导航

日历管理

  • 日历管理(租户) — 以租户身份管理日历资源,包括创建、删除、查询、更新、搜索日历以及订阅管理
  • 日历管理(用户) — 以用户身份管理日历资源,支持创建、删除、查询、更新、搜索日历和订阅操作

日历日程

  • 日历日程(租户) — 以租户身份管理日程,包括日程 CRUD、搜索、回复、参与人管理、会议群和会议纪要
  • 日历日程(用户) — 以用户身份管理日程,包含 CRUD、参与人管理、会议室忙闲查询、CalDAV 配置及 Exchange 绑定

访问控制

命名空间与版本信息

  • 根命名空间Mud.Feishu
  • 当前版本:2.1.2
  • 目标框架:.NET Standard 2.0 / .NET 6+ / .NET 8+