SendCloud

# Uninterception

Sendcloud will intercept email addresses in complaint, block , bounce, unsubscribe. If the customer does not want to intercept an address or receiving domain, he can join it without interception. You can query, add and delete this list.

# Query

URL

https://api2.sendcloud.net/api/unintercept/list
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
apiUserName string no unintercept API_USER
domainName string no unintercept receiving domain
email string no unintercept email address
start int no amount, [0-100], defaults to 100
limit int no amount, [0-100], defaults to 100

Tips:

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

Request Example:

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

Returned Value Description

parameter description
apiUserName unintercept API_USER
email unintercept email address
domain unintercept receiving domain
createTime create time

Returned Value Example

{
    "result": true,
    "statusCode": 200,
    "message": "request was successful",
    "info": {
        "dataList": [            
            {
                "apiUserName": "all",
                "domain": "",
                "email": "wbw@hotmail.com",
                "createTime": "2021-07-15 15:32:03"
            },
            {
                "apiUserName": "check_test",
                "domain": "gmail.com",
                "email": "",
                "createTime": "2021-07-15 15:21:41"
            }
        ],
        "count": 2
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Add

URL

https://api2.sendcloud.net/api/unintercept/add
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
apiUserName string no unintercept API_USER
domainName string * unintercept receiving domain
email string * unintercept email address

Tips:

  1. If apiUserName is empty, it defaults to apiUser of all type
  2. domainName and email cannot be empty at the same time
  3. Take apiUserName and domainName or apiUserName and email as the judgment conditions. If there is duplicate data, it will not be added repeatedly
  4. If domainName and email are filled in at the same time, they will be automatically split into two records (apiUserName and domainName , domainName and email)

Request Example:

https://api2.sendcloud.net/api/unintercept/add?apiUser=***&apiKey=***&apiUserName=***&domainName=***&email=***&start=0&limit=10
1

Returned Value Description

parameter description
apiUserName unintercept API_USER
email unintercept email address
domain unintercept receiving domain
createTime create time

Returned Value Example

{
    "result": true,
    "statusCode": 200,
    "message": "request was successful",
    "info": {
        "dataList": [
            {
                "apiUserName": "all",
                "domain": "",
                "email": "leon@gmail.com",
                "createTime": "2021-07-19 11:30:00"
            },
            {
                "apiUserName": "all",
                "domain": "yahoo.com",
                "email": "",
                "createTime": "2021-07-19 11:25:29"
            }
        ]
    } 
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# Delete

URL

https://api2.sendcloud.net/api/unintercept/delete
1

HTTP Request Method

post    get
1

Parameter Description

parameter type required or not description
apiUser string yes API_USER
apiKey string yes API_KEY
apiUserName string no unintercept API_USER，e.g. apiUserName=test_4TdLtA
domainName string * unintercept receiving domain, e.g. domainNamek=qq.com
email string * unintercept email address

Tips:

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

Request Example:

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

Returned Value Description

parameter description
count number of successfully deleted

Returned Value Example

{
 
    "result": true,
    "statusCode": 200,
    "message": "request was successful",
    "info": {
        "count": 1
 
    }
}
1
2
3
4
5
6
7
8
9
10
Last Updated: 2025/03/25 10:38:59

Opens And Clicks

Query
Add
Delete