# 退信地址
由特定原因(如地址不存在等)被退信的邮件会进入此列表.
请求发往此列表的邮件地址,会被系统拦截不会发送,失败分类为无效-在SendCloud黑名单中.
你可以对此列表进行查询, 删除,自定义添加操作
# 查询
URL
https://api2.sendcloud.net/api/bounce/list
1
HTTP请求方式
post get
1
参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
apiUser | string | 是 | API_USER |
apiKey | string | 是 | API_KEY |
days | int | * | 过去 days 天内的统计数据 (days=1 表示今天) |
startDate | string | * | 开始日期, 格式为yyyy-MM-dd |
endDate | string | * | 结束日期, 格式为yyyy-MM-dd |
string | * | 查询该地址在退信地址中的详情 | |
start | int | 否 | 查询起始位置, 取值区间 [0-], 默认为 0 |
limit | int | 否 | 查询个数, 取值区间 [0-100], 默认为 100 |
提示:
- 如果指定时间区间, 则是查询此时间区间内的退信地址. 注意: startDate 与 endDate 的组合 或者 days 参数, 二者取一.
- 查询的天数不超过三个月.
- 如果指定email, 则是查询此地址在退信地址中的详细信息. 注意: 此时, 时间区间参数失效.
请求示例:
https://api2.sendcloud.net/api/bounce/list?apiUser=***&apiKey=***&days=100&start=0
https://api2.sendcloud.net/api/bounce/list?apiUser=***&apiKey=***&email=***
1
2
3
2
3
返回值说明
参数 | 说明 |
---|---|
邮件地址 | |
reason | 退信原因 |
domain | 退信域名 |
bounceTime | 退信时间 |
expireTime | 过期时间 |
返回值示例
{
"statusCode":200,
"info":{
"dataList":[
{
"email":"b@qq.com",
"reason":"Mailbox not found. http://service.mail.qq.com/cgi-bin/help?subtype=1&&id=20022&&no=1000728",
"domain":"qq.com",
"bounceTime":"2016-02-01 14:53:20",
"expireTime": "2021-07-09 00:59:37"
}
],
"count":1
}
"message":"request was successful",
"result":true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 删除
该删除接口功能等同与发送免拦截中的添加功能,推荐有此需求的客户调用发送免拦截中的添加接口
URL
https://api2.sendcloud.net/api/bounce/delete
1
HTTP请求方式
post get
1
参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
apiUser | string | 是 | API_USER |
apiKey | string | 是 | API_KEY |
string | 是 | 要免拦截的邮件地址 |
请求示例
https://api2.sendcloud.net/api/bounce/delete?apiUser=***&apiKey=***&email=***
1
返回值说明
参数 | 说明 |
---|---|
count | 成功设置免拦截的地址个数 |
返回值示例
{
"statusCode":200,
"info":{
"count":1
}
"message":"request was successful",
"result":true
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8