Send Unintercept

Sendcloud will intercept email addresses in spam reporting, custom interception (email address or domain name), return address and unsubscribe. If the customer does not want to intercept an address or receiving domain, he can join it without interception.

You can query, delete and add address in the list.

---

Query

URL

https://api.sendcloud.net/apiv2/unintercept/list

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
apiUserName	string	no	Block free associated apiuser
domainName	string	no	Receive domain name without interception
email	string	no	No blocking email address
start	int	no	start position, [0-], defaults to 0
limit	int	no	amount, [0-100],defaults to 100

TIPS:

1. apiUserName can be null (indicating all), and the value can be all and a specific apiUser

Request Example

https://api.sendcloud.net/apiv2/unintercept/list?apiUser=***&apiKey=***&apiUserName=***&domainName=***&email=***&start=0&limit=2

Returned Value Example

parameter	description
apiUserName	Block free associated apiuser
email	email address
domain	Receive domain name without interception
createTime	created time

Returned Value Example

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "dataList": [
            {
                "email": "cxybfq@163.com",
                "unsubscribeTime": "2021-07-15 17:55:20",
                "expireTime": "2021-07-15 17:55:20",
                "domain": "163.com",
                "labelId": 0,
                "apiUser": "delong_test",
                "unsubscribeType": 0,
                "unsubscribeTypeDesc": "我不想再收到此类邮件"
            }
        ],
        "count": 1
    }
}

---

Add

URL

https://api.sendcloud.net/apiv2/unintercept/add

HTTP Request Method

POST    get 

Returned value Description

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
apiUserName	string	no	Block free associated apiuser
domainName	string	*	Receive domain name without interception
email	string	*	No blocking email address
type	string	yes	Address types that are not subject to interception, with multiple types classified accordingly; Number separation, default value is type=1; 2;4; 8. The legal values are 1, 2, 4, and 8

Tips:

1. If apiUserName is empty, it defaults to apiUser of all type, indicating all valid apiUsers.
2. DomainName and email cannot be empty at the same time.
3. If domainName and email are filled in at the same time, they will be automatically split into two records (apiUserName and domainName, apiUserName and email)

Explanation The system will intercept email addresses belonging to the 'return address', 'custom interception', 'spam report' and 'unsubscribe' lists. Through this interface, customers can add domain names or email addresses that are exempt from system interception (non interception) according to their own needs, and specify specific types of non interception. |Type | Description| |:---|:---| |1 | Return address (bounce)| |2 | Custom interception (block)| |4 | Garbage Complaint|

Request Example

POST / GET https://api.sendcloud.net/apiv2/unintercept/add?apiUser=***&apiKey=***&apiUserName=***&domainName=***&email=***&type=1;2;4

Returned Value Description

Parameter	Description
ApiUserName	Anti interception associated apiUser
Email	Email Address
Domain	Receive domain name
Type	Non interception type
Create Time	Create Time
Return value example

{
    "result": true, 
    "statusCode": 200, 
    "message": "Request successful", 
    "info": {
        "dataList": [
            {
                "apiUserName": "all", 
                "domain": "", 
                "email": " leon@gmail.com ", 
                "type": [1,2,4], 
                "createTime": "2021-07-19 11:30:00"
            }
        ]
    }
}

---

Delete

URL

https://api.sendcloud.net/apiv2/unintercept/delete

HTTP Request Method

post    get 

Parameter Description

parameter	type	required or not	description
apiUser	string	yes	API_USER
apiKey	string	yes	API_KEY
apiUserName	string	no	Block free associated apiuser
domainName	string	*	Receive domain name without interception
email	string	*	No blocking email address

Tips:

1. If apiUserName is empty, it defaults to apiUser of all type, indicating all valid apiUsers.
2. DomainName and email cannot be empty at the same time.
3. If both domainName and email are filled in, the records of apiUserName and domainName, apiUserName and email will be deleted respectively.

Request Example

https://api.sendcloud.net/apiv2/unintercept/delete?apiUser=***&apiKey=***&apiUserName=***&domainName=***&email=***

Returned Value Description

parameter	description
count	count of deleted addresses

Returned Value Example

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "count": 1
    }
}