飞书开放平台 Server API 文档

主题

审批任务状态变更 ​

审批任务状态发生变更时会触发该事件。状态变更包括：

  • 用户创建审批实例后，推送第一个审批节点的审批任务 PENDING 状态。
  • 如果当前审批节点是会签（AND）节点：
    • 任一审批任务被同意，推送该任务的 APPROVED（已通过）状态，并推送当前节点剩余任务的 PENDING 状态。
    • 任一审批任务被拒绝，推送该任务的 REJECTED（已拒绝）状态，并推送当前节点剩余任务的 DONE 状态。
  • 如果当前节点是或签（OR）节点：
    • 任一审批任务被同意，推送该任务的 APPROVED（已通过）状态，并推送当前节点剩余任务的 DONE（已完成）状态、下一个节点所有任务的 PENDING（进行中）状态。
    • 任一审批任务被拒绝，推送该任务的 REJECTED（已拒绝）状态，并推送当前节点剩余任务的 DONE（已完成）状态。
  • 如果用户对审批任务进行转交，推送该任务的 TRANSFERRED（已转交）状态，和被转交人任务的 PENDING（进行中）状态。
  • 发起人撤回审批后，推送剩余所有任务的 DONE（已完成）状态。
  • 审批定义被管理员删除后，推送剩余所有任务的 DONE（已完成）状态。
  • 如果用户对审批任务进行退回，推送该任务的 ROLLBACK（已退回）状态，和被退回人任务的 PENDING（进行中）状态。
  • 如果进行中的审批任务超时未处理被关闭，推送该任务的 OVERTIME_CLOSE（超时未处理被关闭）状态。
  • 如果超时已关闭的审批任务被手动恢复，推送该任务的 OVERTIME_RECOVER（超时已关闭的任务被手动恢复）状态。

前提条件 ​

事件 ​

项目值
事件类型approval_task
支持的应用类型custom,isv
权限要求 订阅该事件所需的权限，开启其中任意一项权限即可订阅 开启任一权限即可approval:approval:readonly 访问审批应用 approval:approval 查看、创建、更新、删除审批应用相关信息
推送方式Webhook

事件体 ​

字段数据类型描述
tsstring事件发送时间。包含小数的秒级时间戳。
uuidstring事件的唯一标识。
tokenstring事件 Token，即应用的 Verification Token。
typestring固定取值 event_callback。
eventobject事件详细信息。
  └ app_idstring应用的 App ID。可调用获取应用信息接口查询应用详细信息。
  └ open_idstring审批任务操作人的 open_id。你可以调用获取单个用户信息接口，通过 open_id 获取用户信息。
说明：如果审批任务为自动通过类型，open_id 会返回空值。
  └ tenant_keystring企业唯一标识。
  └ typestring事件类型。固定取值 approval_task
  └ approval_codestring审批定义 Code。可调用查看指定审批定义接口查询审批定义详情。
  └ instance_codestring审批实例 Code。可调用获取单个审批实例详情接口查询审批实例详情。
  └ task_idstring审批任务 ID。
  └ user_idstring审批任务操作人的 user_id。你可以调用获取单个用户信息接口，通过 user_id 获取用户信息。
说明：如果审批任务为自动通过类型，user_id 会返回空值。
  └ statusstring审批任务状态。可能值有： - REVERTED：已还原 - PENDING：进行中 - APPROVED：已通过 - REJECTED：已拒绝 - TRANSFERRED：已转交 - ROLLBACK：已退回 - DONE：已完成 - OVERTIME_CLOSE：超时未处理被关闭 - OVERTIME_RECOVER：超时已关闭的任务被手动恢复
  └ operate_timestring事件发生事件，毫秒级时间戳。
  └ custom_keystring审批节点的自定义 ID。节点未设置自定义 ID 时返回空值。
  └ def_keystring系统生成的审批节点唯一 ID。
  └ extrastring扩展数据。目前仅任务被退回时才有此字段，其中：
- rollback_node_ids：退回的节点列表 - rollback_custom_node_ids：用户自定义配置的节点列表

事件体示例 ​

json
{    
     "ts": "1502199207.7171419",
     "uuid": "bc447199585340d1f3728d26b1c0297a",
     "token": "41a9425ea7df4536a7623e38fa321bae",
     "type": "event_callback",
     "event": { 
         "app_id": "cli_xxx", 
         "open_id": "ou_123456",
         "tenant_key":"xxx", 
         "type": "approval_task", 
         "approval_code": "7C468A54-8745-2245-9675-08B7C63E7A85",
         "instance_code": "81D31358-93AF-92D6-7425-01A5D67C4E71", 
         "task_id": "12345",
         "user_id": "b613t51g",
         "status": "PENDING", 
         "operate_time": "1502199207000",
         "custom_key": "xxx",
         "def_key": "xxx",
         "extra":"{\"rollback_node_ids\":[\"nodeid\"],\"rollback_custom_node_ids\":[\"customnodeid\"]}"
    }
}

事件订阅示例代码 ​

事件订阅流程可参考：事件订阅概述，新手入门可参考：教程

订阅方式

长连接方式（推荐）：无需发布到公网地址，在本地开发环境中即可接收事件回调，且无需处理加解密逻辑。 发送至开发者服务器：需要提供服务器公网地址。

package main

import ( "context" "fmt"

    larkcore "github.com/larksuite/oapi-sdk-go/v3/core"
    larkevent "github.com/larksuite/oapi-sdk-go/v3/event"
    "github.com/larksuite/oapi-sdk-go/v3/event/dispatcher"
    "github.com/larksuite/oapi-sdk-go/v3/service/approval/old"
    larkws "github.com/larksuite/oapi-sdk-go/v3/ws"

)

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/preparations func main() { // 注册事件 Register event eventHandler := dispatcher.NewEventDispatcher("", ""). OnCustomizedEvent("approval_task", func(ctx context.Context, event *larkevent.EventReq) error { fmt.Printf("[ OnCustomizedEvent access ], type: message, data: %s\n", string(event.Body)) return nil })

    // 构建 client Build client
    cli := larkws.NewClient("YOUR_APP_ID", "YOUR_APP_SECRET",
            larkws.WithEventHandler(eventHandler),
            larkws.WithLogLevel(larkcore.LogLevelDebug),
    )

    // 建立长连接 Establish persistent connection
    err := cli.Start(context.Background())

    if err != nil {
            panic(err)
    }

}

SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/python--sdk/preparations-before-development ​

import lark_oapi as lark

def do_customized_event(data: lark.CustomizedEvent) -> None: print(f'[ do_customized_event access ], type: message, data: {lark.JSON.marshal(data, indent=4)}')

注册事件 Register event ​

event_handler = lark.EventDispatcherHandler.builder("", "")
.register_p1_customized_event("approval_task", do_customized_event)
.build()

def main(): # 构建 client Build client cli = lark.ws.Client("APP_ID", "APP_SECRET", event_handler=event_handler, log_level=lark.LogLevel.DEBUG) # 建立长连接 Establish persistent connection cli.start()

if name == "main": main()

package com.example.sample;

import java.nio.charset.StandardCharsets; import com.lark.oapi.core.request.EventReq; import com.lark.oapi.event.CustomEventHandler; import com.lark.oapi.event.EventDispatcher; import com.lark.oapi.ws.Client;

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/java-sdk-guide/preparations public class Sample { // 注册事件 Register event private static final EventDispatcher EVENT_HANDLER = EventDispatcher.newBuilder("", "") .onCustomizedEvent("approval_task", new CustomEventHandler() { @Override public void handle(EventReq event) throws Exception { System.out.printf("[ onCustomizedEvent access ], type: message, data: %s\n", new String(event.getBody(), StandardCharsets.UTF_8)); } }) .build();

public static void main(String[] args) {
    // 构建 client Build client
    Client client = new Client.Builder("APP_ID", "APP_SECRET")
            .eventHandler(EVENT_HANDLER)
            .build();
    // 建立长连接 Establish persistent connection
    client.start();
}

}

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/nodejs-sdk/preparation-before-development import * as Lark from '@larksuiteoapi/node-sdk'; const baseConfig = { appId: 'APP_ID', appSecret: 'APP_SECRET' } // 构建 client Build client const wsClient = new Lark.WSClient(baseConfig); // 建立长连接 Establish persistent connection wsClient.start({ // 注册事件 Register event eventDispatcher: new Lark.EventDispatcher({}).register({ 'approval_task': async (data) => { console.log(data); } }) });

package main

import ( "context" "fmt" "net/http"

    larkcore "github.com/larksuite/oapi-sdk-go/v3/core"
    "github.com/larksuite/oapi-sdk-go/v3/core/httpserverext"
    larkevent "github.com/larksuite/oapi-sdk-go/v3/event"
    "github.com/larksuite/oapi-sdk-go/v3/event/dispatcher"
    "github.com/larksuite/oapi-sdk-go/v3/service/approval/old"

)

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/golang-sdk-guide/preparations func main() { // 注册事件 Register event eventHandler := dispatcher.NewEventDispatcher("", ""). OnCustomizedEvent("approval_task", func(ctx context.Context, event *larkevent.EventReq) error { fmt.Printf("[ OnCustomizedEvent access ], type: message, data: %s\n", string(event.Body)) return nil })

    // 创建路由处理器 Create route handler
    http.HandleFunc("/webhook/event", httpserverext.NewEventHandlerFunc(handler, larkevent.WithLogLevel(larkcore.LogLevelDebug)))

    err := http.ListenAndServe(":7777", nil)

    if err != nil {
            panic(err)
    }

}

SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/python--sdk/preparations-before-development ​

from flask import Flask from lark_oapi.adapter.flask import * import lark_oapi as lark

app = Flask(name)

def do_customized_event(data: lark.CustomizedEvent) -> None: print(f'[ do_customized_event access ], type: message, data: {lark.JSON.marshal(data, indent=4)}')

注册事件 Register event ​

event_handler = lark.EventDispatcherHandler.builder("", "")
.register_p1_customized_event("approval_task", do_customized_event)
.build()

创建路由处理器 Create route handler ​

@app.route("/webhook/event", methods=["POST"]) def event(): resp = handler.do(parse_req()) return parse_resp(resp)

if name == "main": app.run(port=7777)

package com.lark.oapi.sample.event;

import java.nio.charset.StandardCharsets; import com.lark.oapi.core.request.EventReq; import com.lark.oapi.event.CustomEventHandler; import com.lark.oapi.sdk.servlet.ext.ServletAdapter; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse;

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/java-sdk-guide/preparations @RestController public class EventController {

// 注册事件 Register event
private static final EventDispatcher EVENT_HANDLER = EventDispatcher.newBuilder("verificationToken", "encryptKey")
        .onCustomizedEvent("approval_task", new CustomEventHandler() {
            @Override
            public void handle(EventReq event) throws Exception {
                System.out.printf("[ onCustomizedEvent access ], type: message, data: %s\n", new String(event.getBody(), StandardCharsets.UTF_8));
            }
        })
        .build();

// 注入 ServletAdapter 实例 Inject ServletAdapter instance
@Autowired
private ServletAdapter servletAdapter;

// 创建路由处理器 Create route handler
@RequestMapping("/webhook/event")
public void event(HttpServletRequest request, HttpServletResponse response)
        throws Throwable {
    // 回调扩展包提供的事件回调处理器 Callback handler provided by the extension package
    servletAdapter.handleEvent(request, response, EVENT_DISPATCHER);
}

}

// SDK 使用说明 SDK user guide：https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/server-side-sdk/nodejs-sdk/preparation-before-development import http from 'http'; import * as lark from '@larksuiteoapi/node-sdk';

// 注册事件 Register event const eventDispatcher = new lark.EventDispatcher({ encryptKey: '', verificationToken: '', }).register({ 'approval_task': async (data) => { console.log(data); return 'success'; }, });

const server = http.createServer(); // 创建路由处理器 Create route handler server.on('request', lark.adaptDefault('/webhook/event', eventDispatcher)); server.listen(3000);

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有