全部产品

my.connectSocket

创建一个 WebSocket 的连接。一个阿里云小程序同时只能保留一个 WebSocket 连接,如果当前已存在 WebSocket 连接,会自动关闭该连接,并重新创建一个新的 WebSocket 连接。

使用前提

请预先在 阿里云小程序管理中心 > 小程序详情 >设置 > 开发设置 > 服务器域名白名单 中配置域名白名单。小程序在以下 API 调用时只能与白名单中的域名进行通讯:HTTP请求(my.request)、上传文件(my.uploadFile)、下载文件(my.downloadFile)和 WebSocket(my.connectSocket)。

image

扫码体验

image.png

示例代码

my.connectSocket({
  url: 'test.php',
  data: {},
  header:{
    'content-type': 'application/json'
  },
});

入参

Object 类型,属性如下:

属性类型必填描述
urlString

目标服务器接口地址。

注意:部分新发布的小程序只支持 wss 协议。

dataObject请求的参数。
headerObject设置请求的头部。
successFunction调用成功的回调函数。
failFunction调用失败的回调函数。
completeFunction调用结束的回调函数(调用成功、失败都会执行)。

结果码

结果码描述
1未知错误
2网络连接已经存在
3URL 参数为空
4无法识别的 URL 格式
5URL 必须以 ws 或者 wss 开头
6连接服务器超时
7服务器返回的 https 证书无效
8服务端返回协议头无效
9WebSocket 请求没有指定 Sec-WebSocket-Protocol 请求头
10网络连接没有打开,无法发送消息
11消息发送失败
12无法申请更多内存来读取网络数据