垃圾举报

用户举报的垃圾邮件, 此用户的地址会进入垃圾举报列表.

在此列表中的邮件地址, 会被系统拦截，失败分类为无效邮件-在SendCloud黑名单中:退信(worker:address in complaint list)

你可以对此列表进行查询、删除操作.

---

查询

URL

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

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
days	int	*	过去 days 天内的统计数据 (days=1表示今天)
startDate	string	*	开始日期, 格式为yyyy-MM-dd
endDate	string	*	结束日期, 格式为yyyy-MM-dd
email	string	*	查询该地址在举报列表中的详情
start	int	否	查询起始位置, 取值区间 [0-], 默认为 0
limit	int	否	查询个数, 取值区间 [0-100], 默认为 100

提示:

1. 如果指定时间区间, 则是查询此时间区间内的举报列表. 注意: start_date 与 end_date 的组合 或者 days 参数, 二者取一.
2. 查询的天数不超过三个月.
3. 如果指定email, 则是查询此地址在举报列表中的详细信息. 注意: 此时, 时间区间参数失效.

请求示例:

https://api.sendcloud.net/apiv2/complaint/list?apiUser=***&apiKey=***

返回值说明

参数	说明
email	邮件地址
reason	举报原因
domain	域名
complaintTime	举报时间
expireTime	过期时间

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "dataList": [
            {
                "email": "demo@gmail.com",
                "reason": "FROM ESP",
                "domain": "",
                "complaintTime": "2021-06-19 15:31:49",
                "expireTime": "2023-07-19 15:31:53"
            }
        ],
        "count": 1
    }
}

---

删除

URL

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

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
startDate	string	*	开始日期, 格式为yyyy-MM-dd
endDate	string	*	结束日期, 格式为yyyy-MM-dd
email	string	*	删除指定邮件

提示:

1. email 和(startDate与endDate) 不能同时为空,如果email 为空，则删除指定时间内(startDate与endDate)的地址.
2. 如果email不为空，删除指定邮箱的地址.

请求示例:

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

返回值说明

无

返回值示例

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