# 获取会话

该 API 用于获取与某个飞书 Aily 应用的一次会话（Session）的详细信息，包括会话的状态、渠道上下文、创建时间等。
**注意事项**：更多信息及示例代码，可参考 [Aily OpenAPI 接入与接口说明](https://bytedance.larkoffice.com/wiki/UTU6wVTVGigefykjO1acAOOvnNc)。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/aily/v1/sessions/:aily_session_id
HTTP Method | GET
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取会话信息(aily:session:read)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 路径参数

名称 | 类型 | 描述
---|---|---
aily_session_id | string | 会话 ID<br>**示例值**："session_4dfunz7sp1g8m"<br>**数据校验规则**：<br>- 长度范围：`9` ～ `32` 字符<br>- 正则校验：`session_[0-9a-hjkmnp-z]{1,24}`

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
session | aily_session | 会话信息
id | string | 会话 ID
created_at | string | 会话的创建时间，毫秒时间戳
modified_at | string | 会话的上次更新时间，毫秒时间戳
created_by | string | 会话的创建人（Aily UserID）
channel_context | string | 可自行构造的 Context [上下文变量](https://aily.feishu.cn/hc/1u7kleqg/en70bqqj#6a446d5e)；在 Workflow 技能中可消费这部分全局变量
metadata | string | 会话的自定义变量内容，变量数据保存在服务端 Session 中，可在 `GetSession` 时原样返回，无需在 API 调用侧存储

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "session": {
            "id": "session_4dfunz7sp1g8m",
            "created_at": "1711975665710",
            "modified_at": "1711975665710",
            "created_by": "1794840334557292",
            "channel_context": "{}",
            "metadata": "{}"
        }
    }
}
```

### 错误码

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