获取运行

该 API 用于获取某个飞书 Aily 应用的运行（Run）的详细信息；包括运行的状态、结束时间等。

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

实体概念说明

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

请求

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

请求头

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

路径参数

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

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ run	run	运行信息
└ id	string	运行 ID
└ created_at	string	运行的创建时间，毫秒时间戳
└ app_id	string	应用 ID
└ session_id	string	会话 ID
└ status	string	运行状态；详见 Run 状态机说明 - 对于 COMPLETED 状态的运行、可通过 ListMessage 接口获取 Bot 返回的消息内容。
└ started_at	string	开始时间，毫秒时间戳
└ ended_at	string	结束时间，毫秒时间戳
└ error	run_error	失败时的错误信息
└ code	string	错误码
└ message	string	错误信息
└ metadata	string	其他透传信息

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "run": {
            "id": "run_4dfrxvctjqzzj",
            "created_at": "1711975665710",
            "app_id": "spring_xxx__c",
            "session_id": "session_4dfunz7sp1g8m",
            "status": "IN_PROGRESS",
            "started_at": "1711975665710",
            "ended_at": "1711975665710",
            "error": {
                "code": "sp_ec_sm_900101",
                "message": "技能不存在或已删除"
            },
            "metadata": "{}"
        }
    }
}

错误码

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