Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Real-Time Data Query/ Real-Time Interfaces for Agents/ Obtaining Agent Operation Details
Updated on 2023-09-27 GMT+08:00
View PDF

Obtaining Agent Operation Details

Scenario

This interface is invoked to query agent operation details.

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/agent/agentoprinfo

In the URL, 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 at 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 message body

Parameter

Type

Mandatory

Description

currentAgentId

Integer

Yes

Agent ID. The value ranges from 0 to 99999.

operateType

Integer

No

Operation type. For details, see Table 1.

beginTime

String

Yes

Statistics start time. The value must be in yyyy-MM-dd HH:mm:ss format. The time in the UTC time zone is used.

The time range must be an integer multiple of 15 minutes, and the time span cannot be greater than 24 hours.

endTime

String

Yes

Statistics end time. The value must be in yyyy-MM-dd HH:mm:ss format. The time in the UTC time zone is used.

The time range must be an integer multiple of 15 minutes, and the time span cannot be greater than 24 hours.

ccId

Integer

No

ID of a call center.

  • In the integration environment, the default value is the value of Call Center ID on the Configuration Center > System Management > CMS System Configuration page after a system administrator signs in to the AICC. If this parameter is empty, the data whose sys_key is default_cc_id and sys_type is cms_system_config in the t_cms_sysparam database table is used.
  • 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.

The operation objects and operation reasons are marked "-", indicating that the agent operation table does not need to be recorded for the corresponding operation types.

Response Message

Table 3 Parameters in the 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 this object in the array, see the following table.
Table 4 Parameters of resultDesc

Parameter

Type

Description

id

String

Configuration ID.

callId

String

Call ID.

phoneNo

String

Agent phone number or conference ID.

subCcNo

Integer

Subsystem ID.

currentAgentId

Integer

ID of an agent.

currentSkillId

Integer

ID of the skill queue to which a call belongs.

mediaType

Integer

Media type. For details, see Description of Call Media Types.

beginTime

String

Start time of the statistics collection operation. The UTC time zone is used.

endTime

String

End time of the statistics collection operation. The UTC time zone is used.

vdn

Integer

ID of the VDN that processes a call.

callType

Integer

Call type. For details, see Description of Call Types.

serviceNo

Integer

Business type ID.

operateType

Integer

Operation type. For details, see Table 1.

operateObject

Integer

Operation object. For details, see Table 1.

operateCause

Integer

Operation reason. For details, see Table 1.

agentType

Integer

Agent type. For details, see Description of Agent Types.

locationId

Integer

Distributed node ID.

logonSn

String

Sign-in SN.

skillInfoSn

String

Index of the skills owned by an agent.

If this field is empty, the agent does not have the task skill. For example, when an agent signs in, this field is empty.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters
    {
    "currentAgentId": 12,
    "operateType": 46,
    "beginTime": "2020-08-22 05:00:00",
    "endTime": "2020-08-23 05:00:00",
    "ccId": 1
}
  • Response parameters
    {
    "resultCode": "0100000",
    "resultDesc": [
        {
            "id": "45648",
            "callId": "5",
            "phoneNo": "05276789",
            "operateType": 46,
            "operateObject": 23,
            "operateCause": 0,
            "agentType": 3,
            "beginTime": "2020-08-22T05:49:36.000+0000",
            "endTime": "2020-08-22T09:49:37.000+0000",
            "callType": 0,
            "vdn": 4,
            "serviceNo": 21,
            "subCcNo": 10,
            "currentAgentId": 12,
            "currentSkillId": 10,
            "mediaType": 10,
            "locationId": null,
            "logonSn": null,
            "skillInfoSn": null
        },
        {
            "id": "45649",
            "callId": "5",
            "phoneNo": "05276789",
            "operateType": 46,
            "operateObject": 23,
            "operateCause": 0,
            "agentType": 3,
            "beginTime": "2020-08-22T05:49:36.000+0000",
            "endTime": "2020-08-22T09:49:37.000+0000",
            "callType": 0,
            "vdn": 4,
            "serviceNo": 21,
            "subCcNo": 10,
            "currentAgentId": 12,
            "currentSkillId": 10,
            "mediaType": 10,
            "locationId": null,
            "logonSn": null,
            "skillInfoSn": null
        }
    ]
}