getConnected

Description: retrieve information about the server and its connection status.

Request example:

{
    "method": "getConnected",
    "requestId" : "1"
}

Response example:

{
    "method": "getConnected",
    "requestId" : "1",
    "state": 2,
    "serverInfo": {
        "server": "192.168.0.103",
        "service": false,
        "port": 4307,
        "domain": "some.server.net"
    },
    "result": true
}

Parameter description:

state - connection status:
- 0 - TrueConf Room API is not connected to the server
- 1 - TrueConf Room API is attempting to connect to the server
- 2 - TrueConf Room API connected to the server
serverInfo - information about the server to which TrueConf Room API is connected or attempting to connect. If TrueConf Room API is not connected and not attempting to connect, this information is unavailable.
server - the name (IP or domain name) of the server to which TrueConf Room API is connected. If TrueConf Room API is not connected and is not attempting to connect, this information is not available.
service — Connection type:
- true — connection to TrueConf Online cloud service
- false— connection to TrueConf Server
port — server port
domain — server domain
requestId - a unique request identifier. You can find more details about it here.

See also: