创建 WebSocket Ticket
建立 WebSocket 连接前,必须先通过此 REST 端点换取一次性 wsTicket 作为连接凭证。
端点
http
POST /wlte/v1/ws/ticket用途
使用 access token 创建一次性 wsTicket。
客户端必须先获取 wsTicket,再使用该 ticket 建立 WebSocket 连接。
text
accessToken -> wsTicket -> WebSocket authenticated session请求
完整地址:
http
POST {baseUrl}/wlte/v1/ws/ticket请求头:
http
Authorization: Bearer {accessToken}
Content-Type: application/json
Accept: application/json请求体:
json
{}成功响应
HTTP 状态码:
text
200 OK响应体:
json
{
"code": "SUCCESS",
"message": "OK.",
"requestId": "req_001",
"data": {
"ticket": "wst_01HX...",
"expiresIn": 60
}
}响应 data 结构
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
ticket | string | 是 | 一次性 WebSocket 连接凭证 |
expiresIn | integer | 是 | ticket 有效期,单位为秒 |
Ticket 规则
wsTicket只能使用一次wsTicket只用于建立 WebSocket 连接,不用于 REST APIwsTicket未使用且超过expiresIn后失效wsTicket的有效期不会超过创建它时所使用 access token 的剩余有效期- 建连成功后,
wsTicket立即失效 - 如果建连失败,客户端应重新调用本接口获取新的 ticket
错误响应
可能返回:
400 INVALID_REQUEST401 AUTH_REQUIRED401 AUTH_INVALID401 AUTH_EXPIRED429 RATE_LIMITED500 INTERNAL_ERROR
