客户端 API/网页应用/小程序API/网络/WebSocket/connectSocket
# connectSocket(Object object)

创建一个 WebSocket 连接实例，并通过返回的 `socketTask` 操作该连接。

## 支持说明

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

## 输入

继承[标准对象输入](https://open.larksuite.com/document/uYjL24iN/ukzNy4SO3IjL5cjM)，扩展属性描述：

名称 | 数据类型 | 必填 | 默认值 | 描述
---|---|---|---|---
url | string | 是 | &nbsp; | Socket 连接地址<br>**示例值**：wss://echo.websocket.org
header | object | 否 | &nbsp; | HTTP Header<br>**示例值**：{'content-type': 'application/json'}
protocols | string[] | 否 | &nbsp; | 子协议数组<br>**示例值**：['protocol1']

## 输出
返回值：`SocketTask`，该对象的方法列表参见下表：
**注意事项**：点击下表中的方法名，查看对应API的支持说明、调用方法

方法 | 介绍
---|---
[send(Object msg)](https://open.larksuite.com/document/uYjL24iN/ugDOugDOugDO/sockettask/send) | 发送数据
[close(Object option)](https://open.larksuite.com/document/uYjL24iN/ugDOugDOugDO/sockettask/close) | 关闭 Socket 连接
[onOpen(function callback)](https://open.larksuite.com/document/uYjL24iN/ugDOugDOugDO/sockettask/onopen) | 监听连接成功的事件回调
[onClose(function callback)](https://open.larksuite.com/document/uYjL24iN/ugDOugDOugDO/sockettask/onclose) | 监听连接关闭的事件回调
[onMessage(function callback)](https://open.larksuite.com/document/uYjL24iN/ugDOugDOugDO/sockettask/onmessage) | 监听接收到服务器的消息事件回调

## 示例代码

```js
let socketTask = tt.connectSocket({
    url: 'wss://echo.websocket.org',
    success() {
        console.log('Build WebSocketTask success');
    },
    fail(err) {
        console.error('Build WebSocketTask failed', err);
    }
});

```