Status v2 Detail 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/detail

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

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
activeCall	JSON Call Stats	Active call statistics
activeCallInbound	JSON Call Stats	Active inbound call statistics
activeCallOutbound	JSON Call Stats	Active outbound call statistics
totalCallInboundAttempt	number	Total inbound call attempt statistics in the last hour
totalCallOutboundAttempt	number	Total outbound call attempt statistics in the last hour
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 Call Stats
Name	Type	Usage
current	number	Current number of calls
highWaterHour	number	Highest number of calls in the last hour
highWaterDay	number	Highest number of calls per hour over the last day
highWaterWeek	number	Highest number of calls per hour over the last week
averageDay	number	Average number of calls per hour over the last day
averageWeek	number	Average number of calls per hour over the last week

Table 4. 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
activeCall	JSON Call Stats	Active call statistics on the account
activeCallInbound	JSON Call Stats	Active inbound call statistics on the account
activeCallOutbound	JSON Call Stats	Active outbound call statistics on the account
applications	Array of JSON Application	Application information
appMappings	Array of JSON Application Mapping	Application mapping information

Table 5. 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
activeCall	JSON Call Stats	Active call statistics on the application
activeCallInbound	JSON Call Stats	Active inbound call statistics on the application
activeCallOutbound	JSON Call Stats	Active outbound call statistics on the application

Table 6. 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
activeCall	JSON Call Stats	Active call statistics on the application mapping
activeCallInbound	JSON Call Stats	Active inbound call statistics on the application mapping
activeCallOutbound	JSON Call Stats	Active outbound call statistics on the application mapping

Table 7. 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
activeCall	JSON Call Stats	Active call statistics on the BVR
activeCallInbound	JSON Call Stats	Active inbound call statistics on the BVR
activeCallOutbound	JSON Call Stats	Active outbound call statistics 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,
      "totalCallInboundAttempt": 38258,
      "totalCallOutboundAttempt": 18532,
      "applications": [
        {
          "id": "0x10000000",
          "name": "Sample Application",
          "uri": "file:///opt/blueworx/vr/sample/Welcome.vxml",
          "cumulativeCall": 1761526,
          "cumulativeCallInbound": 1183350,
          "cumulativeCallOutbound": 578176,
          "activeCall": {
            "current": 598,
            "highWaterHour": 598,
            "highWaterDay": 600,
            "highWaterWeek": 602,
            "averageDay": 600,
            "averageWeek": 600
          },
          "activeCallInbound": {
            "current": 370,
            "highWaterHour": 370,
            "highWaterDay": 372,
            "highWaterWeek": 374,
            "averageDay": 372,
            "averageWeek": 372
          },
          "activeCallOutbound": {
            "current": 228,
            "highWaterHour": 228,
            "highWaterDay": 230,
            "highWaterWeek": 232,
            "averageDay": 230,
            "averageWeek": 230
          }
        }
      ],  
      "appMappings": [
        {
          "id": "0x20000000",
          "mapping": "1001",
          "cumulativeCall": 1761526,
          "cumulativeCallInbound": 1183350,
          "cumulativeCallOutbound": 578176,
          "activeCall": {
            "current": 598,
            "highWaterHour": 598,
            "highWaterDay": 600,
            "highWaterWeek": 602,
            "averageDay": 600,
            "averageWeek": 600
          },
          "activeCallInbound": {
            "current": 370,
            "highWaterHour": 370,
            "highWaterDay": 372,
            "highWaterWeek": 374,
            "averageDay": 372,
            "averageWeek": 372
          },
          "activeCallOutbound": {
            "current": 228,
            "highWaterHour": 228,
            "highWaterDay": 230,
            "highWaterWeek": 232,
            "averageDay": 230,
            "averageWeek": 230
          }
        }
      ],
    },
  ],
  "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": {
        "current": 598,
        "highWaterHour": 598,
        "highWaterDay": 600,
        "highWaterWeek": 602,
        "averageDay": 600,
        "averageWeek": 600
      },
      "activeCallInbound": {
        "current": 370,
        "highWaterHour": 370,
        "highWaterDay": 372,
        "highWaterWeek": 374,
        "averageDay": 372,
        "averageWeek": 372
      },
      "activeCallOutbound": {
        "current": 228,
        "highWaterHour": 228,
        "highWaterDay": 230,
        "highWaterWeek": 232,
        "averageDay": 230,
        "averageWeek": 230
      }
    }
  ],
  "result": "OK"
}