跳转至

chats

feishu.im.chats

ChatNamespace

Bases: Namespace

群组接口命名空间。

封装飞书群组相关的服务端接口，包括创建、查询、更新、解散群组，以及添加、移除、列举群成员等能力。

通常无需直接实例化，应通过 client.im.chats 访问。

飞书文档

群组管理概述

源代码位于： feishu/im/chats.py
Python
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
class ChatNamespace(Namespace):
    r"""
    群组接口命名空间。

    封装飞书群组相关的服务端接口，包括创建、查询、更新、解散群组，以及添加、移除、列举群成员等能力。

    通常无需直接实例化，应通过 `client.im.chats` 访问。

    飞书文档:
        [群组管理概述](https://open.feishu.cn/document/server-docs/group/chat/intro)
    """

    async def add_members(
        self, chat_id: str, id_list: builtins.list[str], *, member_id_type: str = "open_id"
    ) -> NestedDict:
        r"""
        将用户或机器人拉入群组。

        Args:
            chat_id: 群 ID。
            id_list: 要添加的成员 ID 列表。
            member_id_type: 成员 ID 类型，默认为 `open_id`。

        Returns:
            接口返回的数据，可能包含无效或失败的成员 ID 信息。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [将用户或机器人拉入群聊](https://open.feishu.cn/document/server-docs/group/chat-member/create)

        Examples:
            >>> await client.im.chats.add_members("oc_chat1", ["ou_user1", "ou_user2"])  # doctest:+SKIP
            {'invalid_id_list': [], ...}  # noqa: E501
        """
        return await self._request_data(
            "POST",
            f"im/v1/chats/{quote_segment(chat_id)}/members",
            params={"member_id_type": member_id_type},
            json={"id_list": id_list},
        )

    async def create(
        self,
        *,
        name: str | None = None,
        description: str | None = None,
        user_id_list: builtins.list[str] | None = None,
        bot_id_list: builtins.list[str] | None = None,
        chat_mode: str = "group",
        user_id_type: str = "open_id",
        **opts: Any,
    ) -> NestedDict:
        r"""
        创建群组。

        仅将显式传入的字段写入请求体，未设置的字段会被省略。额外的关键字参数（`opts`）中值为
        `None` 的项也会被忽略，其余项原样并入请求体。

        Args:
            name: 群名称。
            description: 群描述。
            user_id_list: 初始群成员的用户 ID 列表。
            bot_id_list: 初始群机器人的 ID 列表。
            chat_mode: 群模式，默认为 `group`。
            user_id_type: 用户 ID 类型，默认为 `open_id`。
            **opts: 其他创建参数，例如 `avatar`、`owner_id`、`chat_type` 等；值为 `None` 时忽略。

        Returns:
            创建后的群组数据，包含 `chat_id` 等字段。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [创建群](https://open.feishu.cn/document/server-docs/group/chat/create)

        Examples:
            >>> await client.im.chats.create(name="My Chat", user_id_list=["ou_abc"])  # doctest:+SKIP
            {'chat_id': 'oc_test123', ...}  # noqa: E501
        """
        body: dict[str, Any] = {}
        if name is not None:
            body["name"] = name
        if description is not None:
            body["description"] = description
        if user_id_list is not None:
            body["user_id_list"] = user_id_list
        if bot_id_list is not None:
            body["bot_id_list"] = bot_id_list
        if chat_mode is not None:
            body["chat_mode"] = chat_mode
        body.update({k: v for k, v in opts.items() if v is not None})
        return await self._request_data("POST", "im/v1/chats", params={"user_id_type": user_id_type}, json=body)

    async def disband(self, chat_id: str) -> NestedDict:
        r"""
        解散群组。

        Args:
            chat_id: 群 ID。

        Returns:
            接口返回的数据（通常为空）。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [解散群](https://open.feishu.cn/document/server-docs/group/chat/delete)

        Examples:
            >>> await client.im.chats.disband("oc_chat1")  # doctest:+SKIP
            {}
        """
        return await self._request_data("DELETE", f"im/v1/chats/{quote_segment(chat_id)}")

    async def get(self, chat_id: str, *, user_id_type: str = "open_id") -> NestedDict:
        r"""
        获取群信息。

        Args:
            chat_id: 群 ID。
            user_id_type: 返回的用户 ID 类型，默认为 `open_id`。

        Returns:
            群组数据。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [获取群信息](https://open.feishu.cn/document/server-docs/group/chat/get)

        Examples:
            >>> await client.im.chats.get("oc_chat1")  # doctest:+SKIP
            {'chat_id': 'oc_test123', ...}  # noqa: E501
        """
        return await self._request_data(
            "GET", f"im/v1/chats/{quote_segment(chat_id)}", params={"user_id_type": user_id_type}
        )

    async def list(
        self, *, user_id_type: str = "open_id", page_size: int = 50, max_items: int | None = None
    ) -> builtins.list[NestedDict]:
        r"""
        获取用户或机器人所在的群列表。

        自动翻页并将各页结果拼接为单个列表返回。`page_size` 会被限制在
        [feishu.consts.MAX_PAGE_SIZE][] 以内。

        Args:
            user_id_type: 返回的用户 ID 类型，默认为 `open_id`。
            page_size: 每页条数，默认为 50，超过上限时按上限截断。
            max_items: 最多返回的条数；为空表示返回全部。

        Returns:
            群组数据列表。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [获取用户或机器人所在的群列表](https://open.feishu.cn/document/server-docs/group/chat/list)

        Examples:
            >>> await client.im.chats.list()  # doctest:+SKIP
            [{'chat_id': 'oc_1', ...}, {'chat_id': 'oc_2', ...}]  # noqa: E501
        """
        return await self._client.paginate_get(
            "im/v1/chats",
            params={"user_id_type": user_id_type},
            page_size=page_size,
            max_items=max_items,
        )

    async def list_members(
        self, chat_id: str, *, member_id_type: str = "open_id", page_size: int = 50, max_items: int | None = None
    ) -> builtins.list[NestedDict]:
        r"""
        获取群成员列表。

        自动翻页并将各页结果拼接为单个列表返回。`page_size` 会被限制在
        [feishu.consts.MAX_PAGE_SIZE][] 以内。

        Args:
            chat_id: 群 ID。
            member_id_type: 成员 ID 类型，默认为 `open_id`。
            page_size: 每页条数，默认为 50，超过上限时按上限截断。
            max_items: 最多返回的条数；为空表示返回全部。

        Returns:
            群成员数据列表。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [获取群成员列表](https://open.feishu.cn/document/server-docs/group/chat-member/get)

        Examples:
            >>> await client.im.chats.list_members("oc_chat1")  # doctest:+SKIP
            [{'member_id': 'ou_1', ...}, {'member_id': 'ou_2', ...}]  # noqa: E501
        """
        return await self._client.paginate_get(
            f"im/v1/chats/{quote_segment(chat_id)}/members",
            params={"member_id_type": member_id_type},
            page_size=page_size,
            max_items=max_items,
        )

    async def remove_members(
        self, chat_id: str, id_list: builtins.list[str], *, member_id_type: str = "open_id"
    ) -> NestedDict:
        r"""
        将用户或机器人移出群组。

        Args:
            chat_id: 群 ID。
            id_list: 要移除的成员 ID 列表。
            member_id_type: 成员 ID 类型，默认为 `open_id`。

        Returns:
            接口返回的数据，可能包含无效或失败的成员 ID 信息。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [将用户或机器人移出群聊](https://open.feishu.cn/document/server-docs/group/chat-member/delete)

        Examples:
            >>> await client.im.chats.remove_members("oc_chat1", ["ou_user1"])  # doctest:+SKIP
            {'invalid_id_list': [], ...}  # noqa: E501
        """
        return await self._request_data(
            "DELETE",
            f"im/v1/chats/{quote_segment(chat_id)}/members",
            params={"member_id_type": member_id_type},
            json={"id_list": id_list},
        )

    async def update(
        self,
        chat_id: str,
        *,
        name: str | None = None,
        description: str | None = None,
        user_id_type: str = "open_id",
        **opts: Any,
    ) -> NestedDict:
        r"""
        更新群信息。

        仅将显式传入的字段写入请求体，未设置的字段会被省略。额外的关键字参数（`opts`）中值为
        `None` 的项也会被忽略。

        Args:
            chat_id: 群 ID。
            name: 新的群名称。
            description: 新的群描述。
            user_id_type: 用户 ID 类型，默认为 `open_id`。
            **opts: 其他可更新字段，例如 `avatar`、`owner_id` 等；值为 `None` 时忽略。

        Returns:
            更新后的群组数据。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [更新群信息](https://open.feishu.cn/document/server-docs/group/chat/update)

        Examples:
            >>> await client.im.chats.update("oc_chat1", name="New Name")  # doctest:+SKIP
            {'chat_id': 'oc_chat1', ...}  # noqa: E501
        """
        body: dict[str, Any] = {}
        if name is not None:
            body["name"] = name
        if description is not None:
            body["description"] = description
        body.update({k: v for k, v in opts.items() if v is not None})
        return await self._request_data(
            "PUT", f"im/v1/chats/{quote_segment(chat_id)}", params={"user_id_type": user_id_type}, json=body
        )

add_members async

Python
add_members(chat_id: str, id_list: list[str], *, member_id_type: str = 'open_id') -> NestedDict

将用户或机器人拉入群组。

参数：

名称 类型 描述 默认
chat_id
str

群 ID。

 必需
id_list
list[str]

要添加的成员 ID 列表。

 必需
member_id_type
str

成员 ID 类型，默认为 open_id。

 'open_id'

返回：

类型 描述
NestedDict

接口返回的数据，可能包含无效或失败的成员 ID 信息。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

将用户或机器人拉入群聊

示例：

Python Console Session
1
2
>>> await client.im.chats.add_members("oc_chat1", ["ou_user1", "ou_user2"])
{'invalid_id_list': [], ...}  # noqa: E501
源代码位于： feishu/im/chats.py
Python
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
async def add_members(
    self, chat_id: str, id_list: builtins.list[str], *, member_id_type: str = "open_id"
) -> NestedDict:
    r"""
    将用户或机器人拉入群组。

    Args:
        chat_id: 群 ID。
        id_list: 要添加的成员 ID 列表。
        member_id_type: 成员 ID 类型，默认为 `open_id`。

    Returns:
        接口返回的数据，可能包含无效或失败的成员 ID 信息。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [将用户或机器人拉入群聊](https://open.feishu.cn/document/server-docs/group/chat-member/create)

    Examples:
        >>> await client.im.chats.add_members("oc_chat1", ["ou_user1", "ou_user2"])  # doctest:+SKIP
        {'invalid_id_list': [], ...}  # noqa: E501
    """
    return await self._request_data(
        "POST",
        f"im/v1/chats/{quote_segment(chat_id)}/members",
        params={"member_id_type": member_id_type},
        json={"id_list": id_list},
    )

create async

Python
create(*, name: str | None = None, description: str | None = None, user_id_list: list[str] | None = None, bot_id_list: list[str] | None = None, chat_mode: str = 'group', user_id_type: str = 'open_id', **opts: Any) -> NestedDict

创建群组。

仅将显式传入的字段写入请求体，未设置的字段会被省略。额外的关键字参数（opts）中值为 None 的项也会被忽略，其余项原样并入请求体。

参数：

名称 类型 描述 默认
name
str | None

群名称。

 None
description
str | None

群描述。

 None
user_id_list
list[str] | None

初始群成员的用户 ID 列表。

 None
bot_id_list
list[str] | None

初始群机器人的 ID 列表。

 None
chat_mode
str

群模式，默认为 group。

 'group'
user_id_type
str

用户 ID 类型，默认为 open_id。

 'open_id'
**opts
Any

其他创建参数，例如 avatar、owner_id、chat_type 等；值为 None 时忽略。

 {}

返回：

类型 描述
NestedDict

创建后的群组数据，包含 chat_id 等字段。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

创建群

示例：

Python Console Session
1
2
>>> await client.im.chats.create(name="My Chat", user_id_list=["ou_abc"])
{'chat_id': 'oc_test123', ...}  # noqa: E501
源代码位于： feishu/im/chats.py
Python
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
async def create(
    self,
    *,
    name: str | None = None,
    description: str | None = None,
    user_id_list: builtins.list[str] | None = None,
    bot_id_list: builtins.list[str] | None = None,
    chat_mode: str = "group",
    user_id_type: str = "open_id",
    **opts: Any,
) -> NestedDict:
    r"""
    创建群组。

    仅将显式传入的字段写入请求体，未设置的字段会被省略。额外的关键字参数（`opts`）中值为
    `None` 的项也会被忽略，其余项原样并入请求体。

    Args:
        name: 群名称。
        description: 群描述。
        user_id_list: 初始群成员的用户 ID 列表。
        bot_id_list: 初始群机器人的 ID 列表。
        chat_mode: 群模式，默认为 `group`。
        user_id_type: 用户 ID 类型，默认为 `open_id`。
        **opts: 其他创建参数，例如 `avatar`、`owner_id`、`chat_type` 等；值为 `None` 时忽略。

    Returns:
        创建后的群组数据，包含 `chat_id` 等字段。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [创建群](https://open.feishu.cn/document/server-docs/group/chat/create)

    Examples:
        >>> await client.im.chats.create(name="My Chat", user_id_list=["ou_abc"])  # doctest:+SKIP
        {'chat_id': 'oc_test123', ...}  # noqa: E501
    """
    body: dict[str, Any] = {}
    if name is not None:
        body["name"] = name
    if description is not None:
        body["description"] = description
    if user_id_list is not None:
        body["user_id_list"] = user_id_list
    if bot_id_list is not None:
        body["bot_id_list"] = bot_id_list
    if chat_mode is not None:
        body["chat_mode"] = chat_mode
    body.update({k: v for k, v in opts.items() if v is not None})
    return await self._request_data("POST", "im/v1/chats", params={"user_id_type": user_id_type}, json=body)

disband async

Python
disband(chat_id: str) -> NestedDict

解散群组。

参数：

名称 类型 描述 默认
chat_id
str

群 ID。

 必需

返回：

类型 描述
NestedDict

接口返回的数据（通常为空）。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

解散群

示例：

Python Console Session
1
2
>>> await client.im.chats.disband("oc_chat1")
{}
源代码位于： feishu/im/chats.py
Python
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
async def disband(self, chat_id: str) -> NestedDict:
    r"""
    解散群组。

    Args:
        chat_id: 群 ID。

    Returns:
        接口返回的数据（通常为空）。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [解散群](https://open.feishu.cn/document/server-docs/group/chat/delete)

    Examples:
        >>> await client.im.chats.disband("oc_chat1")  # doctest:+SKIP
        {}
    """
    return await self._request_data("DELETE", f"im/v1/chats/{quote_segment(chat_id)}")

get async

Python
get(chat_id: str, *, user_id_type: str = 'open_id') -> NestedDict

获取群信息。

参数：

名称 类型 描述 默认
chat_id
str

群 ID。

 必需
user_id_type
str

返回的用户 ID 类型，默认为 open_id。

 'open_id'

返回：

类型 描述
NestedDict

群组数据。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

获取群信息

示例：

Python Console Session
1
2
>>> await client.im.chats.get("oc_chat1")
{'chat_id': 'oc_test123', ...}  # noqa: E501
源代码位于： feishu/im/chats.py
Python
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
async def get(self, chat_id: str, *, user_id_type: str = "open_id") -> NestedDict:
    r"""
    获取群信息。

    Args:
        chat_id: 群 ID。
        user_id_type: 返回的用户 ID 类型，默认为 `open_id`。

    Returns:
        群组数据。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [获取群信息](https://open.feishu.cn/document/server-docs/group/chat/get)

    Examples:
        >>> await client.im.chats.get("oc_chat1")  # doctest:+SKIP
        {'chat_id': 'oc_test123', ...}  # noqa: E501
    """
    return await self._request_data(
        "GET", f"im/v1/chats/{quote_segment(chat_id)}", params={"user_id_type": user_id_type}
    )

list async

Python
list(*, user_id_type: str = 'open_id', page_size: int = 50, max_items: int | None = None) -> list[NestedDict]

获取用户或机器人所在的群列表。

自动翻页并将各页结果拼接为单个列表返回。page_size 会被限制在 [feishu.consts.MAX_PAGE_SIZE][] 以内。

参数：

名称 类型 描述 默认
user_id_type
str

返回的用户 ID 类型，默认为 open_id。

 'open_id'
page_size
int

每页条数，默认为 50，超过上限时按上限截断。

 50
max_items
int | None

最多返回的条数；为空表示返回全部。

 None

返回：

类型 描述
list[NestedDict]

群组数据列表。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

获取用户或机器人所在的群列表

示例：

Python Console Session
1
2
>>> await client.im.chats.list()
[{'chat_id': 'oc_1', ...}, {'chat_id': 'oc_2', ...}]  # noqa: E501
源代码位于： feishu/im/chats.py
Python
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
async def list(
    self, *, user_id_type: str = "open_id", page_size: int = 50, max_items: int | None = None
) -> builtins.list[NestedDict]:
    r"""
    获取用户或机器人所在的群列表。

    自动翻页并将各页结果拼接为单个列表返回。`page_size` 会被限制在
    [feishu.consts.MAX_PAGE_SIZE][] 以内。

    Args:
        user_id_type: 返回的用户 ID 类型，默认为 `open_id`。
        page_size: 每页条数，默认为 50，超过上限时按上限截断。
        max_items: 最多返回的条数；为空表示返回全部。

    Returns:
        群组数据列表。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [获取用户或机器人所在的群列表](https://open.feishu.cn/document/server-docs/group/chat/list)

    Examples:
        >>> await client.im.chats.list()  # doctest:+SKIP
        [{'chat_id': 'oc_1', ...}, {'chat_id': 'oc_2', ...}]  # noqa: E501
    """
    return await self._client.paginate_get(
        "im/v1/chats",
        params={"user_id_type": user_id_type},
        page_size=page_size,
        max_items=max_items,
    )

list_members async

Python
list_members(chat_id: str, *, member_id_type: str = 'open_id', page_size: int = 50, max_items: int | None = None) -> list[NestedDict]

获取群成员列表。

自动翻页并将各页结果拼接为单个列表返回。page_size 会被限制在 [feishu.consts.MAX_PAGE_SIZE][] 以内。

参数：

名称 类型 描述 默认
chat_id
str

群 ID。

 必需
member_id_type
str

成员 ID 类型，默认为 open_id。

 'open_id'
page_size
int

每页条数，默认为 50，超过上限时按上限截断。

 50
max_items
int | None

最多返回的条数；为空表示返回全部。

 None

返回：

类型 描述
list[NestedDict]

群成员数据列表。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

获取群成员列表

示例：

Python Console Session
1
2
>>> await client.im.chats.list_members("oc_chat1")
[{'member_id': 'ou_1', ...}, {'member_id': 'ou_2', ...}]  # noqa: E501
源代码位于： feishu/im/chats.py
Python
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
async def list_members(
    self, chat_id: str, *, member_id_type: str = "open_id", page_size: int = 50, max_items: int | None = None
) -> builtins.list[NestedDict]:
    r"""
    获取群成员列表。

    自动翻页并将各页结果拼接为单个列表返回。`page_size` 会被限制在
    [feishu.consts.MAX_PAGE_SIZE][] 以内。

    Args:
        chat_id: 群 ID。
        member_id_type: 成员 ID 类型，默认为 `open_id`。
        page_size: 每页条数，默认为 50，超过上限时按上限截断。
        max_items: 最多返回的条数；为空表示返回全部。

    Returns:
        群成员数据列表。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [获取群成员列表](https://open.feishu.cn/document/server-docs/group/chat-member/get)

    Examples:
        >>> await client.im.chats.list_members("oc_chat1")  # doctest:+SKIP
        [{'member_id': 'ou_1', ...}, {'member_id': 'ou_2', ...}]  # noqa: E501
    """
    return await self._client.paginate_get(
        f"im/v1/chats/{quote_segment(chat_id)}/members",
        params={"member_id_type": member_id_type},
        page_size=page_size,
        max_items=max_items,
    )

remove_members async

Python
remove_members(chat_id: str, id_list: list[str], *, member_id_type: str = 'open_id') -> NestedDict

将用户或机器人移出群组。

参数：

名称 类型 描述 默认
chat_id
str

群 ID。

 必需
id_list
list[str]

要移除的成员 ID 列表。

 必需
member_id_type
str

成员 ID 类型，默认为 open_id。

 'open_id'

返回：

类型 描述
NestedDict

接口返回的数据，可能包含无效或失败的成员 ID 信息。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

将用户或机器人移出群聊

示例：

Python Console Session
1
2
>>> await client.im.chats.remove_members("oc_chat1", ["ou_user1"])
{'invalid_id_list': [], ...}  # noqa: E501
源代码位于： feishu/im/chats.py
Python
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
async def remove_members(
    self, chat_id: str, id_list: builtins.list[str], *, member_id_type: str = "open_id"
) -> NestedDict:
    r"""
    将用户或机器人移出群组。

    Args:
        chat_id: 群 ID。
        id_list: 要移除的成员 ID 列表。
        member_id_type: 成员 ID 类型，默认为 `open_id`。

    Returns:
        接口返回的数据，可能包含无效或失败的成员 ID 信息。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [将用户或机器人移出群聊](https://open.feishu.cn/document/server-docs/group/chat-member/delete)

    Examples:
        >>> await client.im.chats.remove_members("oc_chat1", ["ou_user1"])  # doctest:+SKIP
        {'invalid_id_list': [], ...}  # noqa: E501
    """
    return await self._request_data(
        "DELETE",
        f"im/v1/chats/{quote_segment(chat_id)}/members",
        params={"member_id_type": member_id_type},
        json={"id_list": id_list},
    )

update async

Python
update(chat_id: str, *, name: str | None = None, description: str | None = None, user_id_type: str = 'open_id', **opts: Any) -> NestedDict

更新群信息。

仅将显式传入的字段写入请求体，未设置的字段会被省略。额外的关键字参数（opts）中值为 None 的项也会被忽略。

参数：

名称 类型 描述 默认
chat_id
str

群 ID。

 必需
name
str | None

新的群名称。

 None
description
str | None

新的群描述。

 None
user_id_type
str

用户 ID 类型，默认为 open_id。

 'open_id'
**opts
Any

其他可更新字段，例如 avatar、owner_id 等；值为 None 时忽略。

 {}

返回：

类型 描述
NestedDict

更新后的群组数据。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

更新群信息

示例：

Python Console Session
1
2
>>> await client.im.chats.update("oc_chat1", name="New Name")
{'chat_id': 'oc_chat1', ...}  # noqa: E501
源代码位于： feishu/im/chats.py
Python
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
async def update(
    self,
    chat_id: str,
    *,
    name: str | None = None,
    description: str | None = None,
    user_id_type: str = "open_id",
    **opts: Any,
) -> NestedDict:
    r"""
    更新群信息。

    仅将显式传入的字段写入请求体，未设置的字段会被省略。额外的关键字参数（`opts`）中值为
    `None` 的项也会被忽略。

    Args:
        chat_id: 群 ID。
        name: 新的群名称。
        description: 新的群描述。
        user_id_type: 用户 ID 类型，默认为 `open_id`。
        **opts: 其他可更新字段，例如 `avatar`、`owner_id` 等；值为 `None` 时忽略。

    Returns:
        更新后的群组数据。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [更新群信息](https://open.feishu.cn/document/server-docs/group/chat/update)

    Examples:
        >>> await client.im.chats.update("oc_chat1", name="New Name")  # doctest:+SKIP
        {'chat_id': 'oc_chat1', ...}  # noqa: E501
    """
    body: dict[str, Any] = {}
    if name is not None:
        body["name"] = name
    if description is not None:
        body["description"] = description
    body.update({k: v for k, v in opts.items() if v is not None})
    return await self._request_data(
        "PUT", f"im/v1/chats/{quote_segment(chat_id)}", params={"user_id_type": user_id_type}, json=body
    )