Help Center/ Cognitive Engagement Center/ API Reference/ Telemarketing Outbound Call Interface Reference/ Outbound Campaign Management Interfaces/ Collecting Outbound Call Exception Statistics
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Collecting Outbound Call Exception Statistics

Prerequisites

You have applied for a developer account.

Scenario

This interface is invoked to collect outbound call exception statistics on the current day.

Method

This interface supports only the GET method.

URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/failcategorystatistics?campaignId={campaignId}&startDate={startDate}&endDate={endDate}

In the URL, ip indicates the IP address of the CC-iSales server, and port indicates the HTTPS port number of the CC-iSales server.

Table 1 Parameters in the URL

No.

Parameter

Type

Mandatory or Not

Description

1

vdnId

Integer

Yes

VDN ID.

The value is an integer ranging from 1 to 9999.

2

campaignId

String

Yes

Outbound call data ID.

3

startDate

String

No (If this parameter is set, endDate is mandatory.)

Start time for the query.

Format:

yyyy-MM-dd

4

endDate

String

No (If this parameter is set, startDate is mandatory.)

End time for the query.

Format:

yyyy-MM-dd

The interval between the end time and start time cannot exceed 30 days.

Request Description

Table 2 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

Content-Type

String

Yes

The value is fixed to 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.

Response Description

Table 3 Response body parameters

No.

Parameter

Type

Description

1

resultCode

String

Error code. The value 0200000 indicates success, and other values indicate failure.

For details, see Table 5.

2

resultDesc

String

Description.

3

returnCode

String

Error code. The value 0200000 indicates success, and other values indicate failure.

For details, see Table 5.

4

returnDesc

String

Description.

5

data

Array

Query result list.

For details, see Table 4.
Table 4 Parameter description of data

No.

Parameter

Type

Description

1.1

statDate

String

Statistics collection date.

1.2

failData

Map<String,Integer>

Failure data.

Key indicates the failure code.

Value indicates the number of times a failure code is returned.

Triggered Event

None

Error Codes

Table 5 Error code description

No.

Error Code

Description

1

0200001

Parameter error. For details about the error, see resultDesc.

2

02000001

Empty parameter.

3

02000002

The parameter contains invalid characters.

4

02000003

The parameter length cannot exceed the maximum length.

5

02000004

The parameter length cannot be less than the minimum length.

6

02000005

The parameter length must be within the specified range.

7

02000006

Incorrect parameter type.

8

02000007

Incorrect parameter value.

9

02000008

Parameter conversion error. Check the request parameters.

10

02000009

Incorrect parameter combination. Check the request parameters.

11

02000010

The hour and minute parameters must be set at the same time.

12

02000011

The number of parameters cannot exceed the specified number.

Example

  • The following provides an example of the request body of this interface:

    None

  • The following provides an example of the response body of this interface: 
    {
  "returnCode": "0200000",
  "data": [
    {
      "statDate": "2022-10-14",
      "failData": {
        "01119": 1,
        "01153": 4,
        "01169": 2
      }
    },
    {
      "statDate": "2022-10-18",
      "failData": {
        "00701": 1
      }
    }
  ],
  "resultCode": "0200000",
  "resultDesc": "query success",
  "returnDesc": "query success"
}