Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.19 KB

WebSocket-Endpoint.md

File metadata and controls

46 lines (34 loc) · 1.19 KB

WebSocket Endpoint

DataListener

Starts a listener for new data that can be decrypted by the provided account.

Endpoint: wss://localhost:8550/dataListener

Connect

An account has to be connected to the websocket to receive data for.

Message
  • Object - account to connect as.
{
    "identifier": "407d73d8a49eeb85d32cf465507dd71d507100c1",
    "password": "myPassword"
}
Response
  • String - Listener handle of the established connection.
ded64f8bfeff4785
Update
  • String - data identifier.
ee8e01eff7acd538e8f6e6deea1a971e1be920ee4ceb4419434315dac04ed736
Error

If an error occurs the conversation will be closed with a status code and reason phrase.

Next to the pre-defined errors of the WebSocket Protocol specification (RFC 6455), the following implementation-specific error might occur:

Code Message Meaning
4000 Invalid Message The sent message has an invalid format.
4001 Already Connected The conversation already had a connected account.
4002 Invalid Account Account password is invalid or account does not exist.