通用消息 · WebSocket

连接、鉴权及订阅限制见 WebSocket 概览。

取消订阅

订阅确认 (type: subscribed)

RECEIVEsubscribed

服务端 → 客户端

返回已接受的订阅 ID。请求 ID 省略或为空时使用 default。

消息字段

字段	类型	必填	说明
type	string	是	可选值: "subscribed"
subscription_id	string	是	请求中的订阅 ID；省略或留空时为 default。

示例

{
  "type": "subscribed",
  "subscription_id": "btc-jpy"
}

应用层心跳 (type: ping)

SENDping

客户端 → 服务端

应用层心跳通过 pong 原样返回 ts。它与 WebSocket 协议的 ping/pong 帧相互独立。服务端每 30 秒发送协议 ping，并要求在 90 秒读取期限内收到协议 pong；浏览器会自动处理这些帧。

确认消息: pong

消息字段

字段	类型	必填	说明
type	string	是	固定为 ping。 可选值: "ping"
ts	string	否	在 pong 中原样返回的字符串，默认空字符串。 默认值: ""

示例

{
  "type": "ping",
  "ts": "1787974923000"
}

心跳响应 (type: pong)

RECEIVEpong

服务端 → 客户端

原样返回应用层 ping 的 ts，与 WebSocket 协议的 pong 帧相互独立。

消息字段

字段	类型	必填	说明
type	string	是	可选值: "pong"
ts	string	是

示例

{
  "type": "pong",
  "ts": "1787974923000"
}

错误消息 (type: error)

RECEIVEerror

服务端 → 客户端

订阅校验失败时，已有订阅与连接保持有效。subscribe_failed 之后会断开连接。无效 JSON 或超过 64 KiB 的消息可能直接断开连接，不返回 JSON 错误。

code	含义
invalid_subscription	quote、channel、symbol 或 interval 无效。
subscription_limit	连接上的订阅数超过 100。
symbol_limit	超出 symbol 配额，或全资产订阅冲突。
unknown_message	不支持的消息类型。
subscribe_failed	实时事件服务不可用，请退避后重连。

消息字段

字段	类型	必填	说明
type	string	是	固定为 error。 可选值: "error"
code	string	是	可供程序处理的错误码，见上方错误码表。 可选值: "invalid_subscription", "subscription_limit", "symbol_limit", "unknown_message", "subscribe_failed"
message	string	是	错误详情。

示例

{
  "type": "error",
  "code": "symbol_limit",
  "message": "a quote-only market subscription uses the full symbol budget; use a separate connection"
}