ListThreads - 列出会话

更新时间:
复制为 MD 格式

列出会话

接口说明

列出会话

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:ListThreads

get

*DigitalEmployee

acs:cms:{#regionId}:{#accountId}:digitalemployee/{#name}/thread/*

请求语法

GET /digitalEmployee/{name}/threads HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

name

string

数字员工名称

test

请求参数

名称

类型

必填

描述

示例值

status

string

会话状态

active

threadId

string

会话 id

thread-123123

maxResults

integer

最大返回结果数,最大值 200

20

nextToken

string

分页 Token

xxxxxx

filter

array<object>

查询的过滤条件,若不输入则查询该实例下所有的主题。

object

查询的过滤条件,若不输入则查询该实例下所有的主题。

key

string

过滤 key,当前支持 title、workspace、project

title

value

string

设置的值

test

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

CD8BA7D6-995D-578D-9941-xxxx

threadId

string

会话 id

thread-123123

total

integer

总数

1

maxResults

integer

最大返回结果数,最大值 200

20

threads

array<object>

会话

array<object>

会话

threadId

string

会话 id

thread-123123

digitalEmployeeName

string

数字员工名称

test

title

string

会话标题

test

status

string

会话状态

active

version

integer

版本号

123123

variables

object

会话属性

workspace

string

工作空间。

workspace

project

string

SLS project。

project

createTime

string

创建时间

2025-12-19T15:19:55.040403272+08:00

updateTime

string

更新时间

2025-12-19T15:19:55.040403272+08:00

nextToken

string

分页 Token

xxxxxxxxxx

示例

正常返回示例

JSON格式

{
  "requestId": "CD8BA7D6-995D-578D-9941-xxxx",
  "threadId": "thread-123123",
  "total": 1,
  "maxResults": 20,
  "threads": [
    {
      "threadId": "thread-123123",
      "digitalEmployeeName": "test",
      "title": "test",
      "status": "active",
      "version": 123123,
      "variables": {
        "workspace": "workspace",
        "project": "project"
      },
      "createTime": "2025-12-19T15:19:55.040403272+08:00",
      "updateTime": "2025-12-19T15:19:55.040403272+08:00"
    }
  ],
  "nextToken": "xxxxxxxxxx"
}

错误码

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

变更历史

更多信息,参考变更详情