CloseChatInstanceSessions - 关闭实例下的会话_虚拟数字人(DVH)-阿里云帮助中心

关闭会话实例session。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
lingmou:CloseChatInstanceSessions	update	全部资源 ``	无	无

请求语法

PUT /openapi/chat/instances/{instanceId}/sessions/close HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	否	购买开通的实例 id，可在订单页查看。	avatar_2dchat_public_cn-xxxxxxx
sessionIds	array	否	待关闭的会话 id 列表。
	string	否	待关闭的会话 id。	8C9F2D4E-7A6B-4F1C-9E53-0B2C8D3F9A4B

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	本次 pop 请求的 id。	7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8
success	boolean	请求是否成功	True
code	string	响应码。	SUCCESS
message	string	状态码描述。	SUCCESS
httpStatusCode	integer	http 响应码	200
data	array	响应数据。
data	ChatSessionInfo	成功关闭的会话信息，包括会话 id、所属主账号、创建的时间戳。	{"sessionId": "20250311-41523E3C-1D27-5844-8EEF-194E4714096B", "mainAccountId": 1234567, "createdAt": 1755680457}

示例

正常返回示例

JSON格式

{
  "requestId": "7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8",
  "success": true,
  "code": "SUCCESS",
  "message": "SUCCESS",
  "httpStatusCode": 200,
  "data": [
    {
      "sessionId": "7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8",
      "mainAccountId": 1234567,
      "createdAt": 1755680969
    }
  ]
}

错误码

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