文档首页/ 对话机器人服务 CBS/ API参考/ 历史API/ 问答会话API（仅支持老用户）/ 关闭会话
更新时间：2022-11-18 GMT+08:00
查看PDF
分享

关闭会话

功能介绍

问答会话API由开启会话、处理会话、关闭会话三个接口组成。用户可通过调用该接口关闭会话。该接口即将下线，请优先使用问答机器人API接口进行调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

DELETE https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/sessions/{session_id}

表1 路径参数

参数

是否必选

参数类型

描述

endpoint

是

String

终端节点，即调用API的请求地址。

不同服务不同区域的endpoint不同，您可以从终端节点中获取。

project_id

是

String

项目ID，用于资源隔离。请参见获取项目ID。

qabot_id

是

String

机器人标识符，qabot编号，UUID格式。如：303a0a00-c88a-43e3-aa2f-d5b8b9832b02。

进入问答机器人的Console界面，在“机器人名称/ID”列显示对应的qabot_id。

session_id

是

String

会话标识符，UUID格式。如：c04e6f7b-61d7-4a2d-a0c8-f9ecd2f62359。

具体获取方式请参见开启会话章节。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。

Content-Type

是

String

消息体的类型（格式），参数值为“application/json”。

响应参数

状态码： 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码。 调用成功时无此字段。

error_msg

String

调用失败时的错误信息。 调用成功时无此字段。

请求示例

  • 请求示例 
    DELETE https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/sessions/{session_id}
Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • Java语言请求代码示例 
    import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;

public class CBSDemo {

    public void cbsDemo() {
        try {
            //endpoint、projectId、qabot_id等需要替换成实际信息。
            URL url = new URL("https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/sessions/{session_id}");
            String token = "用户获取得到的实际token值";
            HttpURLConnection connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("DELETE");
            connection.setDoInput(true);
            connection.setDoOutput(true);
            connection.addRequestProperty("Content-Type", "application/json");
            connection.addRequestProperty("X-Auth-Token", token);

            InputStream is = connection.getInputStream();
            BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
            while (br.ready()) {
                System.out.println(br.readLine());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        CBSDemo CBSDemo = new CBSDemo();
        CBSDemo.cbsDemo();
    }
}

响应示例

状态码：400

失败响应示例

{
    "error_code":"CBS.0011",
    "error_msg":"auth failed"
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。

相关文档