Skip to content

【事件】更新地点

飞书人事中「地点被更新」时将触发此事件。

Warning: - 【批量分页查询地点信息】【查询单个地点】【通过地点 ID 批量获取地点信息】数据查询存在一定延迟(2s以内),不建议收到事件后立即查询以上接口。

  • 以下字段变更会收到事件:
    • location(地点)相关字段:working_hours_type(工时制度)、locale(区域设置)、location_usage(用途)、display_language(默认显示语言)、effective_time(生效日期)、time_zone(时区)
    • organization(组织)相关字段:name(名称)、code(编码)、description(描述)、superior_org(上级组织)、active(启用)
    • address(地址)相关字段: district_v2(区/县)、city_v2(城市)、active(是否启用)、postal_code(邮政编码)、city_text(城市,仅文本)、country_region(国家 / 地区)、address_line_x(地址行x,x为1-9数字)、local_address_line_x(地址行x,非拉丁语系的本地文字,x为1-9数字)、local_city_text(城市,仅文本,非拉丁语系的本地文字)、is_primary(主要地址)、is_public(公开地址)、region(主要行政区)、address_type(地址类型)、region_subdivision_1(主要行政区往下细分1层的行政区)、city_subdivision_1(城市往下细分1层的行政区)、region_subdivision_2(主要行政区往下细分 2 层的行政区)、city_subdivision_2(城市往下细分 2 层的行政区)
  • 以下字段变更不会收到事件:primary_address(主要地址)、wk_updated_by(更新人)、wk_tid(时间轴记录ID)、wk_updated_at(更新时间)、expiration_time(失效时间)、wk_created_at(创建时间)、wk_created_by(创建人)、wk_id(ID)、wk_deleted_at(删除时间)、wk_status(时间轴状态)

Tip: - 该接口只会推送当前生效地点的变更事件

  • 未来生效的版本数据,会在生效日期当天凌晨推送事件。例如:今天为1月1日,修改地点主要地址信息并填写1月10日生效,则1月10日凌晨发送该对象变更事件。

前提条件

你需要在应用中配置事件订阅,这样才可以在事件触发时接收到事件数据。了解事件订阅可参见事件订阅概述

事件

项目
事件类型corehr.location.updated_v2
支持的应用类型custom,isv
权限要求 订阅该事件所需的权限,开启其中任意一项权限即可订阅 开启任一权限即可corehr:locations:read 获取地点信息 corehr:locations:write 更新地点信息
推送方式Webhook

事件体

名称类型描述
schemastring事件模式
headerevent_header事件头
  └ event_idstring事件 ID
  └ event_typestring事件类型
  └ create_timestring事件创建时间戳(单位:毫秒)
  └ tokenstring事件 Token
  └ app_idstring应用 ID
  └ tenant_keystring租户 Key
event\--
  └ location_idstring地点ID。 - 调用【查询单个地点】【通过地点 ID 批量获取地点信息】接口返回地点详细信息
  └ field_changesstring\[\]发生变更的字段
数据校验规则
- 长度范围:0200
  └ sub_eventsorganization_domain_event_data\[\]子变更事件
    └ idstring变更实体的ID
    └ entitystring变更实体标识,ObjAPIName
    └ agg_entitystring聚合实体标识,父对象 ObjAPIName
    └ agg_entity_idstring聚合实体ID, 父对象ID
    └ agg_entity_fieldstring所属聚合实体字段, FieldAPIName
    └ opt_typeint操作类型
可选值有
- 1: 新增 - 2: 修改 - 3: 删除
    └ field_changesstring\[\]变更字段列表
数据校验规则
- 长度范围:01000

事件体示例

json
{
    "schema": "2.0",
    "header": {
        "event_id": "5e3702a84e847582be8db7fb73283c02",
        "event_type": "corehr.location.updated_v2",
        "create_time": "1608725989000",
        "token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
        "app_id": "cli_9f5343c580712544",
        "tenant_key": "2ca1d211f64f6438"
    },
    "event": {
        "location_id": "201571101",
        "field_changes": [
            "address"
        ],
        "sub_events": [
            {
                "id": "7818231238918192",
                "entity": "address",
                "agg_entity": "company",
                "agg_entity_id": "7291273149417948716",
                "agg_entity_field": "registered_office_address",
                "opt_type": 2,
                "field_changes": [
                    "active"
                ]
            }
        ]
    }
}

事件订阅示例代码

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

订阅方式

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

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/corehr/v2"
	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("", "").
		OnP2LocationUpdatedV2(func(ctx context.Context, event *larkcorehr.P2LocationUpdatedV2) error {
			fmt.Printf("[ OnP2LocationUpdatedV2 access ], data: %s\n", larkcore.Prettify(event))
			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_p2_corehr_location_updated_v2(data: lark.corehr.v2.P2CorehrLocationUpdatedV2) -> None:
    print(f'[ do_p2_corehr_location_updated_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')

# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
    .register_p2_corehr_location_updated_v2(do_p2_corehr_location_updated_v2) \
    .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 com.lark.oapi.core.utils.Jsons;
import com.lark.oapi.service.corehr.CorehrService;
import com.lark.oapi.service.corehr.v2.model.P2LocationUpdatedV2;
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("", "")
            .onP2LocationUpdatedV2(new CorehrService.P2LocationUpdatedV2Handler() {
                @Override
                public void handle(P2LocationUpdatedV2 event) throws Exception {
                    System.out.printf("[ onP2LocationUpdatedV2 access ], data: %s\n", Jsons.DEFAULT.toJson(event.getEvent()));
                }
            })
            .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({
        'corehr.location.updated_v2': 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/corehr/v2"
)

// 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("", "").
		OnP2LocationUpdatedV2(func(ctx context.Context, event *larkcorehr.P2LocationUpdatedV2) error {
			fmt.Printf("[ OnP2LocationUpdatedV2 access ], data: %s\n", larkcore.Prettify(event))
			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_p2_corehr_location_updated_v2(data: lark.corehr.v2.P2CorehrLocationUpdatedV2) -> None:
    print(f'[ do_p2_corehr_location_updated_v2 access ], data: {lark.JSON.marshal(data, indent=4)}')

# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
    .register_p2_corehr_location_updated_v2(do_p2_corehr_location_updated_v2) \
    .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 com.lark.oapi.core.utils.Jsons;
import com.lark.oapi.service.corehr.CorehrService;
import com.lark.oapi.service.corehr.v2.model.P2LocationUpdatedV2;
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")
            .onP2LocationUpdatedV2(new CorehrService.P2LocationUpdatedV2Handler() {
                @Override
                public void handle(P2LocationUpdatedV2 event) throws Exception {
                    System.out.printf("[ onP2LocationUpdatedV2 access ], data: %s\n", Jsons.DEFAULT.toJson(event.getEvent()));
                }
            })
            .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({
    'corehr.location.updated_v2': 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);

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