跳转至

rooms

feishu.agent.toolkit.rooms

会议室工具工厂：列出会议室、查询会议室忙闲、预订会议室（需审批）。详见 feishu.agent.toolkit。

list_meeting_room_buildings

Python
list_meeting_room_buildings(*, description: str, name: str = 'list_meeting_room_buildings', as_user: bool = True, auth_scopes: Sequence[str] = ()) -> Tool

读类工厂：列出会议室所在的建筑 / 楼宇，返回一个 feishu.agent.tools.Tool。

用于先发现 building_id，再用 feishu.agent.toolkit.rooms.list_meeting_rooms 在该建筑内列会议室。

参数：

名称 类型 描述 默认

description

str

工具描述（产品本地化文案）。

 必需

name

str

工具名。默认为 "list_meeting_room_buildings"。

 'list_meeting_room_buildings'

as_user

bool

是否以请求用户身份读取。默认为 True（用户态读取，权限受该用户自身约束）。

 True

auth_scopes

Sequence[str]

缺少授权时申请的飞书权限范围。

 ()

返回：

类型 描述
Tool

可注册到 feishu.agent.tools.ToolRegistry 的 feishu.agent.tools.Tool。

示例：

Python Console Session
1
2
3
>>> tool = list_meeting_room_buildings(description="列出建筑")
>>> tool.name, tool.requires_approval
('list_meeting_room_buildings', False)
源代码位于： feishu/agent/toolkit/rooms.py
Python
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
def list_meeting_room_buildings(
    *,
    description: str,
    name: str = "list_meeting_room_buildings",
    as_user: bool = True,
    auth_scopes: Sequence[str] = (),
) -> Tool:
    r"""
    读类工厂：列出会议室所在的建筑 / 楼宇，返回一个 [feishu.agent.tools.Tool][]。

    用于先发现 `building_id`，再用 [feishu.agent.toolkit.rooms.list_meeting_rooms][] 在该建筑内列会议室。

    Args:
        description: 工具描述（产品本地化文案）。
        name: 工具名。默认为 `"list_meeting_room_buildings"`。
        as_user: 是否以请求用户身份读取。默认为 `True`（用户态读取，权限受该用户自身约束）。
        auth_scopes: 缺少授权时申请的飞书权限范围。

    Returns:
        可注册到 [feishu.agent.tools.ToolRegistry][] 的 [feishu.agent.tools.Tool][]。

    Examples:
        >>> tool = list_meeting_room_buildings(description="列出建筑")
        >>> tool.name, tool.requires_approval
        ('list_meeting_room_buildings', False)
    """
    input_schema: dict[str, Any] = {
        "type": "object",
        "properties": {"max_items": {"type": "integer", "description": "Maximum number of buildings to return"}},
        "additionalProperties": False,
    }

    async def handler(**arguments: Any) -> ToolResult:
        client = await resolve_client(as_user=as_user)
        if client is None:
            return needs_user_auth(auth_scopes)
        buildings = await client.meeting_room.list_buildings(max_items=arguments.get("max_items"))
        return ToolResult(ToolOutcome.COMPLETED, content=buildings)

    return Tool(
        name=name,
        description=description,
        input_schema=input_schema,
        handler=handler,
        auth_scopes=tuple(auth_scopes),
    )

list_meeting_rooms

Python
list_meeting_rooms(*, description: str, name: str = 'list_meeting_rooms', as_user: bool = True, auth_scopes: Sequence[str] = ()) -> Tool

读类工厂：列出某建筑内的会议室，返回一个 feishu.agent.tools.Tool。

读取指定建筑下的会议室目录。未提供 building_id 时，模型应先通过 feishu.agent.toolkit.rooms.list_meeting_room_buildings 发现建筑；遍历所有建筑并合并结果属于产品层策略， 本工厂不内置。按会议室能力筛选需要更新的 vc/v1/rooms 接口，当前旧版会议室列表接口不提供该能力。

参数：

名称 类型 描述 默认

description

str

工具描述（产品本地化文案）。

 必需

name

str

工具名。默认为 "list_meeting_rooms"。

 'list_meeting_rooms'

as_user

bool

是否以请求用户身份读取。默认为 True（用户态读取，权限受该用户自身约束）。

 True

auth_scopes

Sequence[str]

缺少授权时申请的飞书权限范围。

 ()

返回：

类型 描述
Tool

可注册到 feishu.agent.tools.ToolRegistry 的 feishu.agent.tools.Tool。

示例：

Python Console Session
1
2
3
>>> tool = list_meeting_rooms(description="x")
>>> tool.name, tool.requires_approval
('list_meeting_rooms', False)
源代码位于： feishu/agent/toolkit/rooms.py
Python
 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
def list_meeting_rooms(
    *,
    description: str,
    name: str = "list_meeting_rooms",
    # User scope (zero-trust): the meeting_room API accepts user_access_token (calendar:room:readonly,
    # user-granted), so read as the requesting user — bounded by their own permissions — not the tenant.
    as_user: bool = True,
    auth_scopes: Sequence[str] = (),
) -> Tool:
    r"""
    读类工厂：列出某建筑内的会议室，返回一个 [feishu.agent.tools.Tool][]。

    读取指定建筑下的会议室目录。未提供 `building_id` 时，模型应先通过
    [feishu.agent.toolkit.rooms.list_meeting_room_buildings][] 发现建筑；遍历所有建筑并合并结果属于产品层策略，
    本工厂不内置。按会议室能力筛选需要更新的 `vc/v1/rooms` 接口，当前旧版会议室列表接口不提供该能力。

    Args:
        description: 工具描述（产品本地化文案）。
        name: 工具名。默认为 `"list_meeting_rooms"`。
        as_user: 是否以请求用户身份读取。默认为 `True`（用户态读取，权限受该用户自身约束）。
        auth_scopes: 缺少授权时申请的飞书权限范围。

    Returns:
        可注册到 [feishu.agent.tools.ToolRegistry][] 的 [feishu.agent.tools.Tool][]。

    Examples:
        >>> tool = list_meeting_rooms(description="x")
        >>> tool.name, tool.requires_approval
        ('list_meeting_rooms', False)
    """
    input_schema: dict[str, Any] = {
        "type": "object",
        "properties": {
            "building_id": {"type": "string", "description": "Building ID to list rooms in"},
            "order_by": {"type": "string", "description": "e.g. name-asc, name-desc, floor_name-asc"},
            "max_items": {"type": "integer", "description": "Maximum number of rooms to return"},
        },
        "additionalProperties": False,
    }

    async def handler(**arguments: Any) -> ToolResult:
        client = await resolve_client(as_user=as_user)
        if client is None:
            return needs_user_auth(auth_scopes)
        rooms = await client.meeting_room.list(
            building_id=arguments.get("building_id"),
            order_by=arguments.get("order_by"),
            max_items=arguments.get("max_items"),
        )
        return ToolResult(ToolOutcome.COMPLETED, content=rooms)

    return Tool(
        name=name,
        description=description,
        input_schema=input_schema,
        handler=handler,
        auth_scopes=tuple(auth_scopes),
    )

query_meeting_room_freebusy

Python
query_meeting_room_freebusy(*, description: str, name: str = 'query_meeting_room_freebusy', as_user: bool = True, auth_scopes: Sequence[str] = ()) -> Tool

读类工厂：查询会议室在某时间段内的忙闲，返回一个 feishu.agent.tools.Tool。

参数：

名称 类型 描述 默认

description

str

工具描述（产品本地化文案）。

 必需

name

str

工具名。默认为 "query_meeting_room_freebusy"。

 'query_meeting_room_freebusy'

as_user

bool

是否以请求用户身份读取。默认为 True。

 True

auth_scopes

Sequence[str]

缺少授权时申请的飞书权限范围。

 ()

返回：

类型 描述
Tool

可注册到 feishu.agent.tools.ToolRegistry 的 feishu.agent.tools.Tool。

示例：

Python Console Session
1
2
3
>>> tool = query_meeting_room_freebusy(description="x")
>>> tool.name, tool.requires_approval
('query_meeting_room_freebusy', False)
源代码位于： feishu/agent/toolkit/rooms.py
Python
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
def query_meeting_room_freebusy(
    *,
    description: str,
    name: str = "query_meeting_room_freebusy",
    # User scope (zero-trust): meeting_room API accepts user_access_token (calendar:room:readonly).
    as_user: bool = True,
    auth_scopes: Sequence[str] = (),
) -> Tool:
    r"""
    读类工厂：查询会议室在某时间段内的忙闲，返回一个 [feishu.agent.tools.Tool][]。

    Args:
        description: 工具描述（产品本地化文案）。
        name: 工具名。默认为 `"query_meeting_room_freebusy"`。
        as_user: 是否以请求用户身份读取。默认为 `True`。
        auth_scopes: 缺少授权时申请的飞书权限范围。

    Returns:
        可注册到 [feishu.agent.tools.ToolRegistry][] 的 [feishu.agent.tools.Tool][]。

    Examples:
        >>> tool = query_meeting_room_freebusy(description="x")
        >>> tool.name, tool.requires_approval
        ('query_meeting_room_freebusy', False)
    """
    input_schema: dict[str, Any] = {
        "type": "object",
        "properties": {
            "room_ids": {
                "type": "array",
                "items": {"type": "string"},
                "description": "Meeting room IDs to check",
            },
            "time_min": {"type": "string", "description": "ISO 8601 start of the range"},
            "time_max": {"type": "string", "description": "ISO 8601 end of the range"},
        },
        "required": ["room_ids", "time_min", "time_max"],
        "additionalProperties": False,
    }

    async def handler(**arguments: Any) -> ToolResult:
        client = await resolve_client(as_user=as_user)
        if client is None:
            return needs_user_auth(auth_scopes)
        freebusy = await client.meeting_room.freebusy(
            arguments["room_ids"],
            time_min=arguments["time_min"],
            time_max=arguments["time_max"],
        )
        return ToolResult(ToolOutcome.COMPLETED, content=freebusy)

    return Tool(
        name=name,
        description=description,
        input_schema=input_schema,
        handler=handler,
        auth_scopes=tuple(auth_scopes),
    )

book_meeting_room

Python
book_meeting_room(*, description: str, name: str = 'book_meeting_room', timezone: str = 'Asia/Shanghai', requires_approval: bool = True, as_user: bool = True, auth_scopes: Sequence[str] = ()) -> Tool

写类工厂：预订会议室，返回一个需审批的 feishu.agent.tools.Tool。

飞书没有独立的“订会议室”接口：预订会议室通过创建一条日程、再把会议室作为 type=resource 的日程参与人加入完成。requires_approval=True 时，feishu.agent.loop.AgentEngine 先挂起并发审批卡片；用户批准后处理函数才执行写入。

参数：

名称 类型 描述 默认

description

str

工具描述（产品本地化文案）。

 必需

name

str

工具名。默认为 "book_meeting_room"。

 'book_meeting_room'

timezone

str

ISO 时间换算所用时区。默认为 "Asia/Shanghai"。

 'Asia/Shanghai'

requires_approval

bool

执行前是否要求用户审批。默认为 True。

 True

as_user

bool

是否以请求用户身份写入。默认为 True。

 True

auth_scopes

Sequence[str]

缺少授权时申请的飞书权限范围。

 ()

返回：

类型 描述
Tool

可注册到 feishu.agent.tools.ToolRegistry 的 feishu.agent.tools.Tool。

示例：

Python Console Session
1
2
3
>>> tool = book_meeting_room(description="x")
>>> tool.name, tool.requires_approval
('book_meeting_room', True)
源代码位于： feishu/agent/toolkit/rooms.py
Python
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
def book_meeting_room(
    *,
    description: str,
    name: str = "book_meeting_room",
    timezone: str = "Asia/Shanghai",
    requires_approval: bool = True,
    as_user: bool = True,
    auth_scopes: Sequence[str] = (),
) -> Tool:
    r"""
    写类工厂：预订会议室，返回一个需审批的 [feishu.agent.tools.Tool][]。

    飞书没有独立的“订会议室”接口：预订会议室通过创建一条日程、再把会议室作为
    `type=resource` 的日程参与人加入完成。`requires_approval=True`
    时，[feishu.agent.loop.AgentEngine][] 先挂起并发审批卡片；用户批准后处理函数才执行写入。

    Args:
        description: 工具描述（产品本地化文案）。
        name: 工具名。默认为 `"book_meeting_room"`。
        timezone: ISO 时间换算所用时区。默认为 `"Asia/Shanghai"`。
        requires_approval: 执行前是否要求用户审批。默认为 `True`。
        as_user: 是否以请求用户身份写入。默认为 `True`。
        auth_scopes: 缺少授权时申请的飞书权限范围。

    Returns:
        可注册到 [feishu.agent.tools.ToolRegistry][] 的 [feishu.agent.tools.Tool][]。

    Examples:
        >>> tool = book_meeting_room(description="x")
        >>> tool.name, tool.requires_approval
        ('book_meeting_room', True)
    """
    input_schema: dict[str, Any] = {
        "type": "object",
        "properties": {
            "summary": {"type": "string", "description": "Meeting title"},
            "start_time": {"type": "string", "description": "ISO 8601 start"},
            "end_time": {"type": "string", "description": "ISO 8601 end"},
            "room_id": {"type": "string", "description": "Meeting room ID to reserve"},
            "description": {"type": "string", "description": "Meeting description"},
            "location": {"type": "string", "description": "Meeting location name"},
        },
        "required": ["summary", "start_time", "end_time", "room_id"],
        "additionalProperties": False,
    }

    async def handler(**arguments: Any) -> ToolResult:
        # Runs only AFTER the user approves the confirmation card; perform the write directly.
        client = await resolve_client(as_user=as_user)
        if client is None:
            return needs_user_auth(auth_scopes)
        tz = await resolve_timezone(timezone)
        calendar_id = await _primary_calendar_id(client)
        event_payload = calendar_event(
            summary=arguments["summary"],
            start_time=arguments["start_time"],
            end_time=arguments["end_time"],
            timezone=tz,
            description=arguments.get("description"),
            location=arguments.get("location"),
        )
        result = await client.calendar.events.create(calendar_id, event_payload)
        event = result.get("event") or {}
        event_id = event.get("event_id")
        if event_id:
            result.attendees_response = await client.calendar.attendees.add(
                calendar_id,
                str(event_id),
                [{"type": "resource", "room_id": arguments["room_id"]}],
                need_notification=True,
            )
        return ToolResult(ToolOutcome.COMPLETED, content=result)

    return Tool(
        name=name,
        description=description,
        input_schema=input_schema,
        handler=handler,
        requires_approval=requires_approval,
        auth_scopes=tuple(auth_scopes),
    )