Updated on 2025-11-13 GMT+08:00

Deleting a Reserved Outbound Call Campaign

Prerequisites

  • You have applied for a developer account.

Scenario

This interface is invoked to delete a reserved outbound call task.

Method

This interface supports only the POST method.

URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/appoint/delete

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

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

appointId

String

Yes

ID of the reserved outbound call campaign to be deleted.

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

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

04000004

The reserved outbound campaign does not exist.

5

04000005

A reserved outbound call task under which calls are made cannot be deleted.

Example

  • The following provides an example of the request body of this interface:
    {
        "appointId" :"174730004495053249845286302552"
    }
  • The following provides an example of the response body of this interface:
    {
        "returnCode": "0200000",
        "resultCode": "0200000",
        "resultDesc": "success",
        "returnDesc": "success"
    }