跳转至

reactions

feishu.im.reactions

ReactionsNamespace

Bases: Namespace

消息表情回复（Reaction）接口命名空间。

通过 client.im.reactions 访问，封装飞书消息表情回复相关的服务端接口：为消息添加表情回复、 删除某条表情回复、以及列举一条消息上的表情回复。表情以 emoji_type（如 SMILE、THUMBSUP）标识。

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

飞书文档

表情回复概述

源代码位于： feishu/im/reactions.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
class ReactionsNamespace(Namespace):
    r"""
    消息表情回复（Reaction）接口命名空间。

    通过 `client.im.reactions` 访问，封装飞书消息表情回复相关的服务端接口：为消息添加表情回复、
    删除某条表情回复、以及列举一条消息上的表情回复。表情以 `emoji_type`（如 `SMILE`、`THUMBSUP`）标识。

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

    飞书文档:
        [表情回复概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create)
    """

    async def create(self, message_id: str, emoji_type: str) -> NestedDict:
        r"""
        为一条消息添加表情回复。

        Args:
            message_id: 目标消息 ID（`om_` 开头）。
            emoji_type: 表情类型枚举值，如 `SMILE`、`THUMBSUP`、`OK` 等。

        Returns:
            添加结果数据，含 `reaction_id`、`operator`（操作者）、`action_time`、`reaction_type`
            （内含 `emoji_type`）等字段。

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

        飞书文档:
            [添加消息表情回复](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create)

        Examples:
            >>> await client.im.reactions.create("om_xxx", "THUMBSUP")  # doctest:+SKIP
            {'reaction_id': 'ZCaCIjUBVVdg...', 'reaction_type': {'emoji_type': 'THUMBSUP'}}
        """
        body = {"reaction_type": {"emoji_type": emoji_type}}
        return await self._request_data("POST", f"im/v1/messages/{quote_segment(message_id)}/reactions", json=body)

    async def delete(self, message_id: str, reaction_id: str) -> NestedDict:
        r"""
        删除一条消息表情回复。

        Args:
            message_id: 目标消息 ID。
            reaction_id: 待删除的表情回复 ID（添加表情回复时返回的 `reaction_id`）。

        Returns:
            被删除的表情回复数据，结构同添加时的返回。

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

        飞书文档:
            [删除消息表情回复](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete)

        Examples:
            >>> await client.im.reactions.delete("om_xxx", "ZCaCIjUBVVdg...")  # doctest:+SKIP
            {'reaction_id': 'ZCaCIjUBVVdg...', 'reaction_type': {'emoji_type': 'THUMBSUP'}}
        """
        return await self._request_data(
            "DELETE", f"im/v1/messages/{quote_segment(message_id)}/reactions/{quote_segment(reaction_id)}"
        )

    async def list(
        self,
        message_id: str,
        *,
        emoji_type: str | None = None,
        page_size: int = 50,
        max_items: int | None = None,
    ) -> builtins.list[NestedDict]:
        r"""
        列举一条消息上的表情回复。

        自动翻页并汇总目标消息的表情回复，可选按 `emoji_type` 过滤。

        Args:
            message_id: 目标消息 ID。
            emoji_type: 仅返回该表情类型的回复（对应查询参数 `reaction_type`）；为空时返回全部类型。
            page_size: 每页数量。默认为 50；超过 [feishu.consts.MAX_PAGE_SIZE][] 时由客户端收敛。
            max_items: 最多返回的表情回复数量，`None` 表示不限制。默认为 `None`。

        Returns:
            表情回复对象列表（`data.items`），每项含 `reaction_id`、`operator`、`action_time`、
            `reaction_type` 等字段；无表情回复时返回空列表。

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

        飞书文档:
            [获取消息表情回复](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list)

        Examples:
            >>> await client.im.reactions.list("om_xxx", emoji_type="THUMBSUP")  # doctest:+SKIP
            [{'reaction_id': 'ZCaCIjUBVVdg...', 'operator': {'operator_id': 'ou_xxx'}}]
        """
        params: dict[str, Any] = {}
        if emoji_type is not None:
            params["reaction_type"] = emoji_type
        return await self._client.paginate_get(
            f"im/v1/messages/{quote_segment(message_id)}/reactions",
            params=params,
            page_size=page_size,
            max_items=max_items,
        )

create async

Python
create(message_id: str, emoji_type: str) -> NestedDict

为一条消息添加表情回复。

参数：

名称 类型 描述 默认
message_id
str

目标消息 ID（om_ 开头）。

 必需
emoji_type
str

表情类型枚举值，如 SMILE、THUMBSUP、OK 等。

 必需

返回：

类型 描述
NestedDict

添加结果数据，含 reaction_id、operator（操作者）、action_time、reaction_type
NestedDict

（内含 emoji_type）等字段。

引发：

类型 描述
FeishuError

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

添加消息表情回复

示例：

Python Console Session
1
2
>>> await client.im.reactions.create("om_xxx", "THUMBSUP")
{'reaction_id': 'ZCaCIjUBVVdg...', 'reaction_type': {'emoji_type': 'THUMBSUP'}}
源代码位于： feishu/im/reactions.py
Python
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
async def create(self, message_id: str, emoji_type: str) -> NestedDict:
    r"""
    为一条消息添加表情回复。

    Args:
        message_id: 目标消息 ID（`om_` 开头）。
        emoji_type: 表情类型枚举值，如 `SMILE`、`THUMBSUP`、`OK` 等。

    Returns:
        添加结果数据，含 `reaction_id`、`operator`（操作者）、`action_time`、`reaction_type`
        （内含 `emoji_type`）等字段。

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

    飞书文档:
        [添加消息表情回复](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/create)

    Examples:
        >>> await client.im.reactions.create("om_xxx", "THUMBSUP")  # doctest:+SKIP
        {'reaction_id': 'ZCaCIjUBVVdg...', 'reaction_type': {'emoji_type': 'THUMBSUP'}}
    """
    body = {"reaction_type": {"emoji_type": emoji_type}}
    return await self._request_data("POST", f"im/v1/messages/{quote_segment(message_id)}/reactions", json=body)

delete async

Python
delete(message_id: str, reaction_id: str) -> NestedDict

删除一条消息表情回复。

参数：

名称 类型 描述 默认
message_id
str

目标消息 ID。

 必需
reaction_id
str

待删除的表情回复 ID（添加表情回复时返回的 reaction_id）。

 必需

返回：

类型 描述
NestedDict

被删除的表情回复数据，结构同添加时的返回。

引发：

类型 描述
FeishuError

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

删除消息表情回复

示例：

Python Console Session
1
2
>>> await client.im.reactions.delete("om_xxx", "ZCaCIjUBVVdg...")
{'reaction_id': 'ZCaCIjUBVVdg...', 'reaction_type': {'emoji_type': 'THUMBSUP'}}
源代码位于： feishu/im/reactions.py
Python
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
async def delete(self, message_id: str, reaction_id: str) -> NestedDict:
    r"""
    删除一条消息表情回复。

    Args:
        message_id: 目标消息 ID。
        reaction_id: 待删除的表情回复 ID（添加表情回复时返回的 `reaction_id`）。

    Returns:
        被删除的表情回复数据，结构同添加时的返回。

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

    飞书文档:
        [删除消息表情回复](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/delete)

    Examples:
        >>> await client.im.reactions.delete("om_xxx", "ZCaCIjUBVVdg...")  # doctest:+SKIP
        {'reaction_id': 'ZCaCIjUBVVdg...', 'reaction_type': {'emoji_type': 'THUMBSUP'}}
    """
    return await self._request_data(
        "DELETE", f"im/v1/messages/{quote_segment(message_id)}/reactions/{quote_segment(reaction_id)}"
    )

list async

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

列举一条消息上的表情回复。

自动翻页并汇总目标消息的表情回复，可选按 emoji_type 过滤。

参数：

名称 类型 描述 默认
message_id
str

目标消息 ID。

 必需
emoji_type
str | None

仅返回该表情类型的回复（对应查询参数 reaction_type）；为空时返回全部类型。

 None
page_size
int

每页数量。默认为 50；超过 [feishu.consts.MAX_PAGE_SIZE][] 时由客户端收敛。

 50
max_items
int | None

最多返回的表情回复数量，None 表示不限制。默认为 None。

 None

返回：

类型 描述
list[NestedDict]

表情回复对象列表（data.items），每项含 reaction_id、operator、action_time、
list[NestedDict]

reaction_type 等字段；无表情回复时返回空列表。

引发：

类型 描述
FeishuError

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

获取消息表情回复

示例：

Python Console Session
1
2
>>> await client.im.reactions.list("om_xxx", emoji_type="THUMBSUP")
[{'reaction_id': 'ZCaCIjUBVVdg...', 'operator': {'operator_id': 'ou_xxx'}}]
源代码位于： feishu/im/reactions.py
Python
 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
async def list(
    self,
    message_id: str,
    *,
    emoji_type: str | None = None,
    page_size: int = 50,
    max_items: int | None = None,
) -> builtins.list[NestedDict]:
    r"""
    列举一条消息上的表情回复。

    自动翻页并汇总目标消息的表情回复，可选按 `emoji_type` 过滤。

    Args:
        message_id: 目标消息 ID。
        emoji_type: 仅返回该表情类型的回复（对应查询参数 `reaction_type`）；为空时返回全部类型。
        page_size: 每页数量。默认为 50；超过 [feishu.consts.MAX_PAGE_SIZE][] 时由客户端收敛。
        max_items: 最多返回的表情回复数量，`None` 表示不限制。默认为 `None`。

    Returns:
        表情回复对象列表（`data.items`），每项含 `reaction_id`、`operator`、`action_time`、
        `reaction_type` 等字段；无表情回复时返回空列表。

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

    飞书文档:
        [获取消息表情回复](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/list)

    Examples:
        >>> await client.im.reactions.list("om_xxx", emoji_type="THUMBSUP")  # doctest:+SKIP
        [{'reaction_id': 'ZCaCIjUBVVdg...', 'operator': {'operator_id': 'ou_xxx'}}]
    """
    params: dict[str, Any] = {}
    if emoji_type is not None:
        params["reaction_type"] = emoji_type
    return await self._client.paginate_get(
        f"im/v1/messages/{quote_segment(message_id)}/reactions",
        params=params,
        page_size=page_size,
        max_items=max_items,
    )