帮你快速理解、总结文档立即下载

查询 Agent 会话详情

最近更新时间:2026-10-29 18:19:30
我的收藏

接口描述

查询单个会话的状态、所属版本与聊天接入点。
GET /v2/enterprises/{enterpriseId}/managedagent/agents/{agentId}/sessions/{sessionId}

输入参数

路径参数

参数
类型
说明
enterpriseId
string
WorkBuddy 企业 ID
agentId
string
等价于请求体字段 AgentId
sessionId
string
等价于请求体字段 SessionId

查询参数

无

请求体

无(GET / DELETE 不带请求体,条件走路径与查询参数)

输出参数

(200,业务出参包装在 code / data / msg / requestId 中)
DescribeAgentSessionResponse 对应 /DescribeAgentSession 响应体。
字段
类型
说明
sessionId
string
SessionId 会话 ID。
sessionName
string
SessionName 会话名称(暂无来源时为空)
agentId
string
AgentId Agent 业务 ID
agentName
string
AgentName Agent 名称
versionId
string
VersionId 会话绑定的版本 ID;创建时未显式指定(由系统按路由权重自选)时为空字符串。
versionName
string
VersionName 会话使用的版本名称(与 VersionId 区分:此为版本名,非 ID)。
status
string
Status 会话状态:CREATING / ACTIVE / IDLE / MIGRATING / FAILED / ARCHIVED
creator
string
Creator 会话发起人用户 ID(与 Skill 侧 CreatorId「资源作者」语义不同)
source
string
Source 创建来源(大写枚举,CAPI 规范 1.2.2):CLOUD=云端自建 / CHANNEL=渠道 / SCHEDULED_TASK=自动化任务 / A2A=A2A 调用。
endpointSet
ChatEndpoint[]
EndpointSet 可用的聊天接入点列表(详情独有;与 CreateAgentSession 同构)。
createdTime
string
CreatedTime 会话创建时间,UTC RFC3339。
modifiedTime
string
ModifiedTime 会话最后修改时间,UTC RFC3339。

示例

输入示例

GET /v2/enterprises/{enterpriseId}/managedagent/agents/{agentId}/sessions/{sessionId}
Authorization: Bearer pt_<YOUR_APP_KEY>

输出示例

{
"code": 0,
"data": {
"agentId": "736918300000000001",
"agentName": "数据分析助手",
"createdTime": "2026-10-20T09:30:00Z",
"creator": "<REDACTED_USER>",
"endpointSet": [
{
"endpointType": "PUBLIC",
"url": "https://example.com/download/pkg-001.zip"
}
],
"modifiedTime": "2026-10-20T09:30:00Z",
"sessionId": "736918300000000002",
"sessionName": "数据分析助手",
"source": "string",
"status": "CREATING",
"versionId": "2087791755109965825",
"versionName": "prod"
},
"msg": "OK",
"requestId": "3c6d138e-1234-5678-9abc-def012345678"
}

错误码

说明:
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见错误响应与公共错误码。
错误码
说明
FailedOperation.WMASessionPrecheckBlocked
因欠费服务已停用,请结清账单后重试
InternalError.SessionOperationFailed
会话操作失败
InvalidParameter.InvalidRequestBody
请求体不合法
InvalidParameter.SessionIDRequired
缺少 SessionId
MissingParameter.UinRequired
公共参数中缺少 Uin
ResourceNotFound.Session
会话不存在
UnauthorizedOperation.UnprovisionedTenant
租户未开通,或企业不存在