跳转至

meetings

feishu.vc.meetings

MeetingsNamespace

Bases: Namespace

会议（Meeting）接口命名空间。

通过 client.vc.meetings 访问，封装飞书视频会议中会议（meeting）相关的只读查询接口：获取单场会议详情、 按会议号列举一段时间内的历史会议。会议在被发起后才会产生，与预约（reserve）是不同的对象。

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

飞书文档

获取会议详情

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

    通过 `client.vc.meetings` 访问，封装飞书视频会议中会议（meeting）相关的只读查询接口：获取单场会议详情、
    按会议号列举一段时间内的历史会议。会议在被发起后才会产生，与预约（reserve）是不同的对象。

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

    飞书文档:
        [获取会议详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get)
    """

    async def get(
        self,
        meeting_id: str,
        *,
        with_participants: bool | None = None,
        with_meeting_ability: bool | None = None,
        user_id_type: str | None = None,
    ) -> NestedDict:
        r"""
        获取会议详情。

        Args:
            meeting_id: 会议 ID（9 位会议号对应的内部 ID，可由
                [`list_by_no`][feishu.vc.meetings.MeetingsNamespace.list_by_no] 获取）。
            with_participants: 是否返回参会人列表；为空时使用接口默认值（不返回）。
            with_meeting_ability: 是否返回会议能力用量统计；为空时使用接口默认值（不返回）。
            user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

        Returns:
            会议数据，含 `meeting` 字段，内含 `id`、`topic`、`url`、`meeting_no`、`start_time`、`end_time`、
            `host_user`、`status`（1 呼叫中、2 进行中、3 已结束）、`participant_count` 等信息；
            当 `with_participants` 为真时还含 `participants` 列表。

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

        飞书文档:
            [获取会议详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get)

        Examples:
            >>> await client.vc.meetings.get("700...", with_participants=True)  # doctest:+SKIP
            {'meeting': {'id': '700...', 'topic': '周会', 'status': 3, 'participant_count': '5'}}
        """
        params: dict[str, Any] = {}
        if with_participants is not None:
            params["with_participants"] = with_participants
        if with_meeting_ability is not None:
            params["with_meeting_ability"] = with_meeting_ability
        if user_id_type is not None:
            params["user_id_type"] = user_id_type
        return await self._request_data("GET", f"vc/v1/meetings/{quote_segment(meeting_id)}", params=params)

    async def list_by_no(
        self,
        meeting_no: str,
        start_time: str,
        end_time: str,
        *,
        page_size: int | None = None,
        max_items: int | None = None,
    ) -> list[NestedDict]:
        r"""
        按会议号列举历史会议。

        同一会议号在不同时间会对应多场会议，本接口返回 `[start_time, end_time]` 时间窗内、该会议号下的
        历次会议，并自动翻页汇总为列表。

        Args:
            meeting_no: 9 位会议号。
            start_time: 查询起始时间（Unix 秒，字符串）。
            end_time: 查询结束时间（Unix 秒，字符串）。
            page_size: 每页条数；为空时使用接口默认值，超出上限时由客户端截断。
            max_items: 最多返回的会议数；为空表示返回全部。

        Returns:
            会议简要信息列表，每项含 `id`、`meeting_no`、`topic`、`url`、`note_id` 等字段；
            该时间窗内无会议时返回空列表。

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

        飞书文档:
            [获取与会议号关联的会议列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no)

        Examples:
            >>> await client.vc.meetings.list_by_no("123456789", "1699999000", "1700002600")  # doctest:+SKIP
            [{'id': '700...', 'meeting_no': '123456789', 'topic': '周会'}]
        """
        return await self._client.paginate_get(
            "vc/v1/meetings/list_by_no",
            params={"meeting_no": meeting_no, "start_time": start_time, "end_time": end_time},
            page_size=page_size,
            max_items=max_items,
            items_key="meeting_briefs",
        )

get async

Python
get(meeting_id: str, *, with_participants: bool | None = None, with_meeting_ability: bool | None = None, user_id_type: str | None = None) -> NestedDict

获取会议详情。

参数：

名称 类型 描述 默认
meeting_id
str

会议 ID（9 位会议号对应的内部 ID，可由 list_by_no 获取）。

 必需
with_participants
bool | None

是否返回参会人列表；为空时使用接口默认值（不返回）。

 None
with_meeting_ability
bool | None

是否返回会议能力用量统计；为空时使用接口默认值（不返回）。

 None
user_id_type
str | None

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

 None

返回：

类型 描述
NestedDict

会议数据，含 meeting 字段，内含 id、topic、url、meeting_no、start_time、end_time、
NestedDict

host_user、status（1 呼叫中、2 进行中、3 已结束）、participant_count 等信息；
NestedDict

当 with_participants 为真时还含 participants 列表。

引发：

类型 描述
FeishuError

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

获取会议详情

示例：

Python Console Session
1
2
>>> await client.vc.meetings.get("700...", with_participants=True)
{'meeting': {'id': '700...', 'topic': '周会', 'status': 3, 'participant_count': '5'}}
源代码位于： feishu/vc/meetings.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
async def get(
    self,
    meeting_id: str,
    *,
    with_participants: bool | None = None,
    with_meeting_ability: bool | None = None,
    user_id_type: str | None = None,
) -> NestedDict:
    r"""
    获取会议详情。

    Args:
        meeting_id: 会议 ID（9 位会议号对应的内部 ID，可由
            [`list_by_no`][feishu.vc.meetings.MeetingsNamespace.list_by_no] 获取）。
        with_participants: 是否返回参会人列表；为空时使用接口默认值（不返回）。
        with_meeting_ability: 是否返回会议能力用量统计；为空时使用接口默认值（不返回）。
        user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

    Returns:
        会议数据，含 `meeting` 字段，内含 `id`、`topic`、`url`、`meeting_no`、`start_time`、`end_time`、
        `host_user`、`status`（1 呼叫中、2 进行中、3 已结束）、`participant_count` 等信息；
        当 `with_participants` 为真时还含 `participants` 列表。

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

    飞书文档:
        [获取会议详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get)

    Examples:
        >>> await client.vc.meetings.get("700...", with_participants=True)  # doctest:+SKIP
        {'meeting': {'id': '700...', 'topic': '周会', 'status': 3, 'participant_count': '5'}}
    """
    params: dict[str, Any] = {}
    if with_participants is not None:
        params["with_participants"] = with_participants
    if with_meeting_ability is not None:
        params["with_meeting_ability"] = with_meeting_ability
    if user_id_type is not None:
        params["user_id_type"] = user_id_type
    return await self._request_data("GET", f"vc/v1/meetings/{quote_segment(meeting_id)}", params=params)

list_by_no async

Python
list_by_no(meeting_no: str, start_time: str, end_time: str, *, page_size: int | None = None, max_items: int | None = None) -> list[NestedDict]

按会议号列举历史会议。

同一会议号在不同时间会对应多场会议，本接口返回 [start_time, end_time] 时间窗内、该会议号下的 历次会议，并自动翻页汇总为列表。

参数：

名称 类型 描述 默认
meeting_no
str

9 位会议号。

 必需
start_time
str

查询起始时间（Unix 秒，字符串）。

 必需
end_time
str

查询结束时间（Unix 秒，字符串）。

 必需
page_size
int | None

每页条数；为空时使用接口默认值，超出上限时由客户端截断。

 None
max_items
int | None

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

 None

返回：

类型 描述
list[NestedDict]

会议简要信息列表，每项含 id、meeting_no、topic、url、note_id 等字段；
list[NestedDict]

该时间窗内无会议时返回空列表。

引发：

类型 描述
FeishuError

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

获取与会议号关联的会议列表

示例：

Python Console Session
1
2
>>> await client.vc.meetings.list_by_no("123456789", "1699999000", "1700002600")
[{'id': '700...', 'meeting_no': '123456789', 'topic': '周会'}]
源代码位于： feishu/vc/meetings.py
Python
 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
async def list_by_no(
    self,
    meeting_no: str,
    start_time: str,
    end_time: str,
    *,
    page_size: int | None = None,
    max_items: int | None = None,
) -> list[NestedDict]:
    r"""
    按会议号列举历史会议。

    同一会议号在不同时间会对应多场会议，本接口返回 `[start_time, end_time]` 时间窗内、该会议号下的
    历次会议，并自动翻页汇总为列表。

    Args:
        meeting_no: 9 位会议号。
        start_time: 查询起始时间（Unix 秒，字符串）。
        end_time: 查询结束时间（Unix 秒，字符串）。
        page_size: 每页条数；为空时使用接口默认值，超出上限时由客户端截断。
        max_items: 最多返回的会议数；为空表示返回全部。

    Returns:
        会议简要信息列表，每项含 `id`、`meeting_no`、`topic`、`url`、`note_id` 等字段；
        该时间窗内无会议时返回空列表。

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

    飞书文档:
        [获取与会议号关联的会议列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no)

    Examples:
        >>> await client.vc.meetings.list_by_no("123456789", "1699999000", "1700002600")  # doctest:+SKIP
        [{'id': '700...', 'meeting_no': '123456789', 'topic': '周会'}]
    """
    return await self._client.paginate_get(
        "vc/v1/meetings/list_by_no",
        params={"meeting_no": meeting_no, "start_time": start_time, "end_time": end_time},
        page_size=page_size,
        max_items=max_items,
        items_key="meeting_briefs",
    )