Adding an Outbound Call Batch

Prerequisites

You have applied for a developer account.
An outbound call task in draft, executing, suspended, or completed state exists.

Scenario

This interface is invoked to add an outbound call batch for a specified outbound campaign.

Method

This interface supports only the POST method.

URL

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

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	name	String	Yes	Name of an outbound call batch. The name must be unique and can contain a maximum of 255 characters. The value cannot contain the following special characters: <>!@#$%^&?;"~/\ The maximum number of outbound call batches for a single outbound call task is specified by the tenant parameter Maximum batch quantity in the task. The value ranges from 1 to 1000, and the default value is 100*.
2	status	Integer	No	Batch status. The value can be either of the following: 1: started 2 (default value): suspended

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	returnObject	Object	For details, see Table 5.

**Table 5** Parameter description of returnObject
No.	Parameter	Value Type	Description
1	id	String	Batch ID of an outbound call task.

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.
4	02000001	Empty parameter.
5	02000002	The parameter contains invalid characters.
6	02000003	The parameter length cannot exceed the maximum length.
7	03000001	Duplicate batch names exist.
8	03000002	No batch can be added for the outbound campaign.
9	03000003	The number of batches exceeds the maximum.

Example

The following provides an example of the request body of this interface:
```
{
    "name": "test",
    "status": 1
}
```

The following provides an example of the response body of this interface:

{
    "returnCode": "0200000",
    "returnObject": {
        "id": "174712034211433247704877116507"
    },
    "resultCode": "0200000",
    "resultDesc": "success",
    "returnDesc": "success"
}

Parent topic: Outbound Call Batch Interfaces

Previous topic: Outbound Call Batch Interfaces

Next topic: Modifying an Outbound Call Batch