This website is available for multi language.

Document

obnizのハードウェアやクラウドの仕様や特徴について


ws

request: reset_obniz_on_ws_disconnection

path type conditions description
ws.reset_obniz_on_ws_disconnection boolean
  • required
 
// Json Example
[
    {
        "ws": {
            "reset_obniz_on_ws_disconnection": false
        }
    }
]

response: ready

all things ready

path type conditions description
ws.ready boolean
  • required
  • const true
 
//Response Example
[
    {
        "ws": {
            "ready": true
        }
    }
]

response: redirect

If the server required you to connect other endpoint to communicate with your obniz. This json will be sent.

path type conditions description
ws.redirect string
  • required
The url you should redirect to. 
//Response Example
[
    {
        "ws": {
            "redirect": "wss://ws1.obniz.io"
        }
    }
]