.png?sv=2022-11-02&spr=https&st=2025-12-27T05%3A38%3A28Z&se=2025-12-27T05%3A48%3A28Z&sr=c&sp=r&sig=c1jOq501QUQ9fkOjNB1PlI6Zy%2FLqgdt9shkdnUXOEyk%3D){kind=logo}
Get APP State
- DarkLight
Get APP State
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API allows the Agent to get the entire application state. For example, Agent state, Call state, Reason Code, etc.
Pre-requisite
The application must be registered with Cisco channel.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Cisco |
topic | Call |
subtopic | GetAppState |
source | «app-name-broadcasting-this-message» |
data | Not Applicable |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
No data parameters |
Response Parameters
Response Parameters | Value |
|---|---|
channel | Cisco |
topic | Call |
subtopic | GetAppState |
message | JSON Object |
Sample Request
{
"channel": "Cisco",
"topic": "General",
"subtopic": "GetAppState"
}Sample Response
{
"channel": "Cisco",
"topic": "General",
"subtopic": "GetAppState",
"message": {
"ctiState": {
"userInfo": {
"extension": "5063",
"password": "arul4",
"username": "834108959",
"ismobileagent": false,
"mobileagentmode": "",
"mobilenumber": ""
},
"State": "RESERVED_OUTBOUND_PREVIEW",
"agentState": "RESERVED_OUTBOUND_PREVIEW",
"makeCall": null,
"rules": {
"SequentialActions": {
"items": {},
"count": 2
},
"ResponseType": 0,
"ResponseText": "Success",
"ResponseActual": {
"user": {
"agentTime": "00:00",
"issupervisor": false,
"dialogs": "/finesse/api/User/834108959/Dialogs",
"extension": "5063",
"firstName": "arul",
"lastName": "4",
"loginId": "834108959",
"loginName": "arul4",
"mediaType": "1",
"roles": [
"Agent"
],
"settings": {
"wrapUpOnIncoming": "NOT_ALLOWED",
"wrapUpOnOutgoing": "NOT_ALLOWED"
},
"state": "RESERVED_OUTBOUND_PREVIEW",
"stateChangeTime": "2022-05-05T11:50:41.836Z",
"teamId": "5004",
"teamName": "RTTeam2",
"uri": "/finesse/api/User/834108959",
"wrapUpTimer": "60",
"teams": [
{
"id": "5004",
"name": "RTTeam2",
"uri": "/finesse/api/User/834108959"
}
]
},
"dialog": {
"fromAddress": "909971300712",
"id": "2130707677",
"mediaProperties": {
"DNIS": "5063",
"callType": "OUTBOUND_PREVIEW",
"dialedNumber": "5063",
"callvariables": {},
"eccvariables": {},
"queueNumber": "6534",
"queueName": "arulsk1",
"callKeyCallId": "342",
"callKeyPrefix": "153891",
"callKeySequenceNum": "1"
},
"mediaType": "Voice",
"participants": {
"participant": [
{
"actions": [
"UPDATE_CALL_DATA",
"ACCEPT",
"REJECT",
"CLOSE"
],
"mediaAddress": "5063",
"mediaAddressType": "AGENT_DEVICE",
"startTime": "2022-05-05T11:50:41.843Z",
"state": "ACTIVE",
"stateChangeTime": "2022-05-05T11:50:41.843Z"
}
]
},
"state": "ACTIVE",
"toAddress": "5063",
"uri": "/finesse/api/Dialog/2130707677",
"CallState": "ACTIVE",
"CallStartTime": "2022-05-05T11:50:41.843Z",
"CurrentStateTime": "2022-05-05T11:50:41.843Z",
"Type": "outbound",
"isDialerCall": true
}
},
"deploymentType": "",
"state": "RESERVED_OUTBOUND_PREVIEW",
"ActionsAllowed": {
"items": {
"AxnSetReady": null,
"AxnSetNotReady": {
"VariableName": "NotReadyReasonCode",
"VariableType": 1,
"VariableStructure": ""
}
},
"count": 2
},
"ButtonStates": {
"items": {
"Ready": "Enable",
"NotReady": "Enable"
},
"count": 2
}
},
"phoneBook": [
{
"name": "TestShiva",
"type": "GLOBAL",
"uri": "/finesse/api/PhoneBook/1",
"contacts": [
{
"firstName": "kathy",
"lastName": "kathy",
"phoneNumber": "5054",
"description": "Kathy jabber extn",
"uri": "/finesse/api/PhoneBook/1/Contact/1"
},
{
"firstName": "joseph",
"lastName": "jabber",
"phoneNumber": "5055",
"description": "josephjabber extnsion number",
"uri": "/finesse/api/PhoneBook/1/Contact/2"
},
{
"firstName": "kk",
"lastName": "wrong",
"phoneNumber": "1234",
"description": "invalid",
"uri": "/finesse/api/PhoneBook/1/Contact/3"
},
{
"firstName": "mazi",
"lastName": "sk",
"phoneNumber": "99381604019",
"description": "ph.no",
"uri": "/finesse/api/PhoneBook/1/Contact/4"
},
{
"firstName": "jdjjhsajhdjkskdfjilsjdlfjsflkdjfk",
"lastName": "bjjuhkhkhutyttruyyujnhjdfswseeuijknjbgcfdxrdtfgyhbhbbugygcvhhuhy",
"phoneNumber": "18878473732843789g89876866657",
"description": "lenghty characters ",
"uri": "/finesse/api/PhoneBook/1/Contact/5"
}
]
}
],
"NotReadyReasonCodes": [
{
"uri": "/finesse/api/ReasonCode/28",
"category": "NOT_READY",
"code": "3276",
"label": "Meeting",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/49",
"category": "NOT_READY",
"code": "5136",
"label": "Tea Break lengthy Not ready reason code",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/41",
"category": "NOT_READY",
"code": "6317",
"label": "Coffee 5",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/46",
"category": "NOT_READY",
"code": "14375",
"label": "Coffee 10",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/34",
"category": "NOT_READY",
"code": "18521",
"label": "Townhall",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/51",
"category": "NOT_READY",
"code": "19998",
"label": "Tea 2",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/26",
"category": "NOT_READY",
"code": "25243",
"label": "Tea break",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/52",
"category": "NOT_READY",
"code": "25726",
"label": "Tea 3",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/45",
"category": "NOT_READY",
"code": "25961",
"label": "Coffee 9",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/37",
"category": "NOT_READY",
"code": "27527",
"label": "Coffee 1",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/39",
"category": "NOT_READY",
"code": "32459",
"label": "Coffee 3",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/43",
"category": "NOT_READY",
"code": "33287",
"label": "Coffee 7",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/42",
"category": "NOT_READY",
"code": "33352",
"label": "Coffee 6",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/40",
"category": "NOT_READY",
"code": "34588",
"label": "Coffee 4",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/50",
"category": "NOT_READY",
"code": "35314",
"label": "Tea 1",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/44",
"category": "NOT_READY",
"code": "47712",
"label": "Coffee 8",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/29",
"category": "NOT_READY",
"code": "49433",
"label": "Coffee Break",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/53",
"category": "NOT_READY",
"code": "52163",
"label": "Break",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/38",
"category": "NOT_READY",
"code": "58361",
"label": "Coffee 2",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/27",
"category": "NOT_READY",
"code": "61028",
"label": "Lunch Break",
"forAll": "true",
"systemCode": "false"
}
],
"LogOutReasonCodes": [
{
"uri": "/finesse/api/ReasonCode/31",
"category": "LOGOUT",
"code": "8673",
"label": "EOS",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/35",
"category": "LOGOUT",
"code": "11256",
"label": "NaltualCalamity",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/30",
"category": "LOGOUT",
"code": "35596",
"label": "Emergency",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/32",
"category": "LOGOUT",
"code": "38799",
"label": "Townhall",
"forAll": "true",
"systemCode": "false"
},
{
"uri": "/finesse/api/ReasonCode/33",
"category": "LOGOUT",
"code": "64828",
"label": "System Failure",
"forAll": "true",
"systemCode": "false"
}
],
"wrapupReasonCodes": [
{
"uri": "/finesse/api/User/834108959/WrapUpReason/1",
"label": "Inprogress",
"forAll": "true"
},
{
"uri": "/finesse/api/User/834108959/WrapUpReason/2",
"label": "Completed",
"forAll": "true"
},
{
"uri": "/finesse/api/User/834108959/WrapUpReason/3",
"label": "Pending",
"forAll": "true"
},
{
"uri": "/finesse/api/User/834108959/WrapUpReason/4",
"label": "Clerical work",
"forAll": "true"
},
{
"uri": "/finesse/api/User/834108959/WrapUpReason/5",
"label": "DataEntry",
"forAll": "true"
}
],
"mrdList": [],
"failReason": "",
"callsInfo": {
"ids": [
"2130707677"
],
"calls": {
"2130707677": {
"ButtonStates": {
"items": {
"UpdateCallData": "Enable",
"Accept": "Enable",
"Reject": "Enable",
"Close": "Enable"
},
"count": 4
},
"ActionsAllowed": {
"items": {
"SetUPDATE_CALL_DATA": {
"VariableName": "UpdateCallData",
"ButtonName": "UpdateCallData",
"VariableType": 3,
"VariableStructure": {
"callID": "",
"label": ""
}
},
"SetACCEPT": {
"VariableName": "Accept",
"ButtonName": "Accept",
"VariableType": 3,
"VariableStructure": {
"callID": "",
"extn": ""
}
},
"SetREJECT": {
"VariableName": "Reject",
"ButtonName": "Reject",
"VariableType": 3,
"VariableStructure": {
"callID": "",
"extn": ""
}
},
"SetCLOSE": {
"VariableName": "Close",
"ButtonName": "Close",
"VariableType": 3,
"VariableStructure": {
"callID": "",
"extn": ""
}
}
},
"count": 4
},
"ResponseType": 0,
"ResponseText": "Success",
"ResponseActual": {
"dialog": {
"fromAddress": "909971300712",
"id": "2130707677",
"mediaProperties": {
"DNIS": "5063",
"callType": "OUTBOUND_PREVIEW",
"dialedNumber": "5063",
"callvariables": {},
"eccvariables": {},
"queueNumber": "6534",
"queueName": "arulsk1",
"callKeyCallId": "342",
"callKeyPrefix": "153891",
"callKeySequenceNum": "1"
},
"mediaType": "Voice",
"participants": {
"participant": [
{
"actions": [
"UPDATE_CALL_DATA",
"ACCEPT",
"REJECT",
"CLOSE"
],
"mediaAddress": "5063",
"mediaAddressType": "AGENT_DEVICE",
"startTime": "2022-05-05T11:50:41.843Z",
"state": "ACTIVE",
"stateChangeTime": "2022-05-05T11:50:41.843Z"
}
]
},
"state": "ACTIVE",
"toAddress": "5063",
"uri": "/finesse/api/Dialog/2130707677",
"CallState": "ACTIVE",
"CallStartTime": "2022-05-05T11:50:41.843Z",
"CurrentStateTime": "2022-05-05T11:50:41.843Z",
"Type": "outbound",
"isDialerCall": true
},
"user": {
"extension": "5063",
"password": "arul4",
"username": "834108959",
"ismobileagent": false,
"mobileagentmode": "",
"mobilenumber": ""
},
"systeminfo": {
"currentTimestamp": "2022-05-05T11:21:40.878Z",
"timeDiffSeconds": 8.122,
"deploymentType": "UCCE",
"lastCTIHeartbeatStatus": "success",
"lastSuccessCTIHeartbeatTime": "1651749699266",
"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"
},
"userPacket": {
"agentTime": "00:00",
"issupervisor": false,
"dialogs": "/finesse/api/User/834108959/Dialogs",
"extension": "5063",
"firstName": "arul",
"lastName": "4",
"loginId": "834108959",
"loginName": "arul4",
"mediaType": "1",
"roles": [
"Agent"
],
"settings": {
"wrapUpOnIncoming": "NOT_ALLOWED",
"wrapUpOnOutgoing": "NOT_ALLOWED"
},
"state": "RESERVED_OUTBOUND_PREVIEW",
"stateChangeTime": "2022-05-05T11:50:41.836Z",
"teamId": "5004",
"teamName": "RTTeam2",
"uri": "/finesse/api/User/834108959",
"wrapUpTimer": "60",
"teams": [
{
"id": "5004",
"name": "RTTeam2",
"uri": "/finesse/api/User/834108959"
}
]
}
},
"CallVariables": {
"callVariable1": "",
"callVariable2": "",
"callVariable3": "",
"callVariable4": "",
"callVariable5": "",
"callVariable6": "",
"callVariable7": "",
"callVariable8": "",
"callVariable9": "",
"callVariable10": "",
"BAResponse": "",
"BADialedListID": "166",
"BATimeZone": "-00480",
"BAStatus": "PREVIEW_OUTBOUND_RESERVATION",
"BABuddyName": "uccx3.7,vivek",
"BAAccountNumber": "47|2|18|1|0|44|1",
"BACampaign": "arul1"
},
"ExtendedCallVariables": {},
"ResponseFields": {
"user": {
"extension": "5063",
"password": "arul4",
"username": "834108959",
"ismobileagent": false,
"mobileagentmode": "",
"mobilenumber": ""
},
"Participants": {
"participant": [
{
"actions": [
"UPDATE_CALL_DATA",
"ACCEPT",
"REJECT",
"CLOSE"
],
"mediaAddress": "5063",
"mediaAddressType": "AGENT_DEVICE",
"startTime": "2022-05-05T11:50:41.843Z",
"state": "ACTIVE",
"stateChangeTime": "2022-05-05T11:50:41.843Z"
}
]
},
"MediaProperties": {
"DNIS": "5063",
"callType": "OUTBOUND_PREVIEW",
"dialedNumber": "5063",
"callvariables": {},
"eccvariables": {},
"queueNumber": "6534",
"queueName": "arulsk1",
"callKeyCallId": "342",
"callKeyPrefix": "153891",
"callKeySequenceNum": "1"
},
"fromAddress": "909971300712",
"mediaType": "Voice",
"toAddress": "5063",
"CallState": "ACTIVE",
"Type": "outbound",
"isDialerCall": true,
"CallType": "OUTBOUND_PREVIEW",
"CallStartTime": "2022-05-05T11:50:41.843Z",
"CurrentStateTime": "2022-05-05T11:50:41.843Z",
"Campaign": "arul1",
"BAStatus": "PREVIEW_OUTBOUND_RESERVATION",
"DN": "5063",
"CallDurationInSec": 3,
"StateDuration": "00:03",
"LocaleStartTime": "5/5/2022 5:20:49 PM",
"CallOrginLocaleDate": "05-May-2022",
"CallOrginLocaleDateF1": "05/05/2022",
"CallOrginLocaleDateF2": "05/05/2022",
"CallOrginLocaleDateF3": "2022-05-05",
"id": "2130707677",
"CurrentStateDuration": "00:03",
"LocaleLastStateTime": "5/5/2022 5:20:49 PM",
"OutBoundType": "PREVIEW"
},
"id": "2130707677",
"event": "ACTIVE",
"CallType": "PREVIEW_OUTBOUND_RESERVATION",
"User": {
"UserId": "834108959",
"Extension": "5063",
"UserType": "Agent"
}
}
}
},
"agent": {
"agentTime": "00:00",
"issupervisor": false,
"dialogs": "/finesse/api/User/834108959/Dialogs",
"extension": "5063",
"firstName": "arul",
"lastName": "4",
"loginId": "834108959",
"loginName": "arul4",
"mediaType": "1",
"roles": [
"Agent"
],
"settings": {
"wrapUpOnIncoming": "NOT_ALLOWED",
"wrapUpOnOutgoing": "NOT_ALLOWED"
},
"state": "RESERVED_OUTBOUND_PREVIEW",
"stateChangeTime": "2022-05-05T11:50:41.836Z",
"teamId": "5004",
"teamName": "RTTeam2",
"uri": "/finesse/api/User/834108959",
"wrapUpTimer": "60",
"teams": [
{
"id": "5004",
"name": "RTTeam2",
"uri": "/finesse/api/User/834108959"
}
]
},
"teamUser": {
"ids": [],
"users": {}
},
"error": {},
"validationerror": "",
"systemInfo": {
"currentTimestamp": "2022-05-05T11:21:40.878Z",
"timeDiffSeconds": 8.122,
"deploymentType": "UCCE",
"lastCTIHeartbeatStatus": "success",
"lastSuccessCTIHeartbeatTime": "1651749699266",
"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"
}, "connectionStatus": "connected",
"wrapInfo": {
"wrapup": {}
},
"reclassifyInfo": {
"reclassify": {}
},
"callbackInfo": {
"callback": {}
},
"nextAgentAction": null,
"nextCallAction": null,
"authMode": {
"authMode": "SSO"
},
"ssoValidateResponse": {},
"isLoggedIn": true,
"loginId": "arul4",
"isLoginProcess": false,
"isLogoutInitiated": false,
"queues": {
"ids": [],
"queues": {}
}
}
}
}Was this article helpful?