Querying the Current License Usage in the System

Scenario

This interface is invoked to query the current license usage in the system. (CTI 3.6 does not support this interface.)

Interface Method

The request method must be set to POST. This interface supports only the POST method.

Internal Encapsulation Interface

BMS interface: /ccbms/ws/monitor/querysystemlicensestatus

Request URL

https://ip:port/rest/cmsapp/v1/openapi/configures/querysystemlicensestatus

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.

Request Description

**Table 1** Parameters in the request header
No.	Parameter	Value Type	Mandatory	Description
1	Content-Type	String	Yes	The value is fixed at application/json; charset=UTF-8.
2	Authorization	String	Yes	For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

**Table 2** Parameters in the request message body
No.	Parameter	Value Type	Mandatory	Description
1	ccId	Integer	Yes	ID of a call center. The value ranges from 1 to 65535.

Response Description

**Table 3** Parameters in the response message body
No.	Parameter	Value Type	Description
1	result	String	Query result. The options are as follows: 0: success Other values: failure For details about the failure causes, see Error Code Reference. NOTE: This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.
2	resultCode	String	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
3	resultDatas	object	Object array in the returned result after a successful query. For details about the parameters of the object in this array, see Table 4. NOTE: This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.
4	resultDesc	Object	Object in the returned result after a successful query. For details about the parameters of the object in this array, see Table 4.

**Table 4** Parameters of resultDesc/resultDatas
No.	Parameter	Value Type	Description
2.1	licenseMaxAgentNum	Long	Maximum number of sign-in agents supported by the license
2.2	licenseMaxVideoAgentNum	Long	Maximum number of sign-in video agents supported by the license
2.3	licenseMaxVdnNum	Long	Maximum number of VDNs supported by the license
2.4	licenseMaxIvrCallNum	Long	Maximum number of automatic business calls supported by the license
2.5	licenseMaxVoiceCallNum	Long	Maximum number of voice calls supported by the license
2.6	licenseMaxWebCallNum	Long	Maximum number of web calls supported by the license
2.7	loginAgentNum	Long	Number of currently signed-in agents
2.8	loginVideoAgentNum	Long	Number of currently signed-in video agents
2.9	vdnNum	Long	Number of VDNs that are currently configured.
2.10	ivrCallNum	Long	Number of current automatic business calls.
2.11	voiceCallNum	Long	Number of current voice calls.
2.12	webCallNum	Long	Number of current web calls.
2.13	historyMaxAgentNum	Long	Maximum number of sign-in agents in history.
2.14	historyMaxVideoAgentNum	Long	Maximum number of sign-in video agents in history.
2.15	historyMaxIvrCallNum	Long	Maximum number of automatic business calls in history.
2.16	historyMaxVoiceCallNum	Long	Maximum number of voice calls in history.
2.17	historyMaxWebCallNum	Long	Maximum number of web calls in history.
2.18	licenseStartDate	Long	License start time.
2.19	licenseEndDate	Long	License expiration time.

Message Example

Request header

Content-Type: application/json;charset=UTF-8
Authorization: ******************

Request parameters
```
{
    "ccId":1
}
```

Response parameters

{
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": {
        "licenseMaxAgentNum": 4,
        "licenseMaxVideoAgentNum": 4294967295,
        "licenseMaxVdnNum": 10,
        "licenseMaxIvrCallNum": 4,
        "licenseMaxVoiceCallNum": 6,
        "licenseMaxWebCallNum": 4294967295,
        "loginAgentNum": 1,
        "loginVideoAgentNum": 4294967295,
        "vdnNum": 1,
        "ivrCallNum": 0,
        "voiceCallNum": 1,
        "webCallNum": 4294967295,
        "historyMaxAgentNum": 4294967295,
        "historyMaxVideoAgentNum": 4294967295,
        "historyMaxIvrCallNum": 4294967295,
        "historyMaxVoiceCallNum": 4294967295,
        "historyMaxWebCallNum": 4294967295,
        "licenseStartDate": 0,
        "licenseEndDate": 0
    },
    "resultDesc": {
        "licenseMaxAgentNum": 4,
        "licenseMaxVideoAgentNum": 4294967295,
        "licenseMaxVdnNum": 10,
        "licenseMaxIvrCallNum": 4,
        "licenseMaxVoiceCallNum": 6,
        "licenseMaxWebCallNum": 4294967295,
        "loginAgentNum": 1,
        "loginVideoAgentNum": 4294967295,
        "vdnNum": 1,
        "ivrCallNum": 0,
        "voiceCallNum": 1,
        "webCallNum": 4294967295,
        "historyMaxAgentNum": 4294967295,
        "historyMaxVideoAgentNum": 4294967295,
        "historyMaxIvrCallNum": 4294967295,
        "historyMaxVoiceCallNum": 4294967295,
        "historyMaxWebCallNum": 4294967295,
        "licenseStartDate": 0,
        "licenseEndDate": 0
    }
}

Parent topic: Interfaces for Querying System Indicators

Previous topic: Querying the Time of the CTI Platform Server

Next topic: Checking Cluster Health Status