跳到主要内容

响应消息格式

类型: WEBSOCKET

描述: WebSocket API 对请求进行确认或错误返回时的响应消息结构。

参数

名称类型是否必填默认值说明取值范围
idstring-回显客户端回调 ID,用于请求/响应关联。-
codeinteger-结果码。0 = 成功;非 0 为异常。0=success;1=fail;2=listenKey invalid;401=token expire
msgstring""附加提示或错误信息。-

响应格式

format
{
"id": "{id}", // 回调ID
"code": 1, // 结果:0=success;1=fail;2=listenKey invalid
"msg": ""
}

响应示例

响应-成功
{"id":"123", "code": 0, "msg": "success"}
响应-令牌过期
{"id":"123", "code": 401, "msg": "token expire"}