外出审批

审批定义的表单包含 外出控件组 时，该定义下的审批实例在通过或者 通过并撤销 时，会触发该事件。

前提条件

应用已配置事件订阅，了解事件订阅可参见事件订阅概述。
应用已调用订阅审批事件接口，订阅了审批实例对应的审批定义 Code。

使用说明

订阅该事件（事件类型为 out_approval）后，可以接收到两个事件：

事件类型（type 为 out_approval）指外出审批通过事件。
事件类型（type 为 out_approval_revert）指外出审批通过并撤销事件。

事件

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

外出审批通过事件

当外出审批事件通过时，触发该事件并向订阅事件的应用发送以下事件体数据。

事件体

字段	数据类型	描述
ts	string	事件发送时间。包含小数的秒级时间戳。
uuid	string	事件的唯一标识。
token	string	事件 Token，即应用的 Verification Token。
type	string	固定取值 `event_callback`。
event	object	事件详细信息。
└ app_id	string	应用的 App ID。可调用获取应用信息接口查询应用详细信息。
└ start_time	int	审批开始时间，秒级时间戳。
└ end_time	int	审批结束时间，秒级时间戳。
└ i18n_resources	string[]	外出类型选项的国际化文案。
└ instance_code	string	审批实例 Code。可调用获取单个审批实例详情接口查询审批实例详情。
└ approval_code	string	审批定义 Code。可调用查看指定审批定义接口查询审批定义详情。
└ open_id	string	审批发起人的 open_id。你可以调用获取单个用户信息接口，通过 open_id 获取用户信息。
└ out_start_time	string	外出开始时间。示例格式：2025-01-14 19:00:00
└ out_end_time	string	外出结束时间。示例格式：2025-01-14 19:00:00
└ out_image	string	外出拍照的图片。
└ out_interval	int	外出时长。单位：秒
└ out_name	string	外出类型，需要根据该参数返回的数值，从 `i18n_resources` 参数中获取对应的外出类型文案。
└ out_reason	string	外出事由。
└ out_unit	string	外出时长的单位，该单位对应填写表单时显示的时长单位。例如表单的外出时长单位是小时，则这里取值 HOUR。 - HOUR：小时 - DAY：天 - HALR_DAY：半天
└ tenant_key	string	租户 Key，是企业的唯一标识。
└ type	string	事件类型。固定值 `out_approval`
└ user_id	string	审批发起人的 user_id。你可以调用获取单个用户信息接口，通过 user_id 获取用户信息。

事件体示例

json

{
  "ts": "1502199207.7171419", 
  "uuid": "bc447199585340d1f3728d26b1c0297a",
  "token": "41a9425ea7df4536a7623e38fa321bae",
  "type": "event_callback",
  "event": {
    "app_id": "cli_9e28cb7ba56a100e",
    "i18n_resources": ["{\"is_default\":true,\"locale\":\"zh_cn\",\"texts\":{\"@i18n@someKey\":\"中文文案\"}}"],
    "instance_code": "59558CEE-CEF4-45C9-A2C3-DCBF8BEC7341",
    "approval_code": "48558CEF-CEF4-45C9-A2C3-DCBF8BEC7341",
    "out_image": "",
    "out_interval": 10800,
    "out_name": "@i18n@someKey",
    "out_reason": "外出事由",
    "out_start_time": "2020-05-15 15:00:00",
    "out_end_time": "2020-05-15 18:00:00",
    "out_unit": "HOUR",
    "start_time": 1589527346,
    "end_time": 1589527354,
    "tenant_key": "2d520d3b434f175e",
    "type": "out_approval",
    "open_id": "ou_xxx",
    "user_id": "g6964gd3"
  }
}

外出审批通过并撤销事件

当外出审批事件已通过，但又被撤销时，触发该事件并向订阅事件的应用发送以下事件体数据。

事件体

字段	数据类型	描述
ts	string	事件发送时间。包含小数的秒级时间戳。
uuid	string	事件的唯一标识。
token	string	事件 Token，即应用的 Verification Token。
type	string	固定取值 `event_callback`。
event	object	事件详细信息。
└ app_id	string	应用的 App ID。可调用获取应用信息接口查询应用详细信息。
└ instance_code	string	审批实例 Code。可调用获取单个审批实例详情接口查询审批实例详情。
└ approval_code	string	审批定义 Code。可调用查看指定审批定义接口查询审批定义详情。
└ operate_time	string	撤销操作时间，秒级时间戳。
└ tenant_key	string	租户 Key，是企业的唯一标识。
└ type	string	事件类型。固定值 `out_approval_revert`

事件体示例

json

{
  "ts": "1502199207.7171419", 
  "uuid": "bc447199585340d1f3728d26b1c0297a",
  "token": "41a9425ea7df4536a7623e38fa321bae",
  "type": "event_callback",
  "event": {
    "app_id": "cli_9e28cb7ba56a100e",
    "instance_code": "59558CEE-CEF4-45C9-A2C3-DCBF8BEC7341",
    "approval_code": "48558CEF-CEF4-45C9-A2C3-DCBF8BEC7341",
    "operate_time": 1589527354,
    "tenant_key": "2d520d3b434f175e",
    "type": "out_approval_revert"
  }
}

事件订阅示例代码

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

订阅方式

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

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("out_approval", 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("out_approval", 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("out_approval", 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({
        'out_approval': 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("out_approval", 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("out_approval", do_customized_event) \
    .build()


# 创建路由处理器 Create route handler
@app.route("/webhook/event", methods=["POST"])
def event():
    resp = event_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("out_approval", 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({
    'out_approval': 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);

通用事件

事件接口

特殊事件

外出审批

前提条件

使用说明

事件

外出审批通过事件

事件体

事件体示例

外出审批通过并撤销事件

事件体

事件体示例

事件订阅示例代码

外出审批 ​

前提条件 ​

使用说明 ​

事件 ​

外出审批通过事件 ​

事件体 ​

事件体示例 ​

外出审批通过并撤销事件 ​

事件体 ​

事件体示例 ​

事件订阅示例代码 ​

外出审批

前提条件

使用说明

事件

外出审批通过事件

事件体

事件体示例

外出审批通过并撤销事件

事件体

事件体示例

事件订阅示例代码