Suspending an Outbound Call Batch

You have applied for a developer account.

An outbound call task in draft, executing, or completed state exists.

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

This interface supports only the POST method.

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

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.

**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	id	String	Yes	ID of the batch to be suspended.

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

None

**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	0200007	The outbound campaign does not exist.
4	02000001	Empty parameter.
5	03000002	Batch suspension is not allowed for the outbound campaign.
6	03000004	Batch ID not found.
7	03000006	The batch has been suspended and cannot be suspended again.

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

{
    "returnCode": "0200000",
    "resultCode": "0200000",
    "resultDesc": "success",
    "returnDesc": "success"
}

Parent topic: Outbound Call Batch Interfaces

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.