METHOD_System.GetServerInfo

This method sends a request to BEMS to return the web socket URL on supported environments.

BEMS response and notification

The following table describes the parameters that BEMS returns and the notification sent to the BlackBerry Connect app when a chat session is started.

Parameter

Type

Description

method

String

Returns the invoked method (for example, System.GetServerInfo).
state String This parameter specifies the state of the request to BEMS (for example, Processing or Complete).

Code example

The following example sends a request to begin BEMS to return the web socket URL to the BlackBerry Connect app.

{
  "method":"System.GetServerInfo",
  "params":
    {  },
  "id": "c1",
  "jsonrpc":"2.0"
}

If the request is successful, BEMS sends the following response to the BlackBerry Connect app and processes the request.

{
 "id": "c1",
 "error": null,
 "result": 
   {
     "data": 
       {
        "Build Version":"2.16.2.282.566401",
        "DB_SESSION_TIMEOUT_SECS":300,
        "SESSION_TIMEOUT_SECS":86400,
        "GD_URL": "<bems name>.example.com",
        "MAX_USERS_THRESHOLD":10000,
        "Connect Server Start Time":"Wednesday, June 5, 2019 1:04:23 PM",
        "Number of Sessions":0,
        "WebSocket URL":"wss://websocket.example.com:8082/GaslampService/ws",
        "method":"System.GetServerInfo",
        "state":"PROCESSING"
       }
   },
 "jsonrpc":"2.0"
 }