Skip to main content

Response message format

The subscribe / unsubscribe ack is {"id":"{id}","code":200,"msg":"success"} on success.

On failure the code is:

  • 400 — bad request (invalid param, unknown method, unknown channel, or channel not allowed for this domain);
  • 429 — rate limited (inbound message rate or connection limit exceeded).

An invalid / expired token is not reported in-band: the handshake is rejected with HTTP 401 and the connection is closed before any WebSocket frame is exchanged.

format

{
"id": "{id}", //call back ID
"code": 200, //result 200=success;400=bad request;429=rate limited
"msg": ""
}

Response-success

{"id":"123", "code": 200, "msg": "success"}

Response-error

{"id":"123", "code": 400, "msg": "unknown channel: xxx"}