发送免拦截

查询

URL

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

HTTP请求方式

POST / GET

参数说明

参数 类型 必须 说明
apiUser string 是 API_USER
apiKey string 是 API_KEY
apiUserName string 否 免拦截关联的apiUser
domainName string 否 免拦截接收域域名
email string 否 免拦截email地址
start int 否 查询起始位置
limit int 否 查询个数

提示:

  1. apiUserName可以为空(表示所有)，值可为"all"或特定的apiUser。
  2. start和limit用于分页查询，默认start为0，limit为100。

请求示例:

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

返回值说明

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

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "dataList": [            
            {
                "apiUserName": "all",
                "domain": "",
                "email": "wbw@hotmail.com",
                "type": [1,2,4,8],
                "createTime": "2021-07-15 15:32:03"
            },
            {
                "apiUserName": "check_test",
                "domain": "gmail.com",
                "email": "",
                "type": [2],
                "createTime": "2021-07-15 15:21:41"
            }
        ],
        "count": 2
    }
}

添加

URL

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

HTTP请求方式

POST / GET

参数说明

参数 类型 必须 说明
apiUser string 是 API_USER
apiKey string 是 API_KEY
apiUserName string 否 免拦截关联的apiUser，默认为all，即对所有apiuser生效
domainName string * 免拦截接收域域名
email string * 免拦截email地址
type string 否 免拦截的地址类型，多个类型用分;号分开，默认值为type=1;2;4;8，合法取值为1、2、4、8

提示:

  1. apiUserName若为空，默认为"all"类型的apiUser，表示所有有效apiUser。
  2. domainName和email不可同时为空。
  3. 如果同时填写domainName和email，则会自动拆分为两条记录(apiUserName与domainName、apiUserName与email)。

说明

系统对于属于退信地址，自定义拦截，垃圾举报，取消订阅列表中的邮箱地址，是会进行发送拦截的。

通过此接口，客户可以根据自身需求来添加系统免拦截（不予拦截）的域名或者邮箱，同时指定具体的免拦截类型。

type 说明
1 退信地址(bounce)
2 自定义拦截(block)
4 垃圾举报(complaint)
8 取消订阅(unsubscribe)

请求示例:

POST / GET https://api.sendcloud.net/apiv2/unintercept/add?apiUser=***&apiKey=***&apiUserName=***&domainName=***&email=***&uninterceptType=14

返回值说明

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

返回值示例

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

## 删除

**URL**

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


**HTTP请求方式**
​```bash
POST / GET

参数说明

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

提示:

  1. apiUserName若为空，默认为"all"类型的apiUser。
  2. domainName和email不可同时为空。
  3. 如果同时填写domainName和email，则分别删除apiUserName和domainName与apiUserName和email的记录。

请求示例:

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

返回值说明

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

返回值示例

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