用于中断指定会话的Agent调用，支持流式响应中断。
接口说明
请求说明
该接口主要用于用户主动中断正在进行中的会话，特别是当会话处于流式响应状态时。
sessionId是必需参数，用来标识要取消的具体会话。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Jsonrpc |
string |
否 |
JSON-RPC 版本，固定 2.0 |
2.0 |
| Id |
string |
否 |
请求方传入的 id，原样回显 |
676303114031776 |
| Params |
object |
否 |
请求的业务参数 |
|
| SessionId |
string |
否 |
待取消的会话 ID，必填 |
sess_0f12abc34 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
7CD3D216-5876-5DB1-A34A-396806F4A413 |
| JsonRpcResponse |
object |
JSON-RPC 结果 |
|
| Jsonrpc |
string |
JSON-RPC 版本，固定 2.0 |
2.0 |
| Id |
string |
请求方传入的 id，原样回显 |
7675839888324361477 |
| Result |
object |
取消会话的结果对象 |
|
| SessionId |
string |
会话 ID |
session-d5d549fe4c2c4180a9814fb74190f502 |
示例
正常返回示例
JSON格式
{
"RequestId": "7CD3D216-5876-5DB1-A34A-396806F4A413",
"JsonRpcResponse": {
"Jsonrpc": "2.0",
"Id": "7675839888324361477",
"Result": {
"SessionId": "session-d5d549fe4c2c4180a9814fb74190f502"
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。