Querying UAP Performance Information

Updated on 2023-12-19 GMT+08:00

View PDF

Prerequisites

You need to create the Incoming Office measurement task on the performance management tool. For details, see "Maintenance > Performance Specifications" in UAP9600 Product Documentation. This interface is invoked only for global AK/SK authentication.

Note: This interface supports only the independent deployment environment.

Description

This interface is invoked to query the performance data of the UAP in the latest 5 minutes, including the trunk usage information, such as the number of idle circuits, number of available circuits, and circuit usage.

Interface Method

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

Request URL

https://ip:port/rest/cmsapp/v1/openapi/uap/queryUapPerfInfo

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	Type	Mandatory	Description
1	Content-Type	String	Yes	The value is fixed to 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
Parameter	Type	Mandatory	Description
ofcNo	Array	No	Array of inbound numbers. If the array is null, all inbound numbers are queried. You can run the MML command LST OFC to obtain the inbound numbers.
ccId	Integer	No	ID of a call center. In the independent deployment environment, the default value is the value of Default Call Center ID on the Configuration Center > System Management > Parameter Settings page after a system administrator signs in to the AICC.

Response Message

**Table 3** Parameters in the response message body
Parameter	Type	Description
resultCode	String	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
resultDesc	List	Object list in the returned result after a successful query. For details about the parameters of the object, see the following table.
10.xx.xx.xx#0	String	10.xx.xx.xx: UAP IP address. #: fixed separator. 0: UAP ID.

**Table 4** Parameters of resultDesc
Parameter	Type	Description
RET	String	End time of data collection.
RNAT12	String	No answer times.
busy circuits (TIMES)	String	Number of busy circuits.
ASD32	String	Average occupation duration, in seconds.
ITAR19	String	Incoming trunk available ratio.
CLBT40	String	The called party (local call) is busy.
MEID	String	Device ID.
UBC43	String	Number of blocked circuits.
CCT34	String	Number of failed calls due to congestion at the peer end.
LCOICT7	String	Call loss due to home office internal congestion.
IOCS44	String	Inbound CAPS value.
MOIID	String	Measurement object ID.
CCT3	String	Number of connected calls.
CDA9	String	Congestion duration auxiliary quantity.
AART11	String	Number of calls released before ringing, that is, the number of times that the calling party hangs up before the calls are connected or ended.
TAT6	String	Number of answered transfer calls. An answered transfer call indicates that the user who answers the call is not a local user.
Period	String	Period.
TCAT5	String	Intra-office answer times. Intra-office answer indicates that a user who answers the call is a local user.
AR21	String	Answer rate.
TCAT2	String	Times of transfer seizure attempts.
TCAT1	String	Times of intra-office seizure attempts.
ICN13	String	Number of installed circuits.
ECT35	String	Number of times that an unallocated number is dialed.
incoming direction	String	0(anonymous): 0 indicates an inbound call ID, and anonymous indicates a call name.
IBCN16	String	Number of installed bi-directional circuits.
ACN14	String	Number of available circuits.
TCT42	String	Transferring call seizure times.
IAT36	String	Invalid address times.
Credible	String	Trusted or not.
CFORT39	String	The caller party does not have permission.
RT	String	Time of data collection.
ST26	String	Seized call traffic volume.
Time	String	Count.
average answer duration (SECOND)	String	Average connection duration.
AT30	String	Answered call traffic.
TUT37	String	Terminal incompatibility times.
BCN15	String	Number of blocked circuits.
BBCR23	String	Bi-directional circuit block ratio.
CTBT41	String	Toll busy times of the called party.
BTST24	String	Traffic occupied by a bi-directional trunk.
BTSTA25	String	Traffic auxiliary quantity occupied by a bi-directional trunk.
ABCN17	String	Number of available bi-directional circuits.
CTA29	String	Connection traffic auxiliary quantity.
AT4	String	Number of answered calls.
EROC46	String	Circuit usage.
TET38	String	Terminal error times.
CT28	String	Connected call traffic.
SOIC45	String	Number of idle circuits.
ST0	String	Seizure times.
BCR22	String	Block ratio.
ABRT33	String	Abandon times before ringing.
CR20	String	Connection rate.
BBCN18	String	Number of blocked bi-directional circuits.
CD8	String	Congestion duration.
ATA31	String	Answering traffic auxiliary quantity.
CBT10	String	Busy called party.
STA27	String	Seized traffic auxiliary quantity.
average connection duration (MILLISECOND)	String	Average connection duration.
answer duration aux (TIMES)	String	Total duration auxiliary quantity of answered sessions.

Message Example

Request header

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

Request parameters
```
{
    "ofcNo": [0,1],
    "ccId": 1
}
```

Response parameters

{
    "resultCode": "0100000",
    "resultDesc": {
      "10.xx.xx.xx#0": [
        {
            "RET": "2021-02-04 10:05:00 +00:00",
            "RNAT12": "0",
            "busy circuits (TIMES)": "0",
            "ASD32": "0.000000",
            "ITAR19": "0.000000",
            "CLBT40": "-1",
            "MEID": "5",
            "UBC43": "-1",
            "CCT34": "-1",
            "LCOICT7": "0",
            "IOCS44": "0",
            "MOIID": "0",
            "CCT3": "0",
            "CDA9": "-1",
            "AART11": "0",
            "TAT6": "0",
            "Period": "5",
            "TCAT5": "0",
            "AR21": "0.000000",
            "TCAT2": "0",
            "TCAT1": "0",
            "ICN13": "0",
            "ECT35": "0",
            "incoming direction": "0(anonymous)",
            "IBCN16": "0",
            "ACN14": "0",
            "TCT42": "-1",
            "IAT36": "0",
            "Credible": "Credible",
            "CFORT39": "-1",
            "RT": "2021-02-04 10:00:00 +00:00",
            "ST26": "0.000000",
            "Time": "1000",
            "average answer duration (SECOND)": "0",
            "AT30": "0.000000",
            "TUT37": "-1",
            "BCN15": "0",
            "BBCR23": "0.000000",
            "CTBT41": "-1",
            "BTST24": "0.000000",
            "BTSTA25": "-1",
            "ABCN17": "0",
            "CTA29": "-1",
            "AT4": "0",
            "EROC46": "0.000000",
            "TET38": "-1",
            "CT28": "0.000000",
            "SOIC45": "0",
            "ST0": "0",
            "BCR22": "0.000000",
            "ABRT33": "0",
            "CR20": "0.000000",
            "BBCN18": "0",
            "CD8": "0",
            "ATA31": "-1",
            "CBT10": "0",
            "STA27": "-1",
            "average connection duration (MILLISECOND)": "0",
            "answer duration aux (TIMES)": "-1"
        }
    ]
    }
}

Parent topic: Interfaces for Querying System Indicators

Previous topic: Interfaces for Querying System Indicators

Next topic: Querying Key Information About Control Blocks