Collecting Outbound Call Statistics on the Current Day

Prerequisites

You have applied for a developer account.

Scenario

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

Method

This interface supports only the GET method.

URI

https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/statistics?campaignId={campaignId}&batchId={batchId}

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	No	Outbound call data ID. If this parameter is set, all statistics and the statistics in all batches of the current task are queried. If this parameter is left empty, all statistics and the statistics in all batches of all tasks are queried.
3	batchId	String	No (If this parameter is set, campaignId is mandatory.)	Batch number. This parameter is mapped to customField in the t_isl_data table. If this parameter is set, all statistics and the statistics in the specified batch of the current task are queried.

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	countDetail	Array	Statistics of each task. For details, see Table 4.

**Table 4** Parameter description of countDetail
No.	Parameter	Type	Description
1.1	campaignId	String	Outbound call data ID.
1.2	unCallCount	Integer	Total number of remaining unmade calls of the campaign ID.
1.3	calledCount	Integer	Number of made calls on the current day.
1.4	finishCount	Integer	Total number of completed calls.
1.5	batchDetail	Array	Statistics of each batch ID (customField). For details, see Table 5.
1.6	totalCalledCount	Integer	Total number of made calls in the campaign.
1.7	totalCallSucc	Integer	Total number of connected calls in the campaign.
1.8	totalFinishCount	Integer	Total number of completed calls in the campaign.
1.9	totalCount	Integer	Total number of calls in the campaign (including completed, ongoing, and unmade calls).
1.10	dailyCalledCount	Integer	Number of made calls on the current day.
1.11	dailyCallSucc	Integer	Total number of connected calls on the current day.
1.12	dailyFinishCount	Integer	Total number of completed calls on the current day.
1.13	dailyCount	Integer	Number of calls on the current day (including completed, ongoing, and unmade calls).

**Table 5** Parameter description of batchDetail
No.	Parameter	Type	Description
1.5.1	batchId	String	Batch ID of the outbound call data to be added. The value is the same as that of customField.
1.5.2	unCallCount	Integer	Total number of remaining unmade calls of the campaign ID.
1.5.3	calledCount	Integer	Number of made calls on the current day.
1.5.4	finishCount	Integer	Total number of completed calls.
1.5.5	totalCalledCount	Integer	Total number of made calls in the campaign.
1.5.6	totalCallSucc	Integer	Total number of connected calls in the campaign.
1.5.7	totalFinishCount	Integer	Total number of completed calls in the campaign.
1.5.8	totalCount	Integer	Total number of calls in the campaign (including completed, ongoing, and unmade calls).
1.5.9	dailyCalledCount	Integer	Number of made calls on the current day.
1.5.10	dailyCallSucc	Integer	Total number of connected calls on the current day.
1.5.11	dailyFinishCount	Integer	Total number of completed calls on the current day.
1.5.12	dailyCount	Integer	Number of calls on the current day (including completed, ongoing, and unmade calls).

Triggered Event

None

Error Codes

**Table 6** 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.

Flow control is configured for this interface and is performed every five minutes. If operations are frequently performed, the system reports the status code 429 and the message "Do not perform this operation frequently. Please try again later.". The ValidateExceptionHandler is handling the exception.

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:

{
  "countDetail": [
    {
      "calledCount": 0,
      "batchDetail": [],
      "campaignId": "1798316116",
      "finishCount": 0,
      "unCallCount": 0,
      "totalCount": 3,
      "totalCallSucc": 2,
      "totalCalledCount": 3,
      "totalFinishCount": 3,
      "dailyFinishCount": 3,
      "dailyCalledCount": 3,
      "dailyCallSucc": 2,
      "dailyCount": 3
    },
    {
      "calledCount": 0,
      "batchDetail": [
        {
          "calledCount": 0,
          "finishCount": 0,
          "unCallCount": 1,
          "batchId": "123456",
         "totalCount": 3,
         "totalCallSucc": 2,
         "totalCalledCount": 3,
         "totalFinishCount": 3,
         "dailyFinishCount": 3,
         "dailyCalledCount": 3,
         "dailyCallSucc": 2,
         "dailyCount": 3
        },
        {
          "calledCount": 0,
          "finishCount": 0,
          "unCallCount": 1,
          "batchId": "66666",
          "totalCount": 3,
          "totalCallSucc": 2,
         "totalCalledCount": 3,
         "totalFinishCount": 3,
         "dailyFinishCount": 3,
         "dailyCalledCount": 3,
         "dailyCallSucc": 2,
         "dailyCount": 3
        }
      ],
      "campaignId": "1549589640",
      "finishCount": 0,
      "unCallCount": 3
    }
  ]
}

Parent topic: Outbound Call Data Interfaces

Previous topic: Querying Outbound Numbers

Next topic: Importing an Outbound Call Data File from the Server