获取指定消息的内容

调用该接口通过消息的 message_id 查询消息内容。

前提条件

• 应用需要开启机器人能力。
• 机器人必须在消息所属的群组内。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/messages/:message_id
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:message 获取与发送单聊、群组消息 im:message:readonly 获取单聊、群组消息 > Tip: 1. 应用身份获取消息 > 1. 获取单聊消息 需要开启二个权限任意一个： 获取与发送单聊、群组消息（im:message）获取单聊、群组消息（im:message:readonly）（im:message.history:readonly）。 > 2. 获取群聊消息 需先申请单聊场景的任一权限，此外应用还必须开启 获取群组中所有消息（im:message.group_msg） 权限。 > 2. 用户身份获取消息 > 1. 所有群类型都需要先 开启以下二个权限任意一个获取与发送单聊、群组消息（im:message）获取单聊、群组消息（im:message:readonly） > 2. 根据群类型额外开启补充权限： > 1. 获取单聊消息 需要开启以用户身份获取单聊消息（im:message.p2p_msg:get_as_user）权限 > 2. 获取群聊消息 需要开启以用户身份获取群聊消息（im:message.group_msg:get_as_user）权限
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
message_id	string	消息 ID。ID 获取方式： - 调用发送消息接口后，从响应结果的 message_id 参数获取。 - 监听接收消息事件，当触发该事件后可以从事件体内获取消息的 message_id。 - 调用获取会话历史消息接口，从响应结果的 message_id 参数获取。 示例值："om_dc13264520392913993dd051dba21dcf"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID
card_msg_content_type	string	否	card_msg_content_type 参数仅控制卡片消息的返回格式，不会影响其他类型消息的返回格式。 1. 不传该参数（默认）：返回的卡片结构参考接收消息内容中的卡片消息结构，不支持返回发送时的原始卡片 JSON。 2. 传入 user_card_content：返回发送时的原始卡片 JSON。1.0 卡片请参考卡片 JSON 1.0 结构；2.0 卡片请参考卡片 JSON 2.0 结构。 * 版本区分：当返回的消息体为卡片时，可通过 schema 字段来区分该卡片是 1.0 还是 2.0 版本，详情参考卡片 JSON 2.0 版本更新说明。 > 注意：如果 card_msg_content_type 参数的传值方式发生变更，请务必在代码中做好返回格式的兼容处理。 示例值：user_card_content

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	message\[\]	消息内容。 注意：如果查询的消息类型为合并转发（merge_forward），则返回的 items 中会包含 1 条合并转发消息和 N 条子消息。
└ message_id	string	消息 ID。
└ root_id	string	根消息 ID，仅在回复消息场景会有返回值。了解 root_id 可参见消息管理概述。
└ parent_id	string	父消息 ID，仅在回复消息场景会有返回值。了解 parent_id 可参见消息管理概述。
└ thread_id	string	消息所属的话题 ID（不返回说明该消息非话题消息）。了解话题可参见话题概述。
└ msg_type	string	消息类型。类型定义参考接收消息内容。
└ create_time	string	消息生成的时间戳。单位：毫秒
└ update_time	string	消息更新的时间戳。单位：毫秒
└ deleted	boolean	消息是否被撤回或删除。 - true：是，如果是被撤回的消息，content 参数没有返回值。 - false：否
└ updated	boolean	消息是否被更新。 - true：是 - false：否
└ chat_id	string	消息所属的群 ID。你可以调用获取群信息接口，根据群 ID 获取群详情。
└ sender	sender	消息的发送者信息。
└ id	string	发送者的 ID。
└ id_type	string	发送者的 ID 类型。 - 如果发送者是应用，类型为 app_id。 - 如果发送者为用户，类型与查询参数 user_id_type 的取值一致。
└ sender_type	string	发送者类型。 可能值有： - user: 用户 - app: 应用 - anonymous: 匿名 - unknown: 未知
└ tenant_key	string	租户唯一标识。该标识用来识别租户，也可以用来获取租户访问凭证（tenant_access_token）。
└ body	message_body	通过 body 内的 content 参数，返回当前的消息内容。
└ content	string	消息内容，JSON 结构序列化后的字符串，不同消息类型（msg_type）对应不同内容。
└ mentions	mention\[\]	消息内被 @ 的用户或机器人列表。
└ key	string	被 @ 的用户或机器人序号。例如，第 3 个被 @ 到的成员，取值为 @_user_3。
└ id	string	被 @ 的用户或机器人的 ID。 注意： - 当不填写 user_id_type时，该字段将返回被 @ 的用户或机器人的 open_id。 - 当填写 user_id_type 时，该字段将返回 @ 的用户对应类型的 ID（open_id、union_id 或 user_id）或机器人的 app_id。
└ id_type	string	被 @ 的用户或机器人 ID 类型。
└ name	string	被 @ 的用户或机器人的姓名。
└ tenant_key	string	租户唯一标识。该标识用来识别被 @ 用户或机器人的租户，也可以用来获取租户访问凭证（tenant_access_token）。
└ upper_message_id	string	合并转发消息中，上一层级的消息 ID，仅在合并转发场景会有返回值。了解 upper_message_id 可参见消息管理概述。

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "message_id": "om_dc13264520392913993dd051dba21dcf",
                "root_id": "om_40eb06e7b84dc71c03e009ad3c754195",
                "parent_id": "om_d4be107c616aed9c1da8ed8068570a9f",
                "thread_id": "omt_d4be107c616a",
                "msg_type": "text",
                "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\":\"test content\"}"
                },
                "mentions": [
                    {
                        "key": "@_user_1",
                        "id": "ou_155184d1e73cbfb8973e5a9e698e74f2",
                        "id_type": "open_id",
                        "name": "Tom",
                        "tenant_key": "736588c9260f175e"
                    }
                ]
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	230001	Your request contains an invalid request parameter.	参数错误，可根据接口实际返回的错误信息，并参考接口文档内容，检查输入参数是否填写错误。
400	230002	The bot can not be outside the group.	机器人不在对应群组中。你需要将应用机器人添加到接收消息的群组中。如何添加机器人参考机器人使用指南。
400	230006	Bot ability is not activated.	应用未启用机器人能力。启用方式参见如何启用机器人能力。
400	230013	Bot has NO availability to this user.	目标用户（以用户的 user_id/open_id/union_id/email 指定的消息接收者）或单聊用户（以群聊的 chat_id 指定的消息接收者，但 chat_id 对应的群聊类型为单聊 p2p）不在应用机器人的可用范围内，或者是在应用的禁用范围内。 注意：如果目标用户已离职，也会报错 230013。 解决方案： 1. 登录开发者后台，找到并进入指定应用详情页。 2. 在左侧导航栏进入 应用发布 > 版本管理与发布 页面，点击 创建版本。 3. 在 版本详情 页面，找到 可用范围 区域，点击 编辑。 4. 在弹出的对话框内，配置应用的可用范围，将用户添加至可用范围内。 5. 在页面底部点击 保存，并发布应用使配置生效。 6. （可选）如果以上配置完成后仍报错，则需要联系企业管理员登录管理后台，在 工作台 > 应用管理 中进入指定应用详情页，在 应用可用范围 内查看该用户是否被设置为了 禁用成员。 具体操作参见配置应用可用范围。
400	230027	Lack of necessary permissions.	无权进行本次操作。可能的原因有： 1. 缺少相应权限，可根据实际的错误信息进行排查。 2. 未检查到用户授权信息。 3. 如果需要机器人在外部群操作，则需要先为机器人开启对外共享能力，详情参见机器人支持外部群和外部用户单聊。
400	230050	The message is invisible to the operator.	该消息对于当前操作者不可见，无法进行本操作。
400	230110	Action unavailable as the message has been deleted.	无法获取已经被删除的消息。

更多错误码信息，参见通用错误码。