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

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

Interface Function

This interface is invoked to collect statistics on result sets in the daily settlement table for outbound 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/calloutday/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

callerNos

Array

Yes

Array of calling numbers of a call. The statistics are collected by group based on each number in the array. The calling 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.

callerNo

String

Calling 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

Outbound agent ID.

Outbound 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.

obsServiceNo

String

ID of an outbound campaign.

failQueueWaitNum

Integer

Number of waits for lost calls.

failQueueWaitTime

Integer

Waiting duration of lost calls, in seconds.

outOccupyNum

Integer

Number of manual outbound calls.

outSuccWaitAnsNum

Integer

Number of manual outbound calls that are answered.

outCallSuccNum

Integer

Number of successful manual outbound calls.

outWaitAnsTime

Integer

Ring duration for outbound calls, in seconds.

outCallTime

Integer

Outbound call 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.

agentHangUpLt3

Integer

Number of calls released by calling parties in less than 3 seconds.

preAgentSuccNum

Integer

Number of predicted outbound calls that are forwarded to agents.

preViewedTransferNum

Integer

Number of previewed outbound calls that are transferred by an agent.

hangUpTime

Integer

Total duration of manual-to-IVR calls.

preOccupiedSuccAckTime

Integer

Waiting duration before a preempted outbound call is connected, in seconds.

autoAnsTime

Integer

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

autoCallSuccNum

Integer

Number of system-level IVR outbound calls.

preOccupiedSuccNum

Integer

Waiting duration before a preempted outbound call is connected, in seconds.

hangUpNum

Integer

Number of manual-to-IVR calls.

preAgentNum

Integer

Number of predicted outbound calls that are forwarded to agents.

zeroNum

Integer

Number of calls with zero CDRs.

preQueueWaitTime

Integer

Waiting duration of a predicted outbound call in a queue, in seconds.

preQueueWaitNum

Integer

Number of queuing times for predicted outbound calls.

preViewedCallSuccNum

Integer

Number of previewed outbound calls that are connected.

preOccupiedCallNum

Integer

Total number of preempted outbound calls.

preOccupiedAgentSuccNum

Integer

Number of preempted outbound calls that are answered by agents.

agentTransferNum

Integer

Number of manual outbound calls that are transferred out.

autoCallNum

Integer

Number of system-level IVR outbound calls.

hangUpReleaseNum

Integer

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

preTransferNum

Integer

Number of predicted outbound calls that are transferred out.

preTotalTime

Integer

Total duration of predicted outbound calls, in seconds.

preFailQueueWaitNum

Integer

Number of queuing times for lost predicted outbound calls.

preViewedSuccAckTime

Integer

Waiting duration before a previewed outbound call is connected, in seconds.

preFailQueueWaitTime

Integer

Waiting duration of a lost predicted outbound call in a queue, in seconds.

preAbortQueueWaitNum

Integer

Number of queuing times for predicted outbound calls that are released.

preNoAckNum

Integer

Number of predicted outbound calls that are answered by users but not answered by agents.

succWaitAnsTime

Integer

Duration of answering a successful call, in seconds.

outVdnTime

Integer

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

preViewedCallNum

Integer

Total number of previewed outbound calls.

preCallSuccNum

Integer

Number of predicted outbound calls that are connected.

preOccupiedTransferNum

Integer

Number of preempted outbound calls that are transferred by an agent.

preCallNum

Integer

Number of predicted outbound calls.

preOccupiedAgentSuccTime

Integer

Manual call duration of preempted outbound calls, in seconds.

autoTransferNum

Integer

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

outCallCostMinute

Integer

Charging duration of a manual call, in minutes.

ivrCallSuccNum

Integer

Number of IVR outbound calls.

ivrCallTime

Integer

IVR outbound call duration, in seconds.

ivrOccupyNum

Integer

Number of IVR outbound call requests.

ivrOnlyNum

Integer

Number of outbound calls connected using only the IVR.

ivrOnlySuccNum

Integer

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

ivrOnlyTime

Integer

Duration of outbound calls connected using only the IVR, in seconds.

outCallAllCostMinute

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 outbound calls whose call duration is longer than or equal to 15 seconds.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • Request parameters
    {
        "queryParam": {
            "callerNos": ["120002"],
            "beginLogDay": "2021-10-26",
            "endLogDay": "2021-10-26",
            "callTypes": [7],
            "skillIds": [1,6],
            "subCcNo": 1,
            "vdn": 32
        }
    }
  • Response parameters
    {
        "result": "0",
        "resultCode": "0100000",
        "resultDesc": [
            {
                "failTimeGt10": 0,
                "outSuccWaitAnsNum": 2,
                "callType": 7,
                "callerNo": "120002",
                "maxCallTime": 38,
                "callTimeLt60": 2,
                "preViewedTransferNum": 0,
                "failTimeLt10": 0,
                "succAckTimeGt10": 1,
                "minWaitAnsTime": 1,
                "autoCallSuccNum": 0,
                "hangUpNum": 0,
                "preOccupiedSuccNum": 0,
                "preAgentNum": 0,
                "zeroNum": 0,
                "subCcNo": 1,
                "ivrOnlyTime": 0,
                "succAckTimeLt30": 2,
                "serviceNo": 1,
                "maxWaitAnsTime": 15,
                "obsServiceNo": "-1",
                "failTimeLt5": 0,
                "reservedCol3": 2,
                "ivrOnlyNum": 0,
                "reservedCol2": 0,
                "failTimeLt3": 0,
                "reservedCol1": 0,
                "reservedCol7": 0,
                "reservedCol6": 0,
                "reservedCol5": 0,
                "reservedCol4": 0,
                "preOccupiedAgentSuccNum": 0,
                "autoCallNum": 0,
                "hangUpReleaseNum": 0,
                "preTotalTime": 0,
                "preFailQueueWaitTime": 0,
                "preAbortQueueWaitNum": 0,
                "failTimeGt60": 0,
                "orgCcNo": 1,
                "succWaitAnsTime": 16,
                "callTimeGt60": 0,
                "outVdnTime": 105,
                "callTimeLt5": 0,
                "callTimeLt3": 0,
                "succAckTimeLt5": 1,
                "ivrCallSuccNum": 0,
                "preCallNum": 0,
                "succAckTimeLt10": 1,
                "outCallSuccNum": 2,
                "succAckTimeLt3": 1,
                "callTimeGt10": 2,
                "vdn": 32,
                "preAgentSuccNum": 0,
                "reservedCol10": 0,
                "outOccupyNum": 2,
                "ivrOccupyNum": 0,
                "beginLogDay": "2021-10-26",
                "reservedCol18": 0,
                "reservedCol17": 0,
                "reservedCol16": 0,
                "reservedCol15": 0,
                "reservedCol14": 0,
                "reservedCol13": 0,
                "reservedCol12": 0,
                "failTimeLt60": 0,
                "reservedCol11": 0,
                "hangUpTime": 0,
                "preOccupiedSuccAckTime": 0,
                "ivrOnlySuccNum": 0,
                "reservedCol19": 0,
                "autoAnsTime": 0,
                "callTimeLt10": 0,
                "outWaitAnsTime": 16,
                "currentSkillId": 1,
                "failQueueWaitNum": 0,
                "reservedCol20": 0,
                "reservedCol9": 0,
                "reservedCol8": 0,
                "outCallCostMinute": 2,
                "currentAgentId": 40002,
                "succAckTimeGt60": 0,
                "agentHangUpLt3": 0,
                "preQueueWaitTime": 0,
                "preQueueWaitNum": 0,
                "preViewedCallSuccNum": 0,
                "minCallTime": 26,
                "preOccupiedCallNum": 0,
                "agentTransferNum": 1,
                "succAckTimeLt60": 2,
                "preTransferNum": 0,
                "preViewedSuccAckTime": 0,
                "preFailQueueWaitNum": 0,
                "endLogDay": "2021-10-26",
                "preNoAckNum": 0,
                "ivrCallTime": 0,
                "failTimeLt30": 0,
                "preViewedCallNum": 0,
                "callTimeLt30": 1,
                "serCcNo": 1,
                "preCallSuccNum": 0,
                "outCallTime": 64,
                "preOccupiedTransferNum": 0,
                "failQueueWaitTime": 0,
                "preOccupiedAgentSuccTime": 0,
                "outCallAllCostMinute": 1,
                "autoTransferNum": 0
            },
            {......}
        ]
    }