群配置修改

群组配置被修改后触发此事件，在该群组内的、已订阅当前事件的应用机器人将会收到事件通知。修改操作包含：

转移群主
修改群基本信息，包括：群头像、群名称、群描述、群国际化名称
修改群权限，包括：加人入群权限、群编辑权限、at 所有人权限、群分享权限等

前提条件

应用需要开启机器人能力。
应用需要配置事件订阅，订阅 消息与群组 分类下的 群配置修改 事件。

使用限制

只有在群内的、已订阅当前事件的应用机器人可以收到事件通知。

事件

项目	值
事件类型	im.chat.updated_v1
支持的应用类型	custom,isv
权限要求订阅该事件所需的权限，开启其中任意一项权限即可订阅开启任一权限即可	`im:chat` 获取与更新群组信息 `im:chat:read` 查看群信息 `im:chat:readonly` 获取群组信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 `contact:user.employee_id:readonly` 获取用户 user ID
推送方式	`Webhook`

事件体

名称	类型	描述
`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`	`\-`	-
└ `chat_id`	`string`	群组 ID，详细介绍参见群 ID 说明
└ `operator_id`	`user_id`	修改群配置的操作者的 ID 信息
└ `union_id`	`string`	用户的 union id
└ `user_id`	`string`	用户的 user id 字段权限要求： `contact:user.employee_id:readonly` 获取用户 user ID
└ `open_id`	`string`	用户的 open id
└ `external`	`boolean`	是否是外部群
└ `operator_tenant_key`	`string`	操作者的租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。
└ `after_change`	`chat_change`	更新后的群信息
└ `avatar`	`string`	群头像
└ `name`	`string`	群名称
└ `description`	`string`	群描述
└ `i18n_names`	`i18n_names`	群国际化名称
└ `zh_cn`	`string`	中文名
└ `en_us`	`string`	英文名
└ `ja_jp`	`string`	日文名
└ `add_member_permission`	`string`	谁可以邀请成员（用户或机器人）入群可选值有： - all_members：所有成员 - only_owner：仅群主和管理员 - unknown：未设置
└ `share_card_permission`	`string`	群分享权限可选值有： - allowed：允许 - not_allowed：不允许 - unknown：未设置
└ `at_all_permission`	`string`	谁可以 at 所有人可选值有： - all_members：所有成员 - only_owner：仅群主和管理员 - unknown：未设置
└ `edit_permission`	`string`	谁可以编辑群可选值有： - all_members：所有成员 - only_owner：仅群主和管理员 - unknown：未设置
└ `membership_approval`	`string`	加群是否需要审批可选值有： - no_approval_required：无需审批 - approval_required：需要审批
└ `join_message_visibility`	`string`	入群提示消息的可见性可选值有： - only_owner：仅群主和管理员可见 - all_members：所有成员可见 - not_anyone：任何人均不可见
└ `leave_message_visibility`	`string`	出群消息可见性可选值有： - only_owner：仅群主和管理员可见 - all_members：所有成员可见 - not_anyone：任何人均不可见
└ `moderation_permission`	`string`	发言权限可选值有： - all_members：所有成员 - only_owner：仅群主和管理员说明：发言权限为指定群成员时，需要参考 `moderator_list` 参数。
└ `owner_id`	`user_id`	群主 ID
└ `union_id`	`string`	用户的 union id
└ `user_id`	`string`	用户的 user id 字段权限要求： `contact:user.employee_id:readonly` 获取用户 user ID
└ `open_id`	`string`	用户的 open id
└ `restricted_mode_setting`	`restricted_mode_setting`	防泄密模式设置
└ `status`	`boolean`	防泄密模式是否开启
└ `screenshot_has_permission_setting`	`string`	允许截屏录屏可选值有： - `all_members`: 所有成员允许截屏录屏 - `not_anyone`: 所有成员禁止截屏录屏
└ `download_has_permission_setting`	`string`	允许下载消息中图片、视频和文件可选值有： - `all_members`: 所有成员允许下载资源 - `not_anyone`: 所有成员禁止下载资源
└ `message_has_permission_setting`	`string`	允许复制和转发消息可选值有： - `all_members`: 所有成员允许复制和转发消息 - `not_anyone`: 所有成员禁止复制和转发消息
└ `group_message_type`	`string`	群消息形式可选值有： - chat：会话消息 - thread：话题消息
└ `before_change`	`chat_change`	更新前的群信息
└ `avatar`	`string`	群头像
└ `name`	`string`	群名称
└ `description`	`string`	群描述
└ `i18n_names`	`i18n_names`	群国际化名称
└ `zh_cn`	`string`	中文名
└ `en_us`	`string`	英文名
└ `ja_jp`	`string`	日文名
└ `add_member_permission`	`string`	谁可以邀请成员（用户或机器人）入群可选值有： - all_members：所有成员 - only_owner：仅群主和管理员 - unknown：未设置
└ `share_card_permission`	`string`	群分享权限可选值有： - allowed：允许 - not_allowed：不允许 - unknown：未设置
└ `at_all_permission`	`string`	谁可以 at 所有人可选值有： - all_members：所有成员 - only_owner：仅群主和管理员 - unknown：未设置
└ `edit_permission`	`string`	谁可以编辑群可选值有： - all_members：所有成员 - only_owner：仅群主和管理员 - unknown：未设置
└ `membership_approval`	`string`	加群是否需要审批可选值有： - no_approval_required：无需审批 - approval_required：需要审批
└ `join_message_visibility`	`string`	入群提示消息的可见性可选值有： - only_owner：仅群主和管理员可见 - all_members：所有成员可见 - not_anyone：任何人均不可见
└ `leave_message_visibility`	`string`	出群消息可见性可选值有： - only_owner：仅群主和管理员可见 - all_members：所有成员可见 - not_anyone：任何人均不可见
└ `moderation_permission`	`string`	发言权限可选值有： - all_members：所有成员 - only_owner：仅群主和管理员说明：发言权限为指定群成员时，需要参考 `moderator_list` 参数。
└ `owner_id`	`user_id`	群主 ID
└ `union_id`	`string`	用户的 union id
└ `user_id`	`string`	用户的 user id 字段权限要求： `contact:user.employee_id:readonly` 获取用户 user ID
└ `open_id`	`string`	用户的 open id
└ `restricted_mode_setting`	`restricted_mode_setting`	防泄密模式设置
└ `status`	`boolean`	防泄密模式是否开启
└ `screenshot_has_permission_setting`	`string`	允许截屏录屏可选值有： - `all_members`: 所有成员允许截屏录屏 - `not_anyone`: 所有成员禁止截屏录屏
└ `download_has_permission_setting`	`string`	允许下载消息中图片、视频和文件可选值有： - `all_members`: 所有成员允许下载资源 - `not_anyone`: 所有成员禁止下载资源
└ `message_has_permission_setting`	`string`	允许复制和转发消息可选值有： - `all_members`: 所有成员允许复制和转发消息 - `not_anyone`: 所有成员禁止复制和转发消息
└ `group_message_type`	`string`	群消息形式可选值有： - chat：会话消息 - thread：话题消息
└ `moderator_list`	`moderator_list`	群可发言成员名单的变更信息
└ `added_member_list`	`list_event_moderator\[\]`	被添加进可发言名单的用户列表（该列表中一定有群主）
└ `tenant_key`	`string`	租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。
└ `user_id`	`user_id`	用户 ID
└ `union_id`	`string`	用户的 union id
└ `user_id`	`string`	用户的 user id 字段权限要求： `contact:user.employee_id:readonly` 获取用户 user ID
└ `open_id`	`string`	用户的 open id
└ `removed_member_list`	`list_event_moderator\[\]`	被移除出可发言名单的用户列表
└ `tenant_key`	`string`	租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。
└ `user_id`	`user_id`	用户 ID
└ `union_id`	`string`	用户的 union id
└ `user_id`	`string`	用户的 user id 字段权限要求： `contact:user.employee_id:readonly` 获取用户 user ID
└ `open_id`	`string`	用户的 open id

事件体示例

json

{
    "schema": "2.0",
    "header": {
        "event_id": "5e3702a84e847582be8db7fb73283c02",
        "event_type": "im.chat.updated_v1",
        "create_time": "1608725989000",
        "token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
        "app_id": "cli_9f5343c580712544",
        "tenant_key": "2ca1d211f64f6438"
    },
    "event": {
        "chat_id": "oc_413871888e0d5492e25b173f0812efb7",
        "operator_id": {
            "union_id": "on_8ed6aa67826108097d9ee143816345",
            "user_id": "e33ggbyz",
            "open_id": "ou_84aad35d084aa403a838cf73ee18467"
        },
        "external": false,
        "operator_tenant_key": "86gwe65",
        "after_change": {
            "avatar": "default-avatar_0cda3662-875a-4354-94d2-83e7393c7123",
            "name": "群名称测试",
            "description": "群描述测试",
            "i18n_names": {
                "zh_cn": "群聊",
                "en_us": "group chat",
                "ja_jp": "グループチャット"
            },
            "add_member_permission": "all_members",
            "share_card_permission": "allowed",
            "at_all_permission": "only_owner",
            "edit_permission": "all_members",
            "membership_approval": "approval_required",
            "join_message_visibility": "all_members",
            "leave_message_visibility": "all_members",
            "moderation_permission": "all_members",
            "owner_id": {
                "union_id": "on_8ed6aa67826108097d9ee143816345",
                "user_id": "e33ggbyz",
                "open_id": "ou_84aad35d084aa403a838cf73ee18467"
            },
            "restricted_mode_setting": {
                "status": false,
                "screenshot_has_permission_setting": "all_members",
                "download_has_permission_setting": "all_members",
                "message_has_permission_setting": "all_members"
            },
            "group_message_type": "thread"
        },
        "before_change": {
            "avatar": "default-avatar_0cda3662-875a-4354-94d2-83e7393c7123",
            "name": "群名称测试",
            "description": "群描述测试",
            "i18n_names": {
                "zh_cn": "群聊",
                "en_us": "group chat",
                "ja_jp": "グループチャット"
            },
            "add_member_permission": "all_members",
            "share_card_permission": "allowed",
            "at_all_permission": "only_owner",
            "edit_permission": "all_members",
            "membership_approval": "approval_required",
            "join_message_visibility": "all_members",
            "leave_message_visibility": "all_members",
            "moderation_permission": "all_members",
            "owner_id": {
                "union_id": "on_8ed6aa67826108097d9ee143816345",
                "user_id": "e33ggbyz",
                "open_id": "ou_84aad35d084aa403a838cf73ee18467"
            },
            "restricted_mode_setting": {
                "status": false,
                "screenshot_has_permission_setting": "all_members",
                "download_has_permission_setting": "all_members",
                "message_has_permission_setting": "all_members"
            },
            "group_message_type": "thread"
        },
        "moderator_list": {
            "added_member_list": [
                {
                    "tenant_key": "86gwe65",
                    "user_id": {
                        "union_id": "on_8ed6aa67826108097d9ee143816345",
                        "user_id": "e33ggbyz",
                        "open_id": "ou_84aad35d084aa403a838cf73ee18467"
                    }
                }
            ],
            "removed_member_list": [
                {
                    "tenant_key": "86gwe65",
                    "user_id": {
                        "union_id": "on_8ed6aa67826108097d9ee143816345",
                        "user_id": "e33ggbyz",
                        "open_id": "ou_84aad35d084aa403a838cf73ee18467"
                    }
                }
            ]
        }
    }
}

事件订阅示例代码

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

订阅方式

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

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/im/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("", "").
		OnP2ChatUpdatedV1(func(ctx context.Context, event *larkim.P2ChatUpdatedV1) error {
			fmt.Printf("[ OnP2ChatUpdatedV1 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_im_chat_updated_v1(data: lark.im.v1.P2ImChatUpdatedV1) -> None:
    print(f'[ do_p2_im_chat_updated_v1 access ], data: {lark.JSON.marshal(data, indent=4)}')

# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
    .register_p2_im_chat_updated_v1(do_p2_im_chat_updated_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.im.ImService;
import com.lark.oapi.service.im.v1.model.P2ChatUpdatedV1;
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("", "")
            .onP2ChatUpdatedV1(new ImService.P2ChatUpdatedV1Handler() {
                @Override
                public void handle(P2ChatUpdatedV1 event) throws Exception {
                    System.out.printf("[ onP2ChatUpdatedV1 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({
        'im.chat.updated_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/im/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("", "").
		OnP2ChatUpdatedV1(func(ctx context.Context, event *larkim.P2ChatUpdatedV1) error {
			fmt.Printf("[ OnP2ChatUpdatedV1 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_im_chat_updated_v1(data: lark.im.v1.P2ImChatUpdatedV1) -> None:
    print(f'[ do_p2_im_chat_updated_v1 access ], data: {lark.JSON.marshal(data, indent=4)}')

# 注册事件 Register event
event_handler = lark.EventDispatcherHandler.builder("", "") \
    .register_p2_im_chat_updated_v1(do_p2_im_chat_updated_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.im.ImService;
import com.lark.oapi.service.im.v1.model.P2ChatUpdatedV1;
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")
            .onP2ChatUpdatedV1(new ImService.P2ChatUpdatedV1Handler() {
                @Override
                public void handle(P2ChatUpdatedV1 event) throws Exception {
                    System.out.printf("[ onP2ChatUpdatedV1 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({
    'im.chat.updated_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);

事件

事件

群公告

群公告块

群配置修改

前提条件

使用限制

事件

事件体

事件体示例

事件订阅示例代码

群配置修改 ​

前提条件 ​

使用限制 ​

事件 ​

事件体 ​

事件体示例 ​

事件订阅示例代码 ​

群配置修改

前提条件

使用限制

事件

事件体

事件体示例

事件订阅示例代码