Updated on 2023-12-19 GMT+08:00

Collecting Statistics on Result Sets in Daily Settlement Table for Inbound Calls

Scenario

This interface is invoked to collect statistics on result sets in the daily settlement table for inbound calls based on conditions.

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/callinday/querymanualindexesbycondition

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.In a non–public cloud environment where the NSLB service is configured, 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

calleeNos

Array

Yes

Array of called numbers. The statistics are collected for each number in the array. The called number consists of only digits.

The array size is up to 1000.

beginLogDay

String

Yes

Start call time for statistics collection. The value must be in the yyyy-MM-dd format and in the time zone of the VDN.

endLogDay

String

Yes

End call time for statistics collection. The value must be in the yyyy-MM-dd format and in the time zone of the VDN.

callTypes

Array

Yes

Call type array of the integer type. Statistics are collected based on each type in the array. The call type is only the digit.

The array size is up to 1000.

skillIds

Array

No

Skill queue IDs. An array of integers. Statistics are collected by type in the array.

The array size is up to 1000.

subCcNo

Integer

Either this parameter or tenantId must be set.

Subsystem number.

vdn

Integer

Either this parameter or tenantId must be set.

ID of a VDN.

tenantId

String

Either this parameter or subCcNo (or vdn) must be set.

Tenant ID.

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.

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

Array

Object in the returned result after a successful query.

For details about the parameters of this object, see Table 4.

Table 4 Parameters of resultDesc

Parameter

Type

Description

beginLogDay

String

Start call time, which is the same as the input parameter.

endLogDay

String

End call time, which is the same as the input parameter.

calleeNo

String

Called number.

callType

Integer

Call type.

vdn

Integer

ID of a VDN.

serviceNo

Integer

Business type.

orgCcNo

Integer

Subsystem number of the original call center.

subCcNo

Integer

Subsystem number.

serCcNo

Integer

Subsystem number of the service party.

currentAgentId

Integer

Agent ID.

Agent ID in the last CDR of a call, which is not recommended for indicator settlement.

currentSkillId

Integer

Skill queue ID.

Skill queue ID in the last CDR of a call, which is not recommended for indicator settlement.

failQueueWaitNum

Integer

Number of waits for lost calls.

failQueueWaitTime

Integer

Waiting duration of lost calls, in seconds.

waitAnsNum

Integer

Number of calls that are waiting for answers.

waitAnsTime

Integer

Ring duration, in seconds.

succWaitAnsTime

Integer

Duration of waiting for the answer in a successful call, in seconds.

noAckNum

Integer

Number of calls that are not answered.

succQueueWaitTime

Integer

Queuing duration of a successful call, in seconds.

succQueueWaitNum

Integer

Number of queuing times for a successful call.

queOverToIvrNum

Integer

Number of hang-up calls transferred from a queue to the IVR.

queOverToIvrTime

Integer

Total hang-up duration for transferring calls from a queue to the IVR, in seconds.

hangUpNum

Integer

Number of manual-to-IVR calls.

hangUpTime

Integer

Total duration of manual-to-IVR calls.

hangUpReleaseNum

Integer

Number of hang-up calls that are transferred from the manul service to the IVR.

inOccupyNum

Integer

Number of manual requests.

inCallSuccNum

Integer

Number of manual calls.

inCallTime

Integer

Manual call duration, in seconds.

maxQueueWaitTime

Integer

Maximum queuing duration, in seconds.

minQueueWaitTime

Integer

Minimum queuing duration, in seconds.

maxWaitAnsTime

Integer

Maximum ring duration, in seconds.

minWaitAnsTime

Integer

Minimum ring duration, in seconds.

maxCallTime

Integer

Maximum call duration, in seconds.

minCallTime

Integer

Minimum call duration, in seconds.

succAckTimeLt3

Integer

Number of successful calls that are answered within 3 seconds.

callTimeLt3

Integer

Number of successful calls whose call duration is shorter than 3 seconds.

failTimeLt3

Integer

Number of failed calls whose waiting duration is shorter than 3 seconds.

succAckTimeLt5

Integer

Number of successful calls that are answered within 5 seconds.

callTimeLt5

Integer

Number of successful calls whose call duration is shorter than 5 seconds.

failTimeLt5

Integer

Number of failed calls whose waiting duration is shorter than 5 seconds.

succAckTimeLt10

Integer

Number of successful calls that are answered within 10 seconds.

callTimeLt10

Integer

Number of successful calls whose call duration is shorter than 10 seconds.

failTimeLt10

Integer

Number of failed calls whose waiting duration is shorter than 10 seconds.

succAckTimeLt30

Integer

Number of successful calls that are answered within 30 seconds.

callTimeLt30

Integer

Number of successful calls whose call duration is shorter than 30 seconds.

failTimeLt30

Integer

Number of failed calls whose waiting duration is shorter than 30 seconds.

succAckTimeLt60

Integer

Number of successful calls that are answered within 60 seconds.

callTimeLt60

Integer

Number of successful calls whose call duration is shorter than 60 seconds.

failTimeLt60

Integer

Number of failed calls whose waiting duration is shorter than 60 seconds.

succAckTimeGt10

Integer

Number of successful calls that are answered after 10 seconds.

callTimeGt10

Integer

Number of successful calls whose call duration is longer than 10 seconds.

failTimeGt10

Integer

Number of failed calls whose waiting duration is longer than 10 seconds.

succAckTimeGt60

Integer

Number of successful calls that are answered after 60 seconds.

callTimeGt60

Integer

Number of successful calls whose call duration is longer than 60 seconds.

failTimeGt60

Integer

Number of failed calls whose waiting duration is longer than 60 seconds.

minIvrCallTime

Integer

Minimum IVR call duration, in seconds.

agentToQueueNum

Integer

Number of manual-to-queue calls.

inVdnTime

Integer

Total duration of VDN occupation by inbound calls, in seconds.

succWaitAnsNum

Integer

Number of successful call responses.

ivrOccupyNum

Integer

Number of IVR inbound call requests.

autoUserAbandonNum

Integer

Number of calls that are hung up by users during IVR voice playing.

autoAnsTime

Integer

System-level IVR inbound call ringing duration, in seconds.

ivrOnlySuccNum

Integer

Number of successful calls that are connected using only the IVR.

autoCallSuccNum

Integer

Number of system-level IVR calls.

maxIvrCallTime

Integer

Maximum IVR call duration, in seconds.

ivrOnlyTime

Integer

Total duration of inbound calls that are connected using only the IVR, in seconds.

netCallSuccNum

Integer

Number of successful inbound calls through network devices.

ivrOnlyNum

Integer

Number of inbound calls that are connected using only the IVR.

autoCallNum

Integer

Number of system-level IVR inbound calls.

failWaitAnsTime

Integer

Ring duration for lost calls, in seconds.

queueWaitTime

Integer

Queuing duration, in seconds.

ivrCallTime

Integer

IVR inbound call duration, in seconds.

netCallNum

Integer

Number of inbound calls through network devices.

ivrCallSuccNum

Integer

Number of IVR inbound calls.

agentToAgentNum

Integer

Number of calls that are transferred from the manual service to the manual service.

autoTransferNum

Integer

Number of system-level IVR inbound calls that are transferred out.

inCallCostMinute

Integer

Charging duration of a manual call, in minutes.

inCallAllCostMinute

Integer

Total charging duration of each call, in minutes, including the charging duration of manual calls and IVR calls.

reserved_col1-reserved_col20

Integer

Reserved field. The service meaning is determined based on the configuration in the t_cms_custom_indicator_config table. By default, the reserved field 3 indicates the number of inbound calls whose waiting duration for answer is less than or equal to 15 seconds.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • Request parameters
    {
        "queryParam": {
            "calleeNos": ["10000"],
            "beginLogDay": "2020-01-01",
            "endLogDay": "2020-01-01",
            "callTypes": [0],
            "skillIds": [1],
            "subCcNo": 1,
            "vdn": 3,
            "ccId": 1    }
    }
  • Response parameters
    {
      "resultCode": "0100000",
      "resultDesc": [
        {
          "callTimeGt10": 6,
          "vdn": 152,
          "minIvrCallTime": 0,
          "queOverToIvrNum": 0,
          "failTimeGt10": 0,
          "inCallTime": 6584,
          "agentToQueueNum": 0,
          "inVdnTime": 0,
          "callType": 6,
          "maxQueueWaitTime": 0,
          "succWaitAnsNum": 0,
          "ivrOccupyNum": 0,
          "beginLogDay": "2020-08-24",
          "autoUserAbandonNum": 0,
          "callTimeLt60": 2,
          "maxCallTime": 5702,
          "failTimeLt60": 0,
          "hangUpTime": 0,
          "failTimeLt10": 0,
          "succAckTimeGt10": 0,
          "minWaitAnsTime": 2,
          "autoAnsTime": 0,
          "ivrOnlySuccNum": 0,
          "autoCallSuccNum": 0,
          "hangUpNum": 0,
          "callTimeLt10": 1,
          "currentSkillId": -1,
          "failQueueWaitNum": 0,
          "minQueueWaitTime": 0,
          "succQueueWaitNum": 0,
          "inOccupyNum": 7,
          "maxIvrCallTime": 0,
          "currentAgentId": 1133,
          "ivrOnlyTime": 0,
          "subCcNo": 1,
          "succAckTimeLt30": 7,
          "succAckTimeGt60": 0,
          "serviceNo": 65535,
          "maxWaitAnsTime": 3,
          "netCallSuccNum": 0,
          "failTimeLt5": 0,
          "ivrOnlyNum": 0,
          "minCallTime": 5,
          "failTimeLt3": 0,
          "inCallSuccNum": 7,
          "queOverToIvrTime": 0,
          "autoCallNum": 0,
          "failWaitAnsTime": 0,
          "succAckTimeLt60": 7,
          "queueWaitTime": 0,
          "hangUpReleaseNum": 0,
          "endLogDay": "2020-08-25",
          "ivrCallTime": 0,
          "orgCcNo": 1,
          "calleeNo": "1134",
          "failTimeLt30": 0,
          "failTimeGt60": 0,
          "succWaitAnsTime": 20,
          "callTimeGt60": 5,
          "callTimeLt5": 0,
          "netCallNum": 0,
          "callTimeLt30": 1,
          "callTimeLt3": 0,
          "serCcNo": 1,
          "succAckTimeLt5": 7,
          "ivrCallSuccNum": 0,
          "succQueueWaitTime": 0,
          "agentToAgentNum": 0,
          "failQueueWaitTime": 0,
          "succAckTimeLt10": 7,
          "noAckNum": 0,
          "waitAnsNum": 7,
          "waitAnsTime": 20,
          "succAckTimeLt3": 1,
          "autoTransferNum": 0,
          "inCallCostMinute":10,
          "reserved_col1":0,
          "inCallAllCostMinute":1,
           ……
    },
    {...}
      ]
    }