Modifying a Blocklist Type

Scenario

This interface is invoked to add a blocklisted number to a blocklist group.

Usage Description

Prerequisites
- You have applied for a developer account.
- Blocklist types have been created.

Method

This interface supports only the POST method.

URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackType/update

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 or Not	Description
1	vdnId	Integer	Yes	ID of a VCC. The value is an integer ranging from 1 to 9999.

Request Description

**Table 2** Request header parameters
No.	Parameter	Value Type	Mandatory or Not	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.
3	locale	String	No	i18n (internationalization, Language International Code), for example, zh_CN indicates Chinese and en_US indicates English. The default value is zh_CN.

**Table 3** Request body parameters
No.	Parameter	Value Type	Mandatory or Not	Description
1	id	String	Yes	Blocklist type ID, which needs to be verified.
2	name	String	Yes	Blocklist group name, which contains a maximum of 64 characters.
3	description	String	No	Blocklist group description, which contains a maximum of 255 characters.
4	actionType	String	Yes	Action type. The options are as follows: 1: automatic processing 2: pop-up window
5	action	String	Yes	Action.

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 6.
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	0200007	The number already exists in the blocklist.
4	0200018	Duplicate numbers exist.
5	0200029	The maximum number of numbers that can be added each time is exceeded.
6	02000001	Empty parameter.
7	02000002	The parameter contains invalid characters.
8	02000003	The parameter length cannot exceed the maximum length.
9	02000004	The parameter length cannot be less than the minimum length.
10	02000005	The parameter length must be within the specified range.
11	02000006	Incorrect parameter type.
12	02000007	Incorrect parameter value.
13	02000008	Parameter conversion error. Check the request parameters.
14	02000009	Incorrect parameter combination. Check the request parameters.
15	02000010	The hour and minute parameters must be set at the same time.
16	02000011	The number of parameters cannot exceed the specified number.
17	02000012	The blocklist group already exists.
18	02000013	Invalid blocklist group ID.
19	02000014	The blocklist type already exists.
20	02000015	Invalid blocklist type ID.

Example

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

{
	"id": "11541854",
	"name": "test",
	"description": "Blocklist type",
	"actionType": "3",
	"action": {
		"busiResult": "17442057",
		"string": "fff2",
		"url": "https://www.huawei.com"
	}
}

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

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

Parent topic: Interface for Outbound Blacklist Management

Previous topic: Querying a Blocklist Type

Next topic: Deleting a Blocklist Type

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

Chatbot