调用GetConversationList接口获取会话列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetConversationList

系统规定参数。取值:GetConversationList。

InstanceId String chatbot-cn-7QuUfaqMQe

机器⼈实例ID。登录云⼩蜜控 制台,左侧⾯板选择开发者-> 基本配置,查看机器⼈示例信 息,可获得该实例ID。

SessionId String c1187530338311ebade7cf3eaeb3668a

会话ID,⽤于标识⼀个访问者 的会话和保持上下⽂信息。对

于⼀个新的访问者,⾸次调⽤ Chat接⼝时⽆需传递此字段, 机器⼈会开启⼀个会话,并在 Chat接⼝的响应中返回该会话 的SessionId。对于该访问者的 后续轮次的会话,调⽤Chat接

⼝时传递当前会话的 SessionId,机器⼈即可基于 SessionId继续该轮次会话

SenderId String 83325

访问者ID。⽤于识别当前会话

中的⽤户。

StartDate String 2020-12-01 11:17:38

开始时间。

EndDate String 2020-12-01 11:17:38

结束时间。

PageNumber String 1

当前⻚码(默认1)。

PageSize String 10

每⻚条数(默认10),最⼤50。

返回数据

名称 类型 示例值 描述
Messages List 参考JSON示例

会话消息的列表

PageNumber Long 1

当前⻚码

PageSize Long 10

当前⻚⾯条数

RequestId String C83D94BB-D371-4DE9-AEE2-14FE7B9CEBA9

请求id

TotalCounts Long 1

搜索范围内总条⽬

Message

字段名

类型

描述

SessionId

String

会话ID

SenderId

String

访问者ID

StartDate

String

会话开始时间

EndDate

String

会话结束时间

Rounds

Integer

交互轮数

示例

请求示例

http(s)://[Endpoint]/?Action=GetConversationList
&InstanceId=chatbot-cn-7QuUfaqMQe
&<公共请求参数>

正常返回示例

XML 格式

<Messages>
    <StartDate>2020-12-01 11:17:38</StartDate>
    <Rounds>1</Rounds>
    <SenderId>83225</SenderId>
    <EndDate>2020-12-01 11:17:38</EndDate>
    <SessionId>c1187530338311ebade7cf3eaeb3668a</SessionId>
</Messages>
<PageSize>10</PageSize>
<RequestId>C83D94BB-D371-4DE9-AEE2-14FE7B9CEBA9</RequestId>
<PageNumber>1</PageNumber>
<TotalCounts>1</TotalCounts>

JSON 格式

{
    "Messages": {
        "StartDate": "2020-12-01 11:17:38",
        "Rounds": 1,
        "SenderId": 83225,
        "EndDate": "2020-12-01 11:17:38",
        "SessionId": "c1187530338311ebade7cf3eaeb3668a"
    },
    "PageSize": 10,
    "RequestId": "C83D94BB-D371-4DE9-AEE2-14FE7B9CEBA9",
    "PageNumber": 1,
    "TotalCounts": 1
}

错误码

访问错误中心查看更多错误码。