查看会话信息

最近更新时间:2026-06-04 11:57:01

我的收藏

1. 接口描述

接口请求域名: adp.tencentcloudapi.com 。

查看会话信息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeConversation。
Version String 公共参数,本接口取值:2026-05-20。
Region String 公共参数,详见产品支持的 地域列表
ConversationId String

会话 ID


示例值:4abd149a-e010-4a6c-bc52-1132658f149d
Type Integer

会话类型 枚举值: 0-CONVERSATION_TYPE_UNSPECIFIED(未指定;列表查询时表示全部), 1-CONVERSATION_TYPE_VISITOR(访客端体验), 2-CONVERSATION_TYPE_EVALUATION(评测), 5-CONVERSATION_TYPE_API(API 接入), 10-CONVERSATION_TYPE_WORKFLOW(工作流调试), 20-CONVERSATION_TYPE_SHARE(分享链接)


示例值:2
AppKey String

Type=CONVERSATION_TYPE_API 时必填,应用密钥


示例值:1
LoginSubAccountUin String

主用户Uin


示例值:700001046587
LoginUin String

子用户Uin


示例值:700001046587
ShareCode String

Type=CONVERSATION_TYPE_SHARE 时必填,分享码


示例值:1
UserId String

Type=CONVERSATION_TYPE_API 时必填,访客ID


示例值:1

3. 输出参数

参数名称 类型 描述
AppId String

应用 ID


示例值:2049746910862560576
ConversationId String

会话 ID


示例值:4abd149a-e010-4a6c-bc52-1132658f149d
CreateTime String

创建时间


示例值:2026-04-30T15:05:27+08:00
Type Integer

会话类型 枚举值: 0-CONVERSATION_TYPE_UNSPECIFIED(未指定;列表查询时表示全部), 1-CONVERSATION_TYPE_VISITOR(访客端体验), 2-CONVERSATION_TYPE_EVALUATION(评测), 5-CONVERSATION_TYPE_API(API 接入), 10-CONVERSATION_TYPE_WORKFLOW(工作流调试), 20-CONVERSATION_TYPE_SHARE(分享链接)


示例值:2
UpdateTime String

更新时间


示例值:2026-04-30T16:01:05+08:00
Workspace ConversationWorkspace

工作空间


注意:此字段可能返回 null,表示取不到有效值。
Title String 会话标题
示例值:新会话
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取Skills模式的conversation

输入示例

POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConversation
<公共请求参数>

{
    "ConversationId": "4abd149a-e010-4a6c-bc52-1132658f149d",
    "Type": 2,
    "AppKey": "1",
    "ShareCode": "1",
    "UserId": "1",
    "LoginSubAccountUin": "700001046587",
    "LoginUin": "700001046587"
}

输出示例

{
    "Response": {
        "AppId": "2049746910862560576",
        "ConversationId": "4abd149a-e010-4a6c-bc52-1132658f149d",
        "CreateTime": "2026-04-30T15:05:27+08:00",
        "Type": 2,
        "UpdateTime": "2026-04-30T16:01:05+08:00",
        "Workspace": {
            "StorageType": "sandbox_e2b",
            "WorkspaceId": "6576c839-839c-4a54-b820-408aec31dbe0"
        },
        "RequestId": "7fcd93a2-6fe4-4809-9c9e-d03dad2a0aaf"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码