SystemInfo API Parameters
|
Parameter |
Type |
Description |
Possible Values |
Notes |
|---|---|---|---|---|
|
currentTimeStamp |
String |
The current time (GMT time) in the following format: YYYY-MM-DDThh:MM:ss.SSZ |
— |
— |
|
deploymentType |
String |
The type of deployment for Cisco Finesse. |
UCCE, UCCX |
— |
|
lastCTIHeartbeatStatus |
String |
The heartbeat request from Finesse server to CTI server. |
success, failure |
Once the heartbeat request is sent, Cisco Finesse waits for the heartbeat confirmation. |
|
lastSuccessCTIHeartbeatTime |
Integer |
The last successful heartbeat time between the Cisco Finesse server and the CTI server. |
— |
— |
|
ctiVersion |
Integer |
The CTI protocol version with which the Cisco Finesse server is connected to the CTI server. |
— |
— |
|
ctiHeartbeatInterval |
Integer |
The heartbeat interval between the Cisco Finesse server and the CTI server in seconds. |
— |
— |
|
ctiTimeInMMode |
Integer |
The total time (in seconds) that the CTI server is in maintenance mode. The time will be negative if the CTI server to which the Finesse server is connected to is not in maintenance mode. |
— |
This parameter is applicable only for Unified CCE deployment versions 12.6(1) or later. |
|
ctiMMode |
String |
Indicates the status of the CTI server in maintenance mode. |
INITIATING: Finesse server accepts the CTI maintenance mode request and waits for the CTI response. IN_PROGRESS: Maintenance mode request is received and accepted by the CTI server. Finesse server is now going to connect to the standby CTI server. |
This parameter is applicable only for Unified CCE deployment versions 12.6(1) or later. |
|
finesseTimeInMMode |
Integer |
The total time (in seconds) that the Cisco Finesse server is in maintenance mode. The time will be negative if the Cisco Finesse server is not in maintenance mode. |
— |
— |
|
finesseMMode |
String |
Indicates the status of the Cisco Finesse server in maintenance mode. |
If there is no value in this field, then maintenance mode is not initiated on this system. IN_PROGRESS: Maintenance mode request is received and accepted by the Cisco Finesse server. Cisco Finesse is waiting for all the agents to be connected to the other side. COMPLETED: All the agents have successfully signed in to the other side. Cisco Finesse shuts down the services. FAILED: The maintenance mode did not complete successfully. |
— |
|
license |
String |
The Unified CCX license. |
STANDARD, ENHANCED, or PREMIUM |
This parameter is blank for Unified CCE deployments. |
|
peripheralId |
String |
The ID of the Unified CCE peripheral to which Cisco Finesse is connected. |
— |
This parameter is blank for Unified CCX deployments. |
|
primaryNode - host |
String |
The hostname or IP address. |
— |
Available for both the nodes. |
|
primaryNode - httpsPort |
String |
Secure port used for Finesse webservices, wesocket, and desktop modules. |
— |
Available for both the nodes. |
|
primaryNode - xmppPort |
String |
Unsecured XMPP port which can be used for custom applications on the agent or supervisor desktops for communication over TCP. |
— |
Available for both the nodes. |
|
primaryNode - xmppSecurePort |
String |
Secure XMPP port which can be used for custom applications on the agent or supervisor desktops for communication over TCP secured by TLS. |
— |
Available for both the nodes. |
|
status |
String |
The state of the Cisco Finesse system. |
IN_SERVICE: The system is in service and usual operations are accepted. OUT_OF_SERVICE: The system is out of service and usual operations result in a 503 Service Unavailable response. |
— |
|
statusReason |
String |
The reason for which Cisco Finesse system is down. |
Possible out-of-service scenarios returned by Cisco Finesse system:
|
This parameter is blank when Finesse system is IN_SERVICE. |
|
systemAuthMode |
String |
Information about the system authentication mode. |
SSO or non-SSO |
Hybrid is for Unified CCE deployment. |
|
timezoneOffset |
Integer |
The difference (in minutes) between the server time and GMT time. |
— |
For example, a value of 300 means the server time is GMT + 5 hours. A value of -300 means the server time is GMT - 5 hours. |
|
uri |
String |
The URI to get a new copy of the SystemInfo object. |
— |
— |
|
xmppDomain |
String |
The XMPP server domain. |
— |
— |
|
xmppPubSubDomain |
String |
The XMPP server pubsub domain. |
— |
— |
|
ctiServers |
Collection |
The list of configured CTI servers for Finesse. |
— |
— |
|
-->ctiServer |
Object |
Information about a configured CTI server. |
— |
— |
|
-->host |
String |
The hostname of the CTI server. |
— |
— |
|
-->connectedDuration |
Integer |
The total time (in seconds) that the Cisco Finesse server has been connected to this particular CTI server. The time will be negative if the Cisco Finesse server is not currently connected to this CTI server. |
— |
— |
|
active |
Boolean |
Indicates whether the Cisco Finesse is connected to the active CTI server. |
true, false |
|