System Information

Overview

This API allows the Agent to get information about the Finesse system - information like time zone, Finesse server, etc.

Pre-requisite

The application must be registered with the Cisco channel.

Sequence Diagram

Message Structure

Data Parameters

Response Parameters

Message Parameters

Sample Request

{
    "channel": "Cisco",
    "topic": "General",
    "subtopic": "GetSystemInfo"
}

Sample Response

{
    "channel": "Cisco",
    "topic": "General",
    "subtopic": "GetSystemInfo",
    "message": 
    {
        "packet": "system",
        "systemInfo": 
        {
            "currentTimestamp": "2022-05-05T07:34:07.188Z",
            "timeDiffSeconds": 6.812,
            "deploymentType": "UCCE",
            "lastCTIHeartbeatStatus": "success",
            "lastSuccessCTIHeartbeatTime": "1651736045266",
            "ctiVersion": "23",
            "ctiHeartbeatInterval": "2",
            "peripheralId": "5000",
            "primaryNode": 
            {
                "host": "fin125com.Acqueonlab.com"
            },
            "secondaryNode": 
            {
                "host": "fin125comb.Acqueonlab.com"
            },
            "status": "IN_SERVICE",
            "systemAuthMode": "NON_SSO",
            "timezoneOffset": "330",
            "uri": "/finesse/api/SystemInfo",
            "xmppDomain": "fin125com.Acqueonlab.com",
            "xmppPubSubDomain": "pubsub.fin125com.Acqueonlab.com"
        }
    }
}