# 部门新建
在创建新部门时接收事件通知。
## 前提条件
你需要在应用中配置事件订阅，这样才可以在事件触发时接收到事件数据。了解事件订阅可参见[事件概述](https://open.larksuite.com/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)。
## 注意事项
该事件有部分字段权限要求，你可以参考相应的参数描述获取参数所需的权限。只有当应用开通了相应的字段权限后，才可以成功接收到完整的事件体数据。申请权限的具体操作，参见[申请 API 权限](https://open.larksuite.com/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。
## 事件
基本 |
---|---
事件类型 | directory.department.created_v1
支持的应用类型 | Custom App、Store App
权限要求
**订阅该事件所需的权限，开启其中任意一项权限即可订阅** | 调用 API 获取部门信息(directory:department:read)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
查看部门基础信息(directory:department.base:read)
查看部门自定义字段信息(directory:department.custom_field:read)
查看部门自定义 ID(directory:department.external_id:read)
查看部门负责人信息(directory:department.leader:read)
查看部门的名称(directory:department.name:read)
查看部门排序权重(directory:department.order_weight:read)
查看部门组织架构信息(directory:department.organization:read)
查看部门的父部门 ID(directory:department.parent_id:read)
查看部门的停启用状态(directory:department.status:read)
推送方式 | [Webhook](https://open.larksuite.com/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)
### 事件体
名称 | 类型 | 描述
---|---|---
schema | string | 事件模式
header | event_header | 事件头
event_id | string | 事件 ID
event_type | string | 事件类型
create_time | string | 事件创建时间戳（单位：毫秒）
token | string | 事件 Token
app_id | string | 应用 ID
tenant_key | string | 租户 Key
event | \- | \-
department | department | 部门信息
department_id | string | 部门ID,部门ID类型为 open_department_id，了解部门 ID 可参见[部门资源介绍](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)。
**数据校验规则**：
- 最大长度：`64` 字符
**字段权限要求（满足任一）**：
查看部门基础信息(directory:department.base:read)
查看部门自定义 ID(directory:department.external_id:read)
leaders | department_leader\[\] | 部门负责人
**数据校验规则**：
- 长度范围：`0` ～ `100`
**字段权限要求**：
查看部门负责人信息(directory:department.leader:read)
leader_type | int | 部门负责人类型
**可选值有**：
- 1：主
- 2：副
leader_id | string | 部门负责人ID
parent_department_id | string | 父部门ID
**数据校验规则**：
- 最大长度：`64` 字符
**字段权限要求（满足任一）**：
查看部门组织架构信息(directory:department.organization:read)
查看部门的父部门 ID(directory:department.parent_id:read)
name | i18n_text | 部门名称
**字段权限要求（满足任一）**：
查看部门基础信息(directory:department.base:read)
查看部门的名称(directory:department.name:read)
default_value | string | 默认值
i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值
key | string | 国际化locale
value | string | value
enabled_status | boolean | 是否启用
**字段权限要求**：
查看部门的停启用状态(directory:department.status:read)
order_weight | string | 部门排序权重
**字段权限要求（满足任一）**：
查看部门排序权重(directory:department.order_weight:read)
查看部门组织架构信息(directory:department.organization:read)
custom_field_values | custom_field_value\[\] | 自定义字段
**数据校验规则**：
- 长度范围：`0` ～ `100`
**字段权限要求**：
查看部门自定义字段信息(directory:department.custom_field:read)
field_key | string | 自定义字段key
field_type | string | 自定义字段类型
**可选值有**：
- 1：多行文本
- 2：网页链接
- 3：枚举选项
- 4：人员
- 10：多选枚举类型(目前仅支持文本类型)
- 11：人员列表
text_value | i18n_text | i18n文本
default_value | string | 默认值
i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值
key | string | 国际化locale
value | string | value
url_value | url_value | 网页链接字段值
link_text | i18n_text | i18n文本
default_value | string | 默认值
i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值
key | string | 国际化locale
value | string | value
url | string | 移动端网页链接
pcurl | string | 桌面端网页链接
enum_value | enum_value | 枚举
enum_ids | string\[\] | 选项结果ID
**数据校验规则**：
- 长度范围：`0` ～ `100`
enum_type | string | 选项类型
**可选值有**：
- 1：文本
- 2：图片
user_values | user_value\[\] | 人员字段值
**数据校验规则**：
- 长度范围：`0` ～ `100`
ids | string\[\] | 人员ID列表，了解用户 ID 可参见[用户身份概述](https://open.larksuite.com/document/home/user-identity-introduction/introduction)。
**数据校验规则**：
- 长度范围：`0` ～ `100`
user_type | string | 人员类型
**可选值有**：
- 1：员工
abnormal | abnormal_record | 字段异常信息
id | string | 异常ID
row_error | int | 行级异常
**可选值有**：
- 0：成功
- 1000：没权限
**数据校验规则**：
- 取值范围：`0` ～ `100`
field_errors | map<string, abnormal_code> | 列级异常，key为字段名,value为下列枚举
key | string | 字段名
value | int | 错误码
**可选值有**：
- 0：成功
- 1000：没权限
- 2000：字段查询异常
- 2003：字段不存在
**数据校验规则**：
- 取值范围：`0` ～ `3000`
### 事件体示例
```json
{
"schema": "2.0",
"header": {
"event_id": "44e76372af7ca7f9a74100dd10ef7932",
"token": "",
"create_time": "1726211336000",
"event_type": "directory.department.created_v1",
"tenant_key": "133c1eae3c0f1748",
"app_id": "cli_a23f3400fe78901b"
},
"event": {
"abnormal": {
"row_error": 0
},
"department": {
"enabled_status": true,
"leaders": [
{
"leader_id": "ou_xxxx",
"leader_type": 1
},
{
"leader_id": "ou_xxxx",
"leader_type": 2
}
],
"name": {
"default_value": "部门创建",
"i18n_value": {
"en_us": "",
"ja_jp": "",
"ms_my": "部门创建",
"zh_cn": "部门创建"
}
},
"order_weight": 2000,
"parent_department_id": "od-xxxx"
}
}
}
```
### 事件订阅示例代码
事件订阅流程可参考：[事件订阅概述](https://open.larksuite.com/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)，新手入门可参考：[教程](https://open.larksuite.com/document/uAjLw4CM/uMzNwEjLzcDMx4yM3ATM/develop-an-echo-bot/introduction)
**
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/directory/v1"
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("", "").
OnP2DepartmentCreatedV1(func(ctx context.Context, event *larkdirectory.P2DepartmentCreatedV1) error {
fmt.Printf("[ OnP2DepartmentCreatedV1 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_directory_department_created_v1(data: lark.directory.v1.P2DirectoryDepartmentCreatedV1) -> None:
print(f'[ do_p2_directory_department_created_v1 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_directory_department_created_v1(do_p2_directory_department_created_v1) \
.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.directory.DirectoryService;
import com.lark.oapi.service.directory.v1.model.P2DepartmentCreatedV1;
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("", "")
.onP2DepartmentCreatedV1(new DirectoryService.P2DepartmentCreatedV1Handler() {
@Override
public void handle(P2DepartmentCreatedV1 event) throws Exception {
System.out.printf("[ onP2DepartmentCreatedV1 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({
'directory.department.created_v1': 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/directory/v1"
)
// 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("", "").
OnP2DepartmentCreatedV1(func(ctx context.Context, event *larkdirectory.P2DepartmentCreatedV1) error {
fmt.Printf("[ OnP2DepartmentCreatedV1 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_directory_department_created_v1(data: lark.directory.v1.P2DirectoryDepartmentCreatedV1) -> None:
print(f'[ do_p2_directory_department_created_v1 access ], data: {lark.JSON.marshal(data, indent=4)}')
# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
.register_p2_directory_department_created_v1(do_p2_directory_department_created_v1) \
.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.directory.DirectoryService;
import com.lark.oapi.service.directory.v1.model.P2DepartmentCreatedV1;
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")
.onP2DepartmentCreatedV1(new DirectoryService.P2DepartmentCreatedV1Handler() {
@Override
public void handle(P2DepartmentCreatedV1 event) throws Exception {
System.out.printf("[ onP2DepartmentCreatedV1 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({
'directory.department.created_v1': 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);