Querying All Outbound Campaigns

Scenario

This interface is invoked to query all outbound campaigns based on specified conditions.

Method

This interface supports only the GET method.

URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}?name={name}&status={status}&deviceType={deviceType}&beginTime={beginTime}&endTime={endTime}&curPage={curPage}&rowsPerPage={rowsPerPage}

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	name	String	No	Name of an outbound campaign. The value is a string of 0 to 30 characters. By default, this parameter is left blank.
3	status	Integer	Yes	Status of an outbound campaign. The options are as follows: 2: started 3: suspended 4: completed If this parameter is set to 0, outbound campaigns in all statuses are queried by default.
4	deviceType	Integer	Yes	Type of an outbound device. The options are as follows: 2: skill queue in predicted outbound calls 3: IVR in automatic outbound calls 5: skill queue in previewed outbound calls 6: skill queue in preempted outbound calls If this parameter is set to 0, outbound campaigns of all types are queried by default.
5	beginTime	String	No	Minimum start time of an outbound campaign, in yyyy-MM-dd HH:mm:ss format.
6	endTime	String	No	Maximum end time of an outbound campaign, in yyyy-MM-dd HH:mm:ss format.
7	curPage	Integer	Yes	Current page. The default value is 1. If the input value is less than 1, the system automatically changes the value to 1.
8	rowsPerPage	Integer	Yes	Number of records on each page. If this parameter is not specified, 10 records are queried by default, and the maximum value is 100.
9	ccId	Integer	No	If this parameter is set, data is filtered based on the specified call center ID. If this parameter is left blank, data is not filtered.

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.

No request body exists.

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	curPage	Integer	Current page.
6	totalSize	Integer	Total number of records.
7	rowsPerPage	Integer	Number of records on each page.
8	curSkillQueueCount	Integer	Total number of outbound campaigns in the current skill queue.
9	curIvrCount	Integer	Total number of current IVR outbound campaigns.
10	data	List	Object of the outbound campaign information that is returned when the query is successful. For details, see Table 4.

**Table 4** Parameter description of Campaign
No.	Parameter	Type	Description
10.1	id	Integer	ID of an outbound campaign.
10.2	name	String	Name of an outbound campaign.
10.3	status	Integer	Status of an outbound campaign. The options are as follows: 2: started 3: suspended 4: completed
10.4	strBeginTime	String	Time when an outbound campaign starts.
10.5	strEndTime	String	Time when an outbound campaign ends.
10.6	deviceType	Integer	Type of an outbound device. The options are as follows: 2: skill queue in predicted outbound calls 3: IVR in automatic outbound calls 5: skill queue in previewed outbound calls 6: skill queue in preempted outbound calls
10.7	callerNo	String	Calling number. Number displayed on the phone of a customer after a call is connected.

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	0200006	Database operation error.
3	02000001	Empty parameter.
4	02000002	The parameter contains invalid characters.
5	02000003	The parameter length cannot exceed the maximum length.
6	02000004	The parameter length cannot be less than the minimum length.
7	02000005	The parameter length must be within the specified range.
8	02000006	Incorrect parameter type.
9	02000007	Incorrect parameter value.
10	02000008	Parameter conversion error. Check the request parameters.
11	02000009	Incorrect parameter combination. Check the request parameters.
12	02000010	The hour and minute parameters must be set at the same time.
13	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:

{
    "resultCode": "0200000",
    "resultDesc": "",
    "returnCode": "0200000",
    "returnDesc": "",
    "curPage": 1,
    "totalSize": 3,
    "rowsPerPage": 10,
    "data": [
        {
            "id": 3,
            "name": "666",
            "status": 1,
            "strBeginTime": "2018-11-30",
            "strEndTime": "2018-11-30",
            "deviceType": 2,
            "callerNo": "10080"
        },
        {
            "id": 4,
            "name": "666333696",
            "status": 1,
            "strBeginTime": "2018-11-30",
            "strEndTime": "2018-11-30",
            "deviceType": 2,
            "callerNo": "10080"
        },
        {
            "id": 2,
            "name": "SAAS_JST",
            "status": 3,
            "strBeginTime": "2018-11-29",
            "strEndTime": "2018-12-08",
            "deviceType": 2,
            "callerNo": "10080"
        }
    ],
    "curSkillQueueCount": 3,
    "curIvrCount": 0
}

Parent topic: Outbound Campaign Management Interfaces

Previous topic: Querying Details About an Outbound Campaign

Next topic: Suspending an Outbound Campaign