# SocketTask.close

调用 SocketTask.close(Object object) 关闭 WebSocket 连接。

## 支持说明

该接口仅支持小程序调用，对应的客户端版本支持情况如下所示。

应用能力 | Android | iOS | PC | Harmony | 预览效果
---|---|---|---|---|---
小程序 | **✓** | **✓** | **✓** | V7.39.0+ | 预览
网页应用 | **X** | **X** | **X** | **X** | /

## 输入

该接口继承[标准对象输入](https://open.feishu.cn/document/uYjL24iN/ukzNy4SO3IjL5cjM)，扩展属性如下所示。

名称 | 数据类型 | 是否必填 | 默认值 | 描述
---|---|---|---|---
code | number | 否 | 1000 | 关闭连接状态码。示例值：1000
reason | string | 否 | \- | 关闭连接消息。示例值：close socket

## 输出
该接口继承[标准对象输出](https://open.feishu.cn/document/uYjL24iN/ukzNy4SO3IjL5cjM#8c92acb8)，无扩展属性。

## 示例代码

```js
const socketTask = tt.connectSocket({"url":"wss://echo.websocket.org"});
socketTask.close({
    code: 1000,
    reason: "close socket",
    success(res) {
      console.log(JSON.stringify(res));
    },
    fail(res) {
      console.log(`close fail: ${JSON.stringify(res)}`);
    }
});
```

## 错误码

`fail` 返回对象中可能包含 errno 属性，表示错误码。关于 errno 错误码的详细说明以及通用错误码列表，可参见[Errno 错误码](https://open.feishu.cn/document/uYjL24iN/uAjMuAjMuAjM/errno)。