Skip to content

审批 SDK 接口文档

概述

审批 SDK 提供了飞书审批系统的完整 API 封装,支持原生审批管理、三方审批集成、审批任务操作、审批查询等功能,帮助开发者快速构建企业级审批应用。

主要功能:

  • 原生审批定义与实例管理
  • 三方审批系统集成与数据同步
  • 审批任务操作(同意、拒绝、转交、退回等)
  • 审批数据查询(租户级别与用户级别)
  • 审批评论管理
  • 审批 Bot 消息推送
  • 审批文件上传

适用场景:

  • 企业内部审批流程自动化
  • 第三方审批系统与飞书审批集成
  • 审批数据统计分析与报表
  • 审批消息通知与提醒

文档使用指引:

本索引文档提供了所有审批相关 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 ApprovalController : ControllerBase
{
    private readonly IFeishuTenantV4Approval _approvalApi;

    public ApprovalController(IFeishuTenantV4Approval approvalApi)
    {
        _approvalApi = approvalApi;
    }

    [HttpPost("create-instance")]
    public async Task<IActionResult> CreateInstance([FromBody] CreateApprovalInstanceRequest request)
    {
        var result = await _approvalApi.CreateInstanceAsync(request);
        return Ok(result);
    }
}

API 接口导航

审批管理

  • 原生审批管理接口 — 管理飞书原生审批定义与实例,支持创建审批定义、创建/撤回审批实例等操作
  • 三方审批管理接口 — 将企业原有审批系统与飞书审批系统连通,实现数据同步与流转

审批任务与评论

审批查询

其他功能

命名空间与版本信息

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