# 发送免拦截

SendCloud 会对在垃圾举报、自定义拦截、退信地址、取消订阅里的邮件地址进行拦截。

如果客户不想拦截某个地址或接收域，可以将其加入免拦截。

你可以对此列表进行查询，添加，删除操作。

# 查询

URL

https://api2.sendcloud.net/api/unintercept/list
 
        Copied!

HTTP请求方式

post    get
 
        Copied!

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
apiUserName	string	否	免拦截关联的apiUser
domainName	string	否	免拦截接收域域名
email	string	否	免拦截email地址
start	int	否	查询起始位置, 取值区间 [0-], 默认为 0
limit	int	否	查询个数, 取值区间 [0-100], 默认为 100

提示:

apiUserName 可为空(表示所有)，值可为 All 和特定的apiUser.

请求示例:

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

返回值说明

参数	说明
apiUserName	免拦截关联的apiUser
email	邮件地址
domain	接收域域名
createTime	创建时间

返回值示例

{
    "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
    }
}
 
        Copied!

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 添加

URL

https://api2.sendcloud.net/api/unintercept/add
 
        Copied!

HTTP请求方式

post    get
 
        Copied!

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
apiUserName	string	否	免拦截关联的apiUser
domainName	string	*	免拦截接收域域名
email	string	*	免拦截email地址

提示:

apiUserName若为空，默认为 All 类型的apiUser,表示所有有效apiUser
domainName 和 email 不可同时为空
以apiUserName与domainName 或apiUserName apiUserName与email 为判断条件，若有重复数据则不会重复添加
domainName 和email 同时填写，则会自动拆分为两条记录(apiUserName与domainName 、apiUserName与email)

请求示例

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

返回值说明

参数	说明
apiUserName	免拦截关联的apiUser
email	邮件地址
domain	接收域域名
createTime	创建时间

返回值示例

{
    "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"
            }
        ]
    } 
}
 
        Copied!

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 删除

URL

https://api2.sendcloud.net/api/unintercept/delete
 
        Copied!

HTTP请求方式

post    get
 
        Copied!

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
apiUserName	string	否	免拦截关联的apiUser，如 apiUserName=test_4TdLtA
domainName	string	*	免拦截接收域域名，如 domainNamek=qq.com
email	string	*	免拦截email地址

提示:

apiUserName若为空，默认为 all 类型的apiUser
domainName 和 email 不可同时为空
domainName 和 email 均填写，则分别删除 apiUserName和domainName 与 apiUserName和email 的记录

请求示例

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

返回值说明

参数	说明
count	成功删除的个数

返回值示例

{
 
    "result": true,
    "statusCode": 200,
    "message": "request was successful",
    "info": {
        "count": 1
 
    }
}
 
        Copied!

1
2
3
4
5
6
7
8
9
10