跳转至

reserves

feishu.vc.reserves

ReservesNamespace

Bases: Namespace

会议预约（Reserve）接口命名空间。

通过 client.vc.reserves 访问，封装飞书视频会议中预约（reserve）相关的服务端接口：预约会议、 查询、更新与删除预约。预约成功后返回会议号与多种入会链接。

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

飞书文档

预约会议

源代码位于： feishu/vc/reserves.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
 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
class ReservesNamespace(Namespace):
    r"""
    会议预约（Reserve）接口命名空间。

    通过 `client.vc.reserves` 访问，封装飞书视频会议中预约（reserve）相关的服务端接口：预约会议、
    查询、更新与删除预约。预约成功后返回会议号与多种入会链接。

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

    飞书文档:
        [预约会议](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply)
    """

    async def apply(
        self,
        meeting_settings: dict[str, Any],
        *,
        end_time: str | None = None,
        owner_id: str | None = None,
        user_id_type: str | None = None,
    ) -> NestedDict:
        r"""
        预约会议。

        仅将显式传入的字段写入请求体，未设置的字段会被省略；未指定 `owner_id` 时，预约人默认为当前调用者。

        Args:
            meeting_settings: 会议设置，原样作为 JSON 发送，常见键包括 `topic`（会议主题）、
                `auto_record`、`call_setting`、`assign_host_list`、`password` 等。
            end_time: 预约到期时间（Unix 秒，字符串）；到期后预约自动失效，为空时使用接口默认时长。
            owner_id: 预约人 ID，其类型由 `user_id_type` 指定；为空时默认为当前调用者。
            user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

        Returns:
            预约结果数据，含 `reserve` 字段，内含 `id`（预约 ID）、`meeting_no`（会议号）、`url`（入会链接）、
            `app_link`（客户端入会链接）、`live_link`（直播链接）、`end_time` 等信息。

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

        飞书文档:
            [预约会议](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply)

        Examples:
            >>> await client.vc.reserves.apply({"topic": "周会"}, end_time="1700000000")  # doctest:+SKIP
            {'reserve': {'id': '765...', 'meeting_no': '121...', 'url': 'https://vc.feishu.cn/j/121...'}}
        """
        body: dict[str, Any] = {"meeting_settings": meeting_settings}
        if end_time is not None:
            body["end_time"] = end_time
        if owner_id is not None:
            body["owner_id"] = owner_id
        params: dict[str, Any] = {}
        if user_id_type is not None:
            params["user_id_type"] = user_id_type
        return await self._request_data("POST", "vc/v1/reserves/apply", params=params, json=body)

    async def delete(self, reserve_id: str) -> NestedDict:
        r"""
        删除会议预约。

        Args:
            reserve_id: 预约 ID（[`apply`][feishu.vc.reserves.ReservesNamespace.apply] 返回的 `reserve.id`）。

        Returns:
            空数据体（接口成功时不返回额外字段）。

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

        飞书文档:
            [删除预约](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/delete)

        Examples:
            >>> await client.vc.reserves.delete("765...")  # doctest:+SKIP
            {}
        """
        return await self._request_data("DELETE", f"vc/v1/reserves/{quote_segment(reserve_id)}")

    async def get(self, reserve_id: str, *, user_id_type: str | None = None) -> NestedDict:
        r"""
        查询会议预约。

        Args:
            reserve_id: 预约 ID（[`apply`][feishu.vc.reserves.ReservesNamespace.apply] 返回的 `reserve.id`）。
            user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

        Returns:
            预约数据，含 `reserve` 字段，内含 `id`、`meeting_no`、`url`、`live_link`、`end_time`、
            `expire_status`（到期状态：1 未到期、2 已到期）等信息。

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

        飞书文档:
            [获取预约](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get)

        Examples:
            >>> await client.vc.reserves.get("765...")  # doctest:+SKIP
            {'reserve': {'id': '765...', 'meeting_no': '121...', 'expire_status': 1}}
        """
        params: dict[str, Any] = {}
        if user_id_type is not None:
            params["user_id_type"] = user_id_type
        return await self._request_data("GET", f"vc/v1/reserves/{quote_segment(reserve_id)}", params=params)

    async def update(
        self,
        reserve_id: str,
        *,
        end_time: str | None = None,
        meeting_settings: dict[str, Any] | None = None,
        user_id_type: str | None = None,
    ) -> NestedDict:
        r"""
        更新会议预约。

        仅将显式传入的字段写入请求体，未设置的字段会被省略。

        Args:
            reserve_id: 预约 ID（[`apply`][feishu.vc.reserves.ReservesNamespace.apply] 返回的 `reserve.id`）。
            end_time: 新的预约到期时间（Unix 秒，字符串）。
            meeting_settings: 新的会议设置，原样作为 JSON 发送，键同 `apply`。
            user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

        Returns:
            更新后的预约数据，含 `reserve` 字段（结构同 [`get`][feishu.vc.reserves.ReservesNamespace.get]）。

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

        飞书文档:
            [更新预约](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/update)

        Examples:
            >>> await client.vc.reserves.update("765...", end_time="1700003600")  # doctest:+SKIP
            {'reserve': {'id': '765...', 'end_time': '1700003600'}}
        """
        body: dict[str, Any] = {}
        if end_time is not None:
            body["end_time"] = end_time
        if meeting_settings is not None:
            body["meeting_settings"] = meeting_settings
        params: dict[str, Any] = {}
        if user_id_type is not None:
            params["user_id_type"] = user_id_type
        return await self._request_data("PUT", f"vc/v1/reserves/{quote_segment(reserve_id)}", params=params, json=body)

apply async

Python
apply(meeting_settings: dict[str, Any], *, end_time: str | None = None, owner_id: str | None = None, user_id_type: str | None = None) -> NestedDict

预约会议。

仅将显式传入的字段写入请求体，未设置的字段会被省略；未指定 owner_id 时，预约人默认为当前调用者。

参数：

名称 类型 描述 默认
meeting_settings
dict[str, Any]

会议设置，原样作为 JSON 发送，常见键包括 topic（会议主题）、 auto_record、call_setting、assign_host_list、password 等。

 必需
end_time
str | None

预约到期时间（Unix 秒，字符串）；到期后预约自动失效，为空时使用接口默认时长。

 None
owner_id
str | None

预约人 ID，其类型由 user_id_type 指定；为空时默认为当前调用者。

 None
user_id_type
str | None

用户 ID 的类型，如 open_id、union_id、user_id；为空时使用接口默认值。

 None

返回：

类型 描述
NestedDict

预约结果数据，含 reserve 字段，内含 id（预约 ID）、meeting_no（会议号）、url（入会链接）、
NestedDict

app_link（客户端入会链接）、live_link（直播链接）、end_time 等信息。

引发：

类型 描述
FeishuError

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

预约会议

示例：

Python Console Session
1
2
>>> await client.vc.reserves.apply({"topic": "周会"}, end_time="1700000000")
{'reserve': {'id': '765...', 'meeting_no': '121...', 'url': 'https://vc.feishu.cn/j/121...'}}
源代码位于： feishu/vc/reserves.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
75
76
77
78
79
80
81
82
83
84
85
86
87
async def apply(
    self,
    meeting_settings: dict[str, Any],
    *,
    end_time: str | None = None,
    owner_id: str | None = None,
    user_id_type: str | None = None,
) -> NestedDict:
    r"""
    预约会议。

    仅将显式传入的字段写入请求体，未设置的字段会被省略；未指定 `owner_id` 时，预约人默认为当前调用者。

    Args:
        meeting_settings: 会议设置，原样作为 JSON 发送，常见键包括 `topic`（会议主题）、
            `auto_record`、`call_setting`、`assign_host_list`、`password` 等。
        end_time: 预约到期时间（Unix 秒，字符串）；到期后预约自动失效，为空时使用接口默认时长。
        owner_id: 预约人 ID，其类型由 `user_id_type` 指定；为空时默认为当前调用者。
        user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

    Returns:
        预约结果数据，含 `reserve` 字段，内含 `id`（预约 ID）、`meeting_no`（会议号）、`url`（入会链接）、
        `app_link`（客户端入会链接）、`live_link`（直播链接）、`end_time` 等信息。

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

    飞书文档:
        [预约会议](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply)

    Examples:
        >>> await client.vc.reserves.apply({"topic": "周会"}, end_time="1700000000")  # doctest:+SKIP
        {'reserve': {'id': '765...', 'meeting_no': '121...', 'url': 'https://vc.feishu.cn/j/121...'}}
    """
    body: dict[str, Any] = {"meeting_settings": meeting_settings}
    if end_time is not None:
        body["end_time"] = end_time
    if owner_id is not None:
        body["owner_id"] = owner_id
    params: dict[str, Any] = {}
    if user_id_type is not None:
        params["user_id_type"] = user_id_type
    return await self._request_data("POST", "vc/v1/reserves/apply", params=params, json=body)

delete async

Python
delete(reserve_id: str) -> NestedDict

删除会议预约。

参数：

名称 类型 描述 默认
reserve_id
str

预约 ID（apply 返回的 reserve.id）。

 必需

返回：

类型 描述
NestedDict

空数据体（接口成功时不返回额外字段）。

引发：

类型 描述
FeishuError

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

删除预约

示例：

Python Console Session
1
2
>>> await client.vc.reserves.delete("765...")
{}
源代码位于： feishu/vc/reserves.py
Python
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
async def delete(self, reserve_id: str) -> NestedDict:
    r"""
    删除会议预约。

    Args:
        reserve_id: 预约 ID（[`apply`][feishu.vc.reserves.ReservesNamespace.apply] 返回的 `reserve.id`）。

    Returns:
        空数据体（接口成功时不返回额外字段）。

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

    飞书文档:
        [删除预约](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/delete)

    Examples:
        >>> await client.vc.reserves.delete("765...")  # doctest:+SKIP
        {}
    """
    return await self._request_data("DELETE", f"vc/v1/reserves/{quote_segment(reserve_id)}")

get async

Python
get(reserve_id: str, *, user_id_type: str | None = None) -> NestedDict

查询会议预约。

参数：

名称 类型 描述 默认
reserve_id
str

预约 ID（apply 返回的 reserve.id）。

 必需
user_id_type
str | None

用户 ID 的类型，如 open_id、union_id、user_id；为空时使用接口默认值。

 None

返回：

类型 描述
NestedDict

预约数据，含 reserve 字段，内含 id、meeting_no、url、live_link、end_time、
NestedDict

expire_status（到期状态：1 未到期、2 已到期）等信息。

引发：

类型 描述
FeishuError

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

获取预约

示例：

Python Console Session
1
2
>>> await client.vc.reserves.get("765...")
{'reserve': {'id': '765...', 'meeting_no': '121...', 'expire_status': 1}}
源代码位于： feishu/vc/reserves.py
Python
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
async def get(self, reserve_id: str, *, user_id_type: str | None = None) -> NestedDict:
    r"""
    查询会议预约。

    Args:
        reserve_id: 预约 ID（[`apply`][feishu.vc.reserves.ReservesNamespace.apply] 返回的 `reserve.id`）。
        user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

    Returns:
        预约数据，含 `reserve` 字段，内含 `id`、`meeting_no`、`url`、`live_link`、`end_time`、
        `expire_status`（到期状态：1 未到期、2 已到期）等信息。

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

    飞书文档:
        [获取预约](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get)

    Examples:
        >>> await client.vc.reserves.get("765...")  # doctest:+SKIP
        {'reserve': {'id': '765...', 'meeting_no': '121...', 'expire_status': 1}}
    """
    params: dict[str, Any] = {}
    if user_id_type is not None:
        params["user_id_type"] = user_id_type
    return await self._request_data("GET", f"vc/v1/reserves/{quote_segment(reserve_id)}", params=params)

update async

Python
update(reserve_id: str, *, end_time: str | None = None, meeting_settings: dict[str, Any] | None = None, user_id_type: str | None = None) -> NestedDict

更新会议预约。

仅将显式传入的字段写入请求体，未设置的字段会被省略。

参数：

名称 类型 描述 默认
reserve_id
str

预约 ID（apply 返回的 reserve.id）。

 必需
end_time
str | None

新的预约到期时间（Unix 秒，字符串）。

 None
meeting_settings
dict[str, Any] | None

新的会议设置，原样作为 JSON 发送，键同 apply。

 None
user_id_type
str | None

用户 ID 的类型，如 open_id、union_id、user_id；为空时使用接口默认值。

 None

返回：

类型 描述
NestedDict

更新后的预约数据，含 reserve 字段（结构同 get）。

引发：

类型 描述
FeishuError

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

更新预约

示例：

Python Console Session
1
2
>>> await client.vc.reserves.update("765...", end_time="1700003600")
{'reserve': {'id': '765...', 'end_time': '1700003600'}}
源代码位于： feishu/vc/reserves.py
Python
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
async def update(
    self,
    reserve_id: str,
    *,
    end_time: str | None = None,
    meeting_settings: dict[str, Any] | None = None,
    user_id_type: str | None = None,
) -> NestedDict:
    r"""
    更新会议预约。

    仅将显式传入的字段写入请求体，未设置的字段会被省略。

    Args:
        reserve_id: 预约 ID（[`apply`][feishu.vc.reserves.ReservesNamespace.apply] 返回的 `reserve.id`）。
        end_time: 新的预约到期时间（Unix 秒，字符串）。
        meeting_settings: 新的会议设置，原样作为 JSON 发送，键同 `apply`。
        user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

    Returns:
        更新后的预约数据，含 `reserve` 字段（结构同 [`get`][feishu.vc.reserves.ReservesNamespace.get]）。

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

    飞书文档:
        [更新预约](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/update)

    Examples:
        >>> await client.vc.reserves.update("765...", end_time="1700003600")  # doctest:+SKIP
        {'reserve': {'id': '765...', 'end_time': '1700003600'}}
    """
    body: dict[str, Any] = {}
    if end_time is not None:
        body["end_time"] = end_time
    if meeting_settings is not None:
        body["meeting_settings"] = meeting_settings
    params: dict[str, Any] = {}
    if user_id_type is not None:
        params["user_id_type"] = user_id_type
    return await self._request_data("PUT", f"vc/v1/reserves/{quote_segment(reserve_id)}", params=params, json=body)