Topic blueworx.license

The blueworx.license topic contains license events. The type field details the underlying type of the event which can currently only be call related.

The blueworx.license topic supports the following headers.

Table 1. Headers for blueworx.license
Header Value
Type Call

Calls status

Overall call status for all accounts. Also contains call status broken down by account. Within each account this is further broken down by application and app mapping.

Table 2. JSON for Call status
Name Type Optional Description
type string No Always contains "call"
active number No Number of active calls
cumulative number No Cumulative number of calls
accounts array No List of Account Status

Account Status

Overall call status for a specific account. This further broken down by application and app mapping.

Table 3. JSON for Account Status
Name Type Optional Description
id string No ID of the account
name string No Name of the account
active number No Number of active calls
cumulative number No Cumulative number of calls
highWaterMarkHour number No Highest number of active calls in the last hour
highWaterMarkDay number No Highest number of active calls in the last day
highWaterMarkWeek number No Highest number of active calls in the last week
applications array No List of Application Status
appMappings array No List of App Mapping Status

Application status

Overall call status for a specific application.

Table 4. JSON for Application Status
Name Type Optional Description
id string No Application ID
name string No Name of the application
uri string No Application URI
active number No Number of active calls
cumulative number No Cumulative number of calls
highWaterMarkHour number No Highest number of active calls in the last hour
highWaterMarkDay number No Highest number of active calls in the last day
highWaterMarkWeek number No Highest number of active calls in the last week

App Mapping Status

Overall call status for a specific app mapping.

Table 5. JSON for App Mapping Status
Name Type Optional Description
id string No Application mapping ID
mapping string No Application mapping SIP user
active number No Number of active calls
cumulative number No Cumulative number of calls
highWaterMarkHour number No Highest number of active calls in the last hour
highWaterMarkDay number No Highest number of active calls in the last day
highWaterMarkWeek number No Highest number of active calls in the last week

Example

{
    "type": "call",
    "customer": 0,
    "active": 0,
    "cumulative": 18,
    "accounts": [
        {
            "id": "0x00000000",
            "name": "Admin Account",
            "active": 0,
            "cumulative": 1,
            "highWaterMarkHour": 1,
            "highWaterMarkDay": 1,
            "highWaterMarkWeek": 1,
            "applications": [
                {
                    "id": "0x10000000",
                    "name": "Sample Application",
                    "uri": "file:///opt/blueworx/vr/sample/Welcome.vxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000001",
                    "name": "1000Welcomes",
                    "uri": "file:///opt/blueworx/vr/sample/1000Welcomes.vxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000022",
                    "name": "DF Blueworx_dev",
                    "uri": "file:///bvr_apps/DialogFlow_bwdev.ccxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000003",
                    "name": "WatsonCCXML",
                    "uri": "file:///bvr_apps/WatsonSample.ccxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000028",
                    "name": "BlueworxIDEIVRAppStart_IVR",
                    "uri": "file:///bvr_apps/router.ccxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000009",
                    "name": "DialogFlow Virtual Assistant",
                    "uri": "file:///bvr_apps/VirtualAssistantSample.vxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x0000000A",
                    "name": "weather",
                    "uri": "file:///bvr_apps/Lumenvox/en_US/Weather.vxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x0000000B",
                    "name": "RecordUtterance",
                    "uri": "file:///bvr_apps/nocache/pdb/test_dtmf_menu_saveaudio.vxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x0000002F",
                    "name": "ccxml_nocache_maxage1",
                    "uri": "file:///bvr_apps/cache_tests/nocache_maxage1/Welcome.ccxml?callId=CCXID-CCXML_btele_0007",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000011",
                    "name": "RecordUtterance_DTMF_Submit",
                    "uri": "file:///bvr_apps/nocache/record_tests/test_dtmf_menu_saveaudio.vxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000031",
                    "name": "lex",
                    "uri": "file:///bvr_apps/regression_tests/dialogueLex.ccxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000013",
                    "name": "DialogFlow_Own_STT_TTS",
                    "uri": "file:///bvr_apps/DialogFlowSample.ccxml",
                    "active": 0,
                    "cumulative": 1,
                    "highWaterMarkHour": 1,
                    "highWaterMarkDay": 1,
                    "highWaterMarkWeek": 1
                },
                {
                    "id": "0x00000014",
                    "name": "DialogFlow_External_TTS_STT",
                    "uri": "file:///bvr_apps/DialogFlowSample.ccxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x0000001F",
                    "name": "Watson Virtual Assistant",
                    "uri": "file:///bvr_apps/VirtualAssistantSample_Watson.vxml",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x1000FFFF",
                    "name": "outbound",
                    "uri": "N/A",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                }
            ],
            "appMappings": [
                {
                    "id": "0x20000000",
                    "mapping": "1001",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000020",
                    "mapping": "watson_virtualassistant",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000002",
                    "mapping": "1000Welcomes",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000023",
                    "mapping": "bwdevdf",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000029",
                    "mapping": "ddv",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x0000000C",
                    "mapping": "recordutterance",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x0000000D",
                    "mapping": "df_virtualassistant",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x0000000E",
                    "mapping": "watson",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x0000000F",
                    "mapping": "weather",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000030",
                    "mapping": "ccxml_nocache_maxage1",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000012",
                    "mapping": "rudtmf",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000032",
                    "mapping": "4444",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000015",
                    "mapping": "dialogflow_ext",
                    "active": 0,
                    "cumulative": 0,
                    "highWaterMarkHour": 0,
                    "highWaterMarkDay": 0,
                    "highWaterMarkWeek": 0
                },
                {
                    "id": "0x00000016",
                    "mapping": "dialogflow",
                    "active": 0,
                    "cumulative": 1,
                    "highWaterMarkHour": 1,
                    "highWaterMarkDay": 1,
                    "highWaterMarkWeek": 1
                }
            ]
        }
    ]
}