Help Center/ Customer Engagement Center/ API Reference/ Outbound Call Interface Reference/ Outbound Call Batch Interfaces/ Querying an Outbound Campaign Batch
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Querying an Outbound Campaign Batch

Prerequisites

You have applied for a developer account.

Scenario

This interface is invoked to query an outbound batch for an outbound campaign.

Method

This interface supports only the GET method.

URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callbatch/{campaignId}/list

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

Value Type

Mandatory

Description

1

vdnId

Integer

Yes

VCC ID.

The value is an integer ranging from 1 to 9999.

2

campaignId

Integer

Yes

ID of an outbound campaign.

Request Description

Table 2 Request header parameters

No.

Parameter

Value 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 3 Request body parameters

No.

Parameter

Value Type

Mandatory

Description

1

status

Integer

No

Batch status. The value can be either of the following:

1: started

2: suspended

2

name

String

No

Batch name. Fuzzy search is supported.

3

offset

Integer

Yes

Parameter for determining the start page of the query. Value of offset = Value of limit × (Value of page – 1)

4

limit

Integer

Yes

Number of query records on each page.

Response Description

Table 4 Response body parameters

No.

Parameter

Value Type

Description

1

resultCode

String

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

For details, see Table 6.

2

resultDesc

String

Description.

3

returnCode

String

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

For details, see Table 6.

4

returnDesc

String

Description.

5

totalCount

Integer

Total number of records in the returned list.

6

data

List

Table 5
Table 5 Parameter description of data

No.

Parameter

Value Type

Description

1

id

String

Batch ID.

2

name

String

Batch name.

3

status

Integer

Batch status. The value can be either of the following:

1: started

2: suspended

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

0200006

Database operation error.

3

0200007

The outbound campaign does not exist.

Example

  • The following provides an example of the request body of this interface: 
    {
    "name": "te",
    "status": 1,
    "offset": 0,
    "limit": 5
}
  • The following provides an example of the response body of this interface: 
    {
    "returnCode": "0200000",
    "data": [
        {
            "name": "test2",
            "id": "174712034211433247704877116507",
            "status": 1
        }
    ],
    "resultCode": "0200000",
    "resultDesc": "success",
    "totalCount": 1,
    "returnDesc": "success"
}