Skip to main content

Logs

Log messages sent by the SDK

Headers​

  • type : LOG
  • author : sdk Id
  • recipients : client Id
  • status : SENT

payload​

  • origin : message origin
  • status : message log status
  • message : string of the message
  • timeStamp : message timestamp

origin​

Enumerated string with possible values :

  • WS_SERVER : the message comes from the websocket server
  • SDK : the message comes from the SDK
  • CLIENT : the message comes from the client

status​

Enumerated string with possible values :

  • ERROR : An error occured
  • WARNING : A warning occured
  • INFO : Information message
  • MESSAGE : Normal message
  • DEBUG : Debug message

Example​

Example of a log message coming from the websocket server
{
    "type": "LOG",
    "payload": {
        "origin": "WS_SERVER",
        "status": "MESSAGE",
        "message": "Client authenticated : sdk_87C07571-7268-4254-8335-BA73951E3C5D, recipients : [wv_87C07571-7268-4254-8335-BA73951E3C5D]",
        "timeStamp": "2024-01-04T16:04:38.113+01:00"
    },
    "author": "sdk_87C07571-7268-4254-8335-BA73951E3C5D",
    "recipients": [
        "87C07571-7268-4254-8335-BA73951E3C5D"
    ],
    "status": "SENT"
}