Querying Blacklisted Outbound Numbers

Scenario

This interface is invoked to query blacklisted numbers in a specified VCC.

Usage Description

Prerequisites
- You have applied for a developer account.

Method

This interface supports only the POST method.

URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/query

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 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.
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	blocklist	List	No	A maximum of 20 blacklisted numbers can be queried. A number can contain a maximum of 24 characters, including only digits, asterisks (*), and number signs (#). CAUTION: If this parameter is transferred, only the transferred blocklisted numbers are returned. That is, the response is the information (such as the expiration time and validity period) about the transferred blocklisted numbers if the numbers are in the blocklist.
2	relCategoryId	String	No	ID of the associated blocklist group.
3	typeId	String	No	ID of the associated blocklist type.
4	offset	Integer	No	Parameter for determining the start page of the query. Value of offset = Value of limit x (Value of page – 1) page indicates the start page to be queried.
5	limit	Integer	No	Number of query records on each page. The value ranges from 1 to 100. CAUTION: Either the limit and offset parameters or the blocklist parameter must be set.

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 Error Codes.
2	resultDesc	String	Description.
3	returnCode	String	Error code. The value 0200000 indicates success, and other values indicate failure. For details, see Error Codes.
4	returnDesc	String	Description.
5	totalCount	Integer	Total number of records in the returned list.
6	data	Object	For details, see Table 5.

**Table 5** Parameter description of data
No.	Parameter	Value Type	Description
1	validityExpirationTime	String	Expiration time.
2	blockNum	String	Blacklisted number.
3	flag	Boolean	Whether a blacklisted number is valid. The options are true (valid) and false (invalid). NOTICE: This parameter is returned only when blocklist is transferred.
4	orgName	String	Organization name.
5	relCategoryId	String	Group ID.
6	relCategoryName	String	Group name.
7	typeId	String	Type ID.
8	typeName	String	Type name.
9	remark	String	Remarks.

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	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.
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:
```
{"limit":10,"offset":0}
```

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

{
  "returnCode": "0200000",
  "data": [
    {
      "validityExpirationTime": "1753711883000",
      "blockNum": "111"
    },
    {
      "validityExpirationTime": "1753711883000",
      "blockNum": "34234"
    },
    {
      "validityExpirationTime": "1753711883000",
      "blockNum": "321"
    },
    {
      "validityExpirationTime": "1753711883000",
      "blockNum": "321"
    }
  ],
  "resultCode": "0200000",
  "resultDesc": "query BlockList Success",
  "returnDesc": "query BlockList Success"
}

Parent topic: Interface for Outbound Blacklist Management

Previous topic: Deleting All Outbound Numbers from the Blacklist

Next topic: Importing a Blacklist Data File from the Server