获取聊天历史请求

最近更新时间:2024-06-21 21:02:38

我的收藏

1. 接口描述

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

获取推荐问题

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetMsgRecord。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
Type Integer 类型
示例值:1: 坐席 2: 访客 5: API访客
Count Integer 数量
示例值:1
SessionId String 会话sessionid
LastRecordId String 最后一条记录ID
BotAppKey String 应用AppKey
Scene Integer 场景, 体验: 1; 正式: 2

3. 输出参数

参数名称 类型 描述
Records Array of MsgRecord 会话记录
SessionDisassociatedTimestamp String session 清除关联上下文时间, 单位 ms
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 会话记录

输入示例

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

{
    "Type": 2,
    "Count": 15,
    "SessionId": "your session id",
    "LastRecordId": ""
}

输出示例

{
    "Response": {
        "Records": [
            {
                "Content": "abc",
                "RecordId": "abc",
                "RelatedRecordId": "abc",
                "IsFromSelf": true,
                "FromName": "abc",
                "FromAvatar": "abc",
                "Timestamp": "abc",
                "HasRead": true,
                "Score": 1,
                "CanRating": true,
                "Type": 1,
                "References": [
                    {
                        "Id": "abc",
                        "Url": "abc",
                        "Type": 1,
                        "Name": "abc",
                        "DocId": "abc"
                    }
                ],
                "Reasons": [
                    "abc"
                ],
                "IsLlmGenerated": true,
                "ImageUrls": [
                    ""
                ]
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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