UCCX Report Server Resource
- Trip Gilman
The UCCX Report Server resource provides access to UCCX specific reports. This resource is only available from the UCCX Processor Service. This resource has a resource type of "com.openmethods.iserver.processor.reporting.uccx".
UCCX Report Server Resource Messages
All reports are available through a single request. The "command" property of request identifies the name of the report being requested. The "data" property carries any report specific information that is needed to execute the report.Â
Report Requests
report.calljourney
The call journey report provides information about what devices a call has touched and the time spent during each step of the journey.
Request
{
"command": "report.calljourney",
"data":
{
"CallId" : "<uccx id for call>"
}
}
Success Response
{
"command": "report.calljourney",
"result": "success",
"data" :
{
     "CallJourney" :
[
{
"CallId" : "<source call id>",
"Device" : "<device id>",
"DeviceType" : "<device type>",
"Description" : "<description>",
"Duration" : "<formatted time value>"
},
…
]
}
}
Failure Response
{
"command": "report.calljourney",
"result": "failure",
"failure":
{
"code": "<error-code-for-failure>",
"message": "<error-message>",
"context": "<stack-trace-if-applicable>"
}
"original":
<Contains the original request JSON structure>
}
report.teamstatus.begin
The team based agent status report provides agent status information for all UCCX team members.
Request
{
"command": "report.teamstatus.begin",
"data":
{
"agentId" : "<uccx id for agent>"
}
}
Success Response
{
"command": "report.teamstatus.begin",
"result": "success",
"data" :
{
}
}
Failure Response
{
"command": "report.teamstatus.begin",
"result": "failure",
"failure":
{
"code": "<error-code-for-failure>",
"message": "<error-message>",
"context": "<stack-trace-if-applicable>"
}
"original":
<Contains the original request JSON structure>
}
report.teamstatus.end
The team based agent status report provides agent status information for all UCCX team members.
Request
{
"command": "report.teamstatus.end",
"data":
{
"agentId" : "<uccx id for agent>"
}
}
Success Response
{
"command": "report.teamstatus.end",
"result": "success",
"data" :
{
}
}
Failure Response
{
"command": "report.teamstatus.end",
"result": "failure",
"failure":
{
"code": "<error-code-for-failure>",
"message": "<error-message>",
"context": "<stack-trace-if-applicable>"
}
"original":
<Contains the original request JSON structure>
}
Report Events
report.teamstatus.teamchanged
Indicates that the team name has changed.
{
"name": "report.teamstatus.teamchanged",
"data":
{
"agentId": "<uccx id of agent>",
"team":
{
"teamId": "<uccx id for team>",
"teamName": "<name for team>"
}
}
}
report.teamstatus.teamremoved
Indicates that the agent has been removed from a team or that the team has been completely removed from uccx.
{
"name": "report.teamstatus.teamremoved",
"data":
{
"agentId": "<uccx id of agent>",
"team":
{
"teamId": "<uccx id for team>",
"teamName": "<name for team>"
}
}
}
report.teamstatus.teamadded
Indicates that the agent has been added to a new team.
{
"name": "report.teamstatus.teamadded",
"data":
{
"agentId": "<uccx id of agent>",
"team":
{
"teamId": "<uccx id for team>",
"teamName": "<name for team>",
"members":
[
{
"memberId": "<uccx id for team member>",
"memberType": <"Agent" | "Supervisor" | "TeamLead">,
"memberName": "<uccx name for member>",
"status": <"ready" | "not_ready" | "ACW">,
"reason": "<uccx reason code>"
},
…
]
}
}
}
report.teamstatus.memberadded
Indicates that one or more team members were added to a team.
{
"name": "report.teamstatus.memberadded",
"data":
{
"agentId": "<uccx id of agent>",
"team":
{
"teamId": "<uccx id for team>",
"teamName": "<name for team>",
"members":
[
{
"memberId": "<uccx id for team member>",
"memberType": <"Agent" | "Supervisor" | "TeamLead">,
"memberName": "<uccx name for member>",
"status": <"ready" | "not_ready" | "ACW">,
"reason": "<uccx reason code>"
},
…
]
}
}
}
report.teamstatus.memberstatuschanged
Indicates that one or more team members' status has changed.
{
"name": "report.teamstatus.memberstatuschanged",
"data":
{
"agentId": "<uccx id of agent>",
"team":
{
"teamId": "<uccx id for team>",
"teamName": "<name for team>",
"members":
[
{
"memberId": "<uccx id for team member>",
"memberType": <"Agent" | "Supervisor" | "TeamLead">,
"memberName": "<uccx name for member>",
"status": <"ready" | "not_ready" | "ACW">,
"reason": "<uccx reason code>"
},
…
]
}
}
}
report.teamstatus.memberremoved
Indicates that one or more team members have been removed from the team.
{
"name": "report.teamstatus.memberremoved",
"data":
{
"agentId": "<uccx id of agent>",
"team":
{
"teamId": "<uccx id for team>",
"teamName": "<name for team>",
"members":
[
{
"memberId": "<uccx id for team member>"
},
…
]
}
}
}
This document may contain confidential and/or privileged information belonging to OpenMethods. If you are not the intended recipient (or have received this document in error) please notify the sender immediately and destroy this document. Any unauthorized copying, disclosure, or distribution of the material in this document is strictly forbidden.