Status v2 API

Example status API uses HTTP or HTTPS with a GET or POST request.

The GET/POST request has to be sent to:

http://<brm>:<port>/api/v2/bvr/status

or

https://<brm>:<port>/api/v2/bvr/status

Where <brm> is the address of the BRM machine and <port> is the HTTP or HTTPS port configured in BRM here: HTTP API Configuration Options.

​

If BRM is running and the HTTP API is enabled the request will respond with a 200 status code. The response content will contain a JSON summary of the status.

Table 1. JSON Status Response
Name Type Usage
result string Outcome of the status API request.
bvrCount number Number of available BVRs
cumulativeCallCount number Total number of calls
cumulativeInboundCallCount number Total number of inbound calls
cumulativeOutboundCallCount number Total number of outbound calls
activeCallCount number Current number of active calls
activeInboundCallCount number Current number of active inbound calls
activeOutboundCallCount number Current number of active outbound calls
totalInboundCallCount number Total number of inbound call attempts
totalOutboundCallCount number Total number of outbound call attempts
license JSON License License information
accounts Array of JSON Account Account information
bvrs Array of JSON BVR BVR information

​

Table 2. JSON License
Name Type Usage
license number Total licenses
customer number Number of customers

​

Table 3. JSON Account
Name Type Usage
id string Unique ID of the account
name string Name of the account
cumulativeCallCount number Total number of calls on the account
cumulativeInboundCallCount number Total number of inbound calls on the account
cumulativeOutboundCallCount number Total number of outbound calls on the account
activeCallCount number Current number of active calls on the account
activeInboundCallCount number Current number of active inbound calls on the account
activeOutboundCallCount number Current number of active outbound calls on the account
applications Array of JSON Application Application information
appMappings Array of JSON Application Mapping Application mapping information

​

Table 4. JSON Application
Name Type Usage
id string Unique ID of the application
name string Name of the application
uri string Application URI
cumulativeCallCount number Total number of calls on the application
cumulativeInboundCallCount number Total number of inbound calls on the application
cumulativeOutboundCallCount number Total number of outbound calls on the application
activeCallCount number Current number of active calls on the application
activeInboundCallCount number Current number of active inbound calls on the application
activeOutboundCallCount number Current number of active outbound calls on the application

​

Table 5. JSON Application Mapping
Name Type Usage
id string Unique ID of the application mapping
mapping string Application mapping SIP user
cumulativeCallCount number Total number of calls on the application mapping
cumulativeInboundCallCount number Total number of inbound calls on the application mapping
cumulativeOutboundCallCount number Total number of outbound calls on the application mapping
activeCallCount number Current number of active calls on the application mapping
activeInboundCallCount number Current number of active inbound calls on the application mapping
activeOutboundCallCount number Current number of active outbound calls on the application mapping

​

Table 6. JSON BVR
Name Type Usage
sessionIndex string Session index of the BVR
name string Name of the BVR
hostName string BVR host name
hostIp string BVR IP address
cumulativeCallCount number Total number of calls on the BVR
cumulativeInboundCallCount number Total number of inbound calls on the BVR
cumulativeOutboundCallCount number Total number of outbound calls on the BVR
activeCallCount number Current number of active calls on the BVR
activeInboundCallCount number Current number of active inbound calls on the BVR
activeOutboundCallCount number Current number of active outbound calls on the BVR

​

Example response

  
{
  "bvrCount": 1,
  "license": {
  "license": 2000,
  "customer": 1
  },
  "cumulativeCall": 1761526,
  "cumulativeCallInbound": 1183350,
  "cumulativeCallOutbound": 578176,
  "activeCall": 598,
  "activeCallInbound": 370,
  "activeCallOutbound": 228,
  "totalCallInboundAttempt": 38258,
  "totalCallOutboundAttempt": 18532,
  "accounts": [
    {
      "id": "0x00000000",
      "name": "Admin Account",
      "cumulativeCall": 1761526,
      "cumulativeCallInbound": 1183350,
      "cumulativeCallOutbound": 578176,
      "activeCall": 598,
      "activeCallInbound": 370,
      "activeCallOutbound": 228,
      "applications": [
        {
          "id": "0x10000000",
          "name": "Sample Application",
          "uri": "file:///opt/blueworx/vr/sample/Welcome.vxml",
          "cumulativeCall": 1761526,
          "cumulativeCallInbound": 1183350,
          "cumulativeCallOutbound": 578176,
          "activeCall": 598,
          "activeCallInbound": 370,
          "activeCallOutbound": 228,
        }
      ],  
      "appMappings": [
        {
          "id": "0x20000000",
          "mapping": "1001",
          "cumulativeCall": 1761526,
          "cumulativeCallInbound": 1183350,
          "cumulativeCallOutbound": 578176,
          "activeCall": 598,
          "activeCallInbound": 370,
          "activeCallOutbound": 228,
        }
      ],
    },
  ],
  "bvrs": [
    {
      "sessionIndex": "01020304-11",
      "name": "BVR Linux 7.38.2 intel",
      "hostName": "bvr",
      "hostIp": "1.2.3.4",
      "cumulativeCall": 1761526,
      "cumulativeCallInbound": 1183350,
      "cumulativeCallOutbound": 578176,
      "activeCall": 598,
      "activeCallInbound": 370,
      "activeCallOutbound": 228,
    }
  ],
  "result": "OK"
}
Parent topic: Status