列出 Aily 消息

该 API 用于列出某个飞书 Aily 应用的某个会话（Session）下消息（Message）的详细信息；包括消息的内容、发送人等。

Tip: 更多信息及示例代码，可参考 Aily OpenAPI 接入与接口说明。

实体概念说明

• 会话（Session）：管理用户与 Aily 助手之间的交互会话；每次会话记录了用户发送给 Aily 助手的消息以及 Aily 助手的响应。
• 消息（Message）：消息可以包含文本、表格、图片等多种类型的内容。
• 运行（Run）：Aily 助手基于会话内消息进行意图判定、调用匹配的技能，并返回技能执行后的结果消息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/aily/v1/sessions/:aily_session_id/messages
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	aily:message:read 获取消息

请求头

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

路径参数

名称	类型	描述
aily_session_id	string	会话 ID；参考 创建会话 接口 示例值："session_4dfunz7sp1g8m" 数据校验规则： - 长度范围：0 ～ 32 字符 - 正则校验：session_[0-9a-hjkmnp-z]{1,24}

查询参数

名称	类型	必填	描述
page_size	int	否	本次请求获取的消息记录条数，默认 20 示例值：20
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
run_id	string	否	过滤条件，按执行的唯一 ID 筛选 示例值：run_4dfrxvctjqzzj 数据校验规则： - 长度范围：0 ～ 32 字符 - 正则校验：run_[0-9a-hjkmnp-z]{1,28}
with_partial_message	boolean	否	是否返回正在进行中（即流式输出中）的消息内容 - 当设置为 true 时，返回的消息记录中、每个消息将额外包含一个 status 字段（IN_PROGRESS

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ messages	aily_message\[\]	消息列表
└ id	string	消息 ID
└ session_id	string	会话 ID
└ run_id	string	运行 ID
└ content_type	string	消息内容类型
└ content	string	消息内容
└ files	aily_message_file\[\]	消息中包含的文件
└ id	string	文件 ID
└ mime_type	string	文件类型，参见MIME 类型（IANA 媒体类型）
└ file_name	string	文件名
└ metadata	string	其他透传信息
└ created_at	string	文件的创建时间，毫秒时间戳
└ preview_url	aily_message_file_preview	文件预览链接
└ url	string	文件的 URL
└ expired_at	string	url 过期时间，秒时间戳
└ quote_message_id	string	引用的消息 ID
└ sender	aily_sender	发送者
└ entity_id	string	实体 ID
└ identity_provider	string	身份提供者
└ sender_type	string	发送人类型
└ aily_id	string	飞书智能伙伴创建平台账号体系下的 ID
└ mentions	aily_mention\[\]	被@的实体
└ entity_id	string	实体 ID
└ identity_provider	string	身份提供者
└ key	string	被@实体在消息体中的占位符
└ name	string	被@实体的名称
└ aily_id	string	飞书智能伙伴创建平台账号体系下的 ID
└ plain_text	string	消息体的纯文本表达
└ created_at	string	消息的创建时间，毫秒时间戳
└ status	string	状态
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "messages": [
            {
                "id": "message_4df45f2xknvcc",
                "session_id": "session_4dfunz7sp1g8m",
                "run_id": "run_4dfrxvctjqzzj",
                "content_type": "MDX",
                "content": "你好",
                "files": [
                    {
                        "id": "file_4d9nu1ev3a2rq",
                        "mime_type": "image/png",
                        "file_name": "发票.png",
                        "metadata": "{}",
                        "created_at": "1711975665710",
                        "preview_url": {
                            "url": "http://path_to_file",
                            "expired_at": "1719413169"
                        }
                    }
                ],
                "quote_message_id": "message_4de9bpg70qskh",
                "sender": {
                    "entity_id": "ou_5ad573a6411d72b8305fda3a9c15c70e",
                    "identity_provider": "FEISHU",
                    "sender_type": "USER",
                    "aily_id": "1794840334557292"
                },
                "mentions": [
                    {
                        "entity_id": "ou_5ad573a6411d72b8305fda3a9c15c70e",
                        "identity_provider": "FEISHU",
                        "key": "@_user_1",
                        "name": "张三",
                        "aily_id": "1794840334557292"
                    }
                ],
                "plain_text": "你好",
                "created_at": "1711975665710",
                "status": "COMPLETED"
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	2700001	param is invalid	参数错误