Querying Call Statistics Reports

Interface Method

POST

URL

https://IP:PORT/oifde/rest/api/queryCallStatisticsReport

Request

**Table 1** Parameters in the request body
Parameter	Type	Position	Mandatory	Description
type	String	Body	Yes	Query type. hour: report data on a specified date, which is queried by hour. day: report data of the last 30 days, which is queried by day.
tenantId	String	Body	Yes	Tenant ID.
accessCode	String	Body	Yes	Access ID (chatbot access code).
timestamp	Long	Body	Yes	Timestamp of the query date, in milliseconds.
authToken	String	Body	Yes	Authentication token. For details, see C3 OIAP Interface Authentication.

Response

Parameter	Type	Position	Mandatory	Description
-	QueryCallStatisticsRes[]	Body	Yes	Call statistics report.

**Table 2** QueryCallStatisticsRes
Parameter	Mandatory	Type	Description
recordTime	Yes	Long	Timestamp of the record date, in milliseconds.
tenantId	Yes	String	Tenant ID.
accessCode	Yes	String	Access ID (chatbot access code).
callCount	Yes	Long	Number of connected calls.
exitNoConsultCount	Yes	Long	Number of calls disconnected without consultation, that is, the number of calls that a user interacts with IVR only once.
callStaffNoConsultCount	Yes	Long	Number of calls processed only by agents, that is, the number of calls that a user interacts with the IVR more than once but less than or equal to three times and the call is not hung up in the IVR.
callStaffConsultCount	Yes	Long	Number of calls that are transferred to the manual service after consultation, that is, the number of calls that a user interacts with the IVR for more than three times and the call is not hung up in the IVR.
exitConsultingCount	Yes	Long	Number of calls processed only by chatbots, that it, the number of calls that a user interacts with the IVR for more than once and the call is hung up in the IVR.
interactCount	Yes	Long	Number of dialog rounds, that is, the total number of interactions between users and the IVR.
autonomyRate	Yes	String	Net self-service resolution rate. –1.000: No chatbot is used (Number of calls processed only by agents + Number of calls transferred to agents after consultation + Number of calls processed only by chatbots). 0–1.000: Number of calls processed only by chatbots/Total number of calls processed by chatbots.
averageInteractPerCall	Yes	String	Average number of dialog rounds, that is, the average number of interactions between users and the IVR per call.
dbRecordTime	Yes	Date	Date recorded in the database. If this parameter is not set, the value is null.
type	Yes	String	Query type. hour: query by hour. day: query by day.
interfaceRequestCount	Yes	Long	Number of interface invoking times.
interfaceSuccessCount	Yes	Long	Number of successful invoking times.
interfaceSuccessRate	Yes	String	Interface invoking success rate. –1.000: No interface is invoked. 0–1.000: Number of successful invoking times/Total number of interface invoking times.

Example

Request

{
    "tenantId":"202104237142",
    "accessCode":"943370855474270208",
    "timestamp":1628784000000,
    "type":"hour",
    "authToken":"wEd*******************Q6VwYMj"
}

Response

[
    {
        "recordTime": 1628820000000,
        "tenantId": "202104237142",
        "accessCode": "943370855474270208",
        "callCount": 1,
        "exitNoConsultCount": 0,
        "callStaffNoConsultCount": 0,
        "callStaffConsultCount": 0,
        "exitConsultingCount": 1,
        "interactCount": 2,
        "autonomyRate": "1.0000",
        "averageInteractPerCall": "2.00",
        "dbRecordTime": 1628820000000,
        "type": "hour",
        "interfaceRequestCount": 0,
        "interfaceSuccessCount": 0,
        "interfaceSuccessRate": "-1.0000"
    }
]

Parent topic: Statistics Report

Previous topic: Statistics Report

Next topic: Querying Chatbot Report Information