Deleting Calling Numbers

Scenario

This interface is invoked to delete calling numbers from an outbound campaign.

Usage Description

Prerequisites
- You have applied for a developer account.
- The outbound campaign has been created.
Restrictions
- For the same outbound campaign task, a maximum of 100 calling numbers can be deleted at a time. At least one calling number must be reserved for a task.

Method

This interface supports only the DELETE method.

URI

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

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	campaignId	Integer	Yes	ID of an outbound campaign.

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.

**Table 3** Request body parameters
No.	Parameter	Type	Mandatory or Not	Description
1	callerNo	List	Yes	Multiple calling numbers are supported. A maximum of 100 numbers can be deleted at a time. For details about the parameters of this object, see Table 4.

**Table 4** Parameter description of callerNo
No.	Parameter	Type	Mandatory or Not	Description
1.1	accessCode	String	Yes	Calling number. Number displayed on the phone of a customer after a call is connected. The value can contain a maximum of 24 characters, including only digits.

Response Description

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

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	0200007	The outbound campaign does not exist.
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:
```
{"callerNo":[
	{"accessCode":"5245241"}
]}
```

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

{
  "resultCode": "0200000",
  "resultDesc": "delete callerNo success.num:1",
  "returnCode": "0200000",
  "returnDesc": "delete callerNo success.num:1"
}

Parent topic: Outbound Campaign Management Interfaces

Previous topic: Adding Calling Numbers

Next topic: Interfaces for Managing Outbound Campaign Holidays