建立连接
使用 wsTicket 建立经过认证的 WebSocket 长连接;本页说明连接地址、session 生命周期和安全要求。
连接地址
WebSocket 使用 wss 协议。
text
wss://api.example.com/wlte/v1/ws?ticket={ticket}环境域名会在开通 API 环境时提供。路径部分固定为:
text
/wlte/v1/ws建立流程
- 调用 创建 WebSocket Ticket 获取一次性
wsTicket。 - 使用
ticket查询参数建立 WebSocket 连接。 - 连接建立成功后,该连接进入 authenticated session。
- 连接建立后,客户端可以发送 Session Ping 验证会话可用。
示例
浏览器示例:
js
const socket = new WebSocket(
'wss://api.example.com/wlte/v1/ws?ticket=wst_01HX...'
);Node.js 示例(使用 ws 库):
js
import WebSocket from 'ws';
const socket = new WebSocket(
'wss://api.example.com/wlte/v1/ws?ticket=wst_01HX...'
);Session 生命周期
WebSocket session 的有效期受 access token 约束。
- WS session 不得超过创建 ticket 时所使用 access token 的过期时间
- access token 过期时,对应 WS session 也会关闭
- access token 被吊销、API Client 被禁用或权限范围被调整时,已有连接可能被关闭
- 连接关闭后,如需继续使用 WebSocket,应重新获取 access token 或 wsTicket,并重新建立连接
安全要求
- 仅使用
wss连接 - 不要在页面、日志、错误上报或监控系统中记录完整
ticket或accessToken - 不要把
clientSecret暴露到浏览器、移动端 App 或公开代码仓库 - 服务端访问日志应避免记录 URL 查询参数中的完整
ticket
重连
连接断开后,客户端应按 心跳与重连 处理。
