Skip to content

消息管理概述

消息即飞书聊天中的一条消息。你可以使用消息管理 API 对消息进行发送、回复、编辑、撤回、转发以及查询等操作。在使用消息管理 API 前,你能通过本文了解消息管理 API 相关的字段说明。

字段说明

名称类型描述
message_idstring在单个租户内,系统会对每一条发送出的消息自动生成一个唯一 ID,该 ID 即为 message_idmessage_id 格式是以 om_ 为前缀的字符串,例如:om_934be5776f5a87239a298af9e74c0f72message_id 获取方式: - 调用发送消息接口后,从响应结果的 message_id 参数获取。 - 监听接收消息事件,当触发该事件后可以从事件体内获取消息的 message_id。 - 调用获取会话历史消息接口,从响应结果的 message_id 参数获取。
root_id 与 parent_idstring一条消息可能被回复多次,在这种有多个回复消息的消息树中,root_id 为根消息的 message_idparent_id 为被回复的上一层消息的 message_id。以下图的消息回复举例: Group 1321314312.png - msg2 回复了 msg1,则 msg2 的 root_idparent_id 均为 msg1 的 message_id; - msg3 回复了msg2,则 msg3 的 root_id 是 msg1 的 message_idparent_id 是 msg2 的message_id > Tip: 注意:在话题内回复的消息,都是在回复根消息,所以 root_idparent_id 均是指根消息的 message_id
msg_typestring消息类型。包括: - text:文本 - post:富文本 - image:图片 - file:文件 - audio:语音 - media:视频 - sticker:表情包 - interactive:消息卡片 - share_chat:分享群名片 - share_user:分享个人名片 - system:系统消息 各类型详细介绍参见发送消息内容
create_timestring消息生成的时间戳。单位:毫秒
update_timestring消息更新的时间戳。单位:毫秒
deletedboolean消息是否被撤回。取值: - true:被撤回 - false:未被撤回
updatedboolean消息是否被更新。取值: - true:被更新 - false:未被更新
chat_idstring消息所属群的群 ID。了解群 ID 可参见群组概述
sendersender消息发送者的信息。发送者可以是用户或应用。
∟ idstring发送者的 ID。
∟ id_typestring发送者的 ID 类型。取值: - open_id:用户的 open_id(了解什么是 Open ID) - app_id:应用的 App ID
∟ sender_typestring发送者类型。取值: - user:用户 - app:应用
∟ tenant_keystring租户在飞书内的唯一标识,可用作租户在应用里的唯一标识,可使用该 Key 值获取商店应用的 tenant_access_token
bodymessage_body消息包含的内容信息。
∟ contentstring消息内容,JSON 结构。不同的消息类型(msg_type)对应不同内容,具体内容格式参考发送消息内容
mentionsmention\[\]消息内被 @ 的用户或机器人的 ID 列表。
∟ keystring被 @ 的用户或机器人的序号。例如,第 3 个被 @ 到的成员取值为 @_user_3
∟ idstring被 @ 的用户或者机器人的 ID。
∟ id_typestring被 @ 的用户或机器人的 ID 类型。目前仅支持 open_id了解什么是 Open ID)。
∟ namestring被 @ 的用户或机器人的名称。
∟ tenant_keystring租户在飞书内的唯一标识,可用作租户在应用里的唯一标识,可使用该 Key 值获取商店应用的 tenant_access_token
thread_idstring话题独有的 ID,使用该 ID 可实现: - 调用转发话题获取话题历史消息等接口。 - 判断是否为话题(所查询的消息如果不返回该值,则说明该消息为非话题消息)。 注意:话题在拥有 thread_id 之外,同时也拥有 message_id。例如,当你调用获取会话历史消息接口时,如果消息是话题形式,则该消息会同时返回 message_idthread_id。 话题形式如下图所示,关于话题的详细介绍,参见话题概述image.png
upper_message_idstringupper_message_id 是合并转发消息中,子消息所在的合并转发消息的 message_id。以下图的消息回复举例: Group 1321314316.png 其中的 msg1、msg2、msg3 是合并转发消息中的三条子消息,它们的 upper_message 即为所在的合并转发消息的message_id

数据示例

json
{
        "message_id": "om_dc13264520392913993dd051dba21dcf",
        "root_id": "om_40eb06e7b84dc71c03e009ad3c754195",
        "parent_id": "om_d4be107c616aed9c1da8ed8068570a9f",
        "msg_type": "card",
        "create_time": "1615380573411",
        "update_time": "1615380573411",
        "deleted": false,
        "updated": false,
        "chat_id": "oc_5ad11d72b830411d72b836c20",
        "sender": {
            "id": "cli_9f427eec54ae901b",
            "id_type": "app_id",
            "sender_type": "app",
            "tenant_key": "736588c9260f175e"
        },
        "body": {
            "content": "{\"text\":\"@_user_1 test content\"}"
        },
        "mentions": [
            {
                "key": "@_user_1",
                "id": "ou_155184d1e73cbfb8973e5a9e698e74f2",
                "id_type": "open_id",
                "name": "Tom",
                "tenant_key": "736588c9260f175e"
            }
        ],
        "thread_id": "omt_16f3c7e1268f1749",
        "upper_message_id": "om_40eb06e7b84dc71c03e009ad3c754195"
}

内容来源:飞书开放平台 · 自动爬取整理