CancelChat - 取消或打断给定对话

更新时间:
复制 MD 格式

取消或打断对应对话。

接口说明

仅支持新版机器人,只能查询到 90 天内的数据

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

AgentKey

string

否

业务空间 key,不传时访问默认业务空间,key 值在主账号业务管理页面获取

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public

SessionId

string

否

会话 ID,用于标识一个访问者的会话和保持上下文信息。对于一个新的访问者,首次调用 Chat 接口时无需传递此字段,机器人会开启一个会话,并在 Chat 接口的响应中返回该会话的 SessionId。对于该访问者的后续轮次的会话,调用 Chat 接口时传递当前会话的 SessionId,机器人即可基于 SessionId 继续该轮次会话。长度限制是 64 个字符

c1187530338311ebade7cf3eaeb3668a

ChatId

string

否

标识单次对话的 id

7105a351-b2e7-4c9e-8437-c43a043c0a4e

InstanceId

string

否

机器人 ID

chatbot-cn-yjzbyrEvqd

Type

string

否

打断类型

Canceled

Answer

string

否

答案正文

<这个答案被打>

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求本接口的请求 ID

E3E5C779-A630-45AC-B0F2-A4506A4212F1

CancelResult

boolean

调用本接口的结果

示例

正常返回示例

JSON格式

{
  "RequestId": "E3E5C779-A630-45AC-B0F2-A4506A4212F1",
  "CancelResult": true
}

错误码

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

变更历史

更多信息,参考变更详情。