跳转至

rooms

feishu.meeting_room.rooms

MeetingRoomNamespace

Bases: Namespace

会议室接口命名空间。

通过 client.meeting_room 访问，封装会议室列表、详情与忙闲查询能力。 预订会议室本身通过创建日程后添加 type=resource 的日程参与人完成。

飞书文档

获取会议室列表

查询会议室详情

查询会议室忙闲

源代码位于： feishu/meeting_room/rooms.py
Python
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 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
class MeetingRoomNamespace(Namespace):
    r"""
    会议室接口命名空间。

    通过 `client.meeting_room` 访问，封装会议室列表、详情与忙闲查询能力。
    预订会议室本身通过创建日程后添加 `type=resource` 的日程参与人完成。

    飞书文档:
        [获取会议室列表](https://open.feishu.cn/document/ukTMukTMukTM/uADOyUjLwgjM14CM4ITN)

        [查询会议室详情](https://open.feishu.cn/document/ukTMukTMukTM/uEDOyUjLxgjM14SM4ITN)

        [查询会议室忙闲](https://open.feishu.cn/document/server-docs/calendar-v4/meeting-room-event/query-room-availability)
    """

    async def list_buildings(
        self,
        *,
        order_by: str | None = None,
        fields: str | Sequence[str] | None = None,
        page_size: int = 100,
        max_items: int | None = None,
    ) -> _NestedDictList:
        r"""
        获取建筑物列表。

        Args:
            order_by: 排序，如 `name-asc`、`name-desc`。
            fields: 返回字段，字符串或字符串序列；为空时使用接口默认字段。
            page_size: 每页数量。
            max_items: 最多返回数量。
        """
        return await self._client.paginate_get(
            "meeting_room/building/list",
            params={"order_by": order_by, "fields": _fields(fields)},
            page_size=page_size,
            max_items=max_items,
            items_key="buildings",
        )

    async def batch_get_buildings(
        self,
        building_ids: Sequence[str],
        *,
        fields: str | Sequence[str] | None = None,
    ) -> _NestedDictList:
        r"""
        查询建筑物详情。

        Args:
            building_ids: 建筑物 ID 列表。
            fields: 返回字段，字符串或字符串序列；为空时使用接口默认字段。
        """
        data = await self._request_data(
            "GET",
            "meeting_room/building/batch_get",
            params={"building_ids": list(building_ids), "fields": _fields(fields)},
        )
        return list(data.get("buildings") or [])

    async def list(
        self,
        *,
        building_id: str | None = None,
        order_by: str | None = None,
        fields: str | Sequence[str] | None = None,
        page_size: int = 100,
        max_items: int | None = None,
    ) -> _NestedDictList:
        r"""
        获取会议室列表（按建筑筛选）。

        本方法调用旧版 `meeting_room/room/list`，其文档化的筛选参数是 `building_id`。会议室「层级」
        （room_level_id）筛选属于新版 `vc/v1/rooms` 接口，本方法不支持，故不暴露该参数以免静默失效。

        Args:
            building_id: 建筑物 ID（按建筑筛选会议室）。
            order_by: 排序，如 `name-asc`、`name-desc`、`floor_name-asc`、`floor_name-desc`。
            fields: 返回字段，字符串或字符串序列；为空时使用接口默认字段。
            page_size: 每页数量。
            max_items: 最多返回数量。
        """
        params = {
            "building_id": building_id,
            "order_by": order_by,
            "fields": _fields(fields),
        }
        return await self._client.paginate_get(
            "meeting_room/room/list",
            params=params,
            page_size=page_size,
            max_items=max_items,
            items_key="rooms",
        )

    async def batch_get(
        self,
        room_ids: Sequence[str],
        *,
        fields: str | Sequence[str] | None = None,
    ) -> _NestedDictList:
        r"""
        查询会议室详情。

        Args:
            room_ids: 会议室 ID 列表。
            fields: 返回字段，字符串或字符串序列；为空时使用接口默认字段。
        """
        params = {"room_ids": list(room_ids), "fields": _fields(fields)}
        data = await self._request_data("GET", "meeting_room/room/batch_get", params=params)
        return list(data.get("rooms") or [])

    async def freebusy(
        self,
        room_ids: Sequence[str],
        *,
        time_min: Any,
        time_max: Any,
        timezone: str = DEFAULT_TIMEZONE,
    ) -> NestedDict:
        r"""
        查询会议室忙闲。

        Args:
            room_ids: 会议室 ID 列表。
            time_min: 查询开始时间，支持 ISO/RFC3339 字符串、Unix 秒等。
            time_max: 查询结束时间，支持 ISO/RFC3339 字符串、Unix 秒等。
            timezone: 当时间没有时区时使用的默认时区。
        """
        params = {
            "room_ids": list(room_ids),
            "time_min": rfc3339(time_min, timezone=timezone),
            "time_max": rfc3339(time_max, timezone=timezone),
        }
        return await self._request_data("GET", "meeting_room/freebusy/batch_get", params=params)

list_buildings async

Python
list_buildings(*, order_by: str | None = None, fields: str | Sequence[str] | None = None, page_size: int = 100, max_items: int | None = None) -> _NestedDictList

获取建筑物列表。

参数：

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

排序，如 name-asc、name-desc。

 None
fields
str | Sequence[str] | None

返回字段，字符串或字符串序列；为空时使用接口默认字段。

 None
page_size
int

每页数量。

 100
max_items
int | None

最多返回数量。

 None
源代码位于： feishu/meeting_room/rooms.py
Python
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
async def list_buildings(
    self,
    *,
    order_by: str | None = None,
    fields: str | Sequence[str] | None = None,
    page_size: int = 100,
    max_items: int | None = None,
) -> _NestedDictList:
    r"""
    获取建筑物列表。

    Args:
        order_by: 排序，如 `name-asc`、`name-desc`。
        fields: 返回字段，字符串或字符串序列；为空时使用接口默认字段。
        page_size: 每页数量。
        max_items: 最多返回数量。
    """
    return await self._client.paginate_get(
        "meeting_room/building/list",
        params={"order_by": order_by, "fields": _fields(fields)},
        page_size=page_size,
        max_items=max_items,
        items_key="buildings",
    )

batch_get_buildings async

Python
batch_get_buildings(building_ids: Sequence[str], *, fields: str | Sequence[str] | None = None) -> _NestedDictList

查询建筑物详情。

参数：

名称 类型 描述 默认
building_ids
Sequence[str]

建筑物 ID 列表。

 必需
fields
str | Sequence[str] | None

返回字段，字符串或字符串序列；为空时使用接口默认字段。

 None
源代码位于： feishu/meeting_room/rooms.py
Python
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
async def batch_get_buildings(
    self,
    building_ids: Sequence[str],
    *,
    fields: str | Sequence[str] | None = None,
) -> _NestedDictList:
    r"""
    查询建筑物详情。

    Args:
        building_ids: 建筑物 ID 列表。
        fields: 返回字段，字符串或字符串序列；为空时使用接口默认字段。
    """
    data = await self._request_data(
        "GET",
        "meeting_room/building/batch_get",
        params={"building_ids": list(building_ids), "fields": _fields(fields)},
    )
    return list(data.get("buildings") or [])

list async

Python
list(*, building_id: str | None = None, order_by: str | None = None, fields: str | Sequence[str] | None = None, page_size: int = 100, max_items: int | None = None) -> _NestedDictList

获取会议室列表（按建筑筛选）。

本方法调用旧版 meeting_room/room/list，其文档化的筛选参数是 building_id。会议室「层级」 （room_level_id）筛选属于新版 vc/v1/rooms 接口，本方法不支持，故不暴露该参数以免静默失效。

参数：

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

建筑物 ID（按建筑筛选会议室）。

 None
order_by
str | None

排序，如 name-asc、name-desc、floor_name-asc、floor_name-desc。

 None
fields
str | Sequence[str] | None

返回字段，字符串或字符串序列；为空时使用接口默认字段。

 None
page_size
int

每页数量。

 100
max_items
int | None

最多返回数量。

 None
源代码位于： feishu/meeting_room/rooms.py
Python
 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
async def list(
    self,
    *,
    building_id: str | None = None,
    order_by: str | None = None,
    fields: str | Sequence[str] | None = None,
    page_size: int = 100,
    max_items: int | None = None,
) -> _NestedDictList:
    r"""
    获取会议室列表（按建筑筛选）。

    本方法调用旧版 `meeting_room/room/list`，其文档化的筛选参数是 `building_id`。会议室「层级」
    （room_level_id）筛选属于新版 `vc/v1/rooms` 接口，本方法不支持，故不暴露该参数以免静默失效。

    Args:
        building_id: 建筑物 ID（按建筑筛选会议室）。
        order_by: 排序，如 `name-asc`、`name-desc`、`floor_name-asc`、`floor_name-desc`。
        fields: 返回字段，字符串或字符串序列；为空时使用接口默认字段。
        page_size: 每页数量。
        max_items: 最多返回数量。
    """
    params = {
        "building_id": building_id,
        "order_by": order_by,
        "fields": _fields(fields),
    }
    return await self._client.paginate_get(
        "meeting_room/room/list",
        params=params,
        page_size=page_size,
        max_items=max_items,
        items_key="rooms",
    )

batch_get async

Python
batch_get(room_ids: Sequence[str], *, fields: str | Sequence[str] | None = None) -> _NestedDictList

查询会议室详情。

参数：

名称 类型 描述 默认
room_ids
Sequence[str]

会议室 ID 列表。

 必需
fields
str | Sequence[str] | None

返回字段，字符串或字符串序列；为空时使用接口默认字段。

 None
源代码位于： feishu/meeting_room/rooms.py
Python
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
async def batch_get(
    self,
    room_ids: Sequence[str],
    *,
    fields: str | Sequence[str] | None = None,
) -> _NestedDictList:
    r"""
    查询会议室详情。

    Args:
        room_ids: 会议室 ID 列表。
        fields: 返回字段，字符串或字符串序列；为空时使用接口默认字段。
    """
    params = {"room_ids": list(room_ids), "fields": _fields(fields)}
    data = await self._request_data("GET", "meeting_room/room/batch_get", params=params)
    return list(data.get("rooms") or [])

freebusy async

Python
freebusy(room_ids: Sequence[str], *, time_min: Any, time_max: Any, timezone: str = DEFAULT_TIMEZONE) -> NestedDict

查询会议室忙闲。

参数：

名称 类型 描述 默认
room_ids
Sequence[str]

会议室 ID 列表。

 必需
time_min
Any

查询开始时间，支持 ISO/RFC3339 字符串、Unix 秒等。

 必需
time_max
Any

查询结束时间，支持 ISO/RFC3339 字符串、Unix 秒等。

 必需
timezone
str

当时间没有时区时使用的默认时区。

 DEFAULT_TIMEZONE
源代码位于： feishu/meeting_room/rooms.py
Python
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
async def freebusy(
    self,
    room_ids: Sequence[str],
    *,
    time_min: Any,
    time_max: Any,
    timezone: str = DEFAULT_TIMEZONE,
) -> NestedDict:
    r"""
    查询会议室忙闲。

    Args:
        room_ids: 会议室 ID 列表。
        time_min: 查询开始时间，支持 ISO/RFC3339 字符串、Unix 秒等。
        time_max: 查询结束时间，支持 ISO/RFC3339 字符串、Unix 秒等。
        timezone: 当时间没有时区时使用的默认时区。
    """
    params = {
        "room_ids": list(room_ids),
        "time_min": rfc3339(time_min, timezone=timezone),
        "time_max": rfc3339(time_max, timezone=timezone),
    }
    return await self._request_data("GET", "meeting_room/freebusy/batch_get", params=params)