停止会话

接口信息

接口地址:/api/v1/chat/{conversationId}/stop

请求方式:POST

请求数据类型:无

响应数据类型:*/*

接口描述:

停止指定会话的当前处理过程

请求示例:

POST /api/v1/chat/1545556/stop

请求参数

请求头

参数名	类型	必填	描述	示例值
Authorization	string	是	API Key	`Bearer ak-xxxxeyJhbGciOiJIUzI1NiJ9`

路径参数:

参数名称	参数说明	是否必须	数据类型
conversationId	会话ID	是	integer(int64)

响应参数:

参数名称	参数说明	类型
code	业务状态码，0000 表示成功，其余失败	string
displayCode	源系统状态码，用于问题跟踪	string
message	错误描述信息	string
data	返回的具体业务数据	object
tid	跟踪唯一标识	string
success		boolean

响应示例:

javascript

{
	"code": "0000",
	"displayCode": "0000",
	"message": "成功",
	"data": null,
	"tid": "5424831776087039549",
	"success": true
}

CURL示例

shell

curl 'http://127.0.0.1:8081/api/v1/chat/1545556/stop' \
  -X POST \
  -H 'Authorization: Bearer ak-d1f2129c4ba24629b8448af3354f9dd0'

{"code":"0000","displayCode":"0000","message":"成功","data":null,"tid":"5424831776087039549","success":true}

测试用例

#	场景	状态码	结果
1	停止正在处理的会话	0000	成功，停止当前会话处理

TS模板示例

// 响应接口
export interface ConversationStopRes {
  code: string;
  displayCode: string;
  message: string;
  data: object | null;
  tid: string;
  success: boolean;
}

/** 
 * 停止会话
 * @param {number} conversationId - 会话ID
 * @returns
 */
export function stopConversation(conversationId: number): Promise<ConversationStopRes> {
  return request.post(`/api/v1/chat/${conversationId}/stop`);
}

停止会话 ​

接口信息 ​

请求参数 ​

停止会话

接口信息

请求参数