取消订阅
当用户选择退订邮件时, 他的邮件地址就会被添加到此列表中.
在此列表中的邮件地址, 会被系统拦截,失败分类为无效邮件-取消订阅(worker:address in unsubscribe list)
你可以对此列表进行查询, 删除, 添加操作
查询
URL
https://api.sendcloud.net/apiv2/unsubscribe/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 |
string | * | 查询该地址在取消订阅列表中的详情 | |
apiUserList | string | 否 | 获取指定 API_USER 的统计数据, 多个 API_USER 用; 分开, 如:apiUserList=a;b;c |
labelIdList | string | 否 | 获取指定标签下的统计数据, 多个标签用; 分开, 如:labelIdList=a;b;c |
labelNameList | string | 否 | 获取指定标签名下的统计数据, 多个标签用;分开(中文名称以UTF-8编码), 如:labelIdList=a;b;c |
start | int | 否 | 查询起始位置, 取值区间 [0-], 默认为 0 |
limit | int | 否 | 查询个数, 取值区间 [0-100], 默认为 100 |
提示:
- 如果指定时间区间, 则是查询此时间区间内的取消订阅列表. 注意: startDate 与 endDate 的组合 或者 days 参数, 二者取一.
- 查询的天数不超过三个月.
- 如果指定email, 则是查询此地址在取消订阅列表中的详细信息. 注意: 此时, 时间区间参数失效.
请求示例:
http://api.sendcloud.net/apiv2/unsubscribe/list?apiUser=***&apiKey=***&apiUserList=[***;***]&days=100&start=0&limit=3
返回值说明
参数 | 说明 |
---|---|
邮件地址 | |
domain | 邮件地址对应的域名 |
labelId | 标签ID |
labelName | 标签名称 |
apiUser | apiUser名称 |
unsubscribeTime | 取消订阅的时间 |
unsubscribeType | 取消订阅分类 |
unsubscribeTypeDesc | 取消订阅分类描述 |
expireTime | 过期时间 |
unsubscribeType | unsubscribeTypeDesc |
---|---|
0 | 我不想再收到此类邮件 |
1 | 这不是我订阅的 |
2 | 这是垃圾邮件 |
3 | 这是欺诈邮件 |
返回值示例:
{
"result": true,
"statusCode": 200,
"message": "请求成功",
"info": {
"dataList": [
{
"email": "cxybfq@163.com",
"unsubscribeTime": "2021-07-15 17:55:20",
"expireTime": "2021-07-15 17:55:20",
"domain": "163.com",
"labelId": 0,
"labelName":"",
"apiUser": "delong_test",
"unsubscribeType": 0,
"unsubscribeTypeDesc": "我不想再收到此类邮件"
}
],
"count": 1
}
}
添加
URL
https://api.sendcloud.net/apiv2/unsubscribe/add
HTTP请求方式
POST get
参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
apiUser | string | 是 | API_USER |
apiKey | string | 是 | API_KEY |
string | 是 | 要添加的地址 | |
expireTime | string | 是 | 取消订阅的过期时间,格式为yyyy-MM-dd |
请求示例:
https://api.sendcloud.net/apiv2/unsubscribe/add?apiUser=***&apiKey=***&email=abc@qq.com
返回值说明
参数 | 类型 |
---|---|
邮件地址 | |
domain | 邮件地址对应的域名 |
labelId | 标签ID |
apiUser | API_USER |
unsubscribeTime | 取消订阅的时间 |
expireTime | 过期时间 |
返回值示例:
{
"result": true,
"statusCode": 40401,
"message": "取消订阅记录创建成功",
"info": {
"data": {
"email": "cxybfq@163.com",
"unsubscribeTime": "2021-07-19 17:51:10",
"expireTime": "2021-07-01 00:00:00",
"domain": "163.com",
"labelId": 0,
"apiUser": "xiaojinmin",
"unsubscribeType": 0,
"unsubscribeTypeDesc": "我不想再收到此类邮件"
}
}
}
删除
URL
https://api.sendcloud.net/apiv2/unsubscribe/delete
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 |
string | * | 删除该地址 |
提示:
- 如果指定时间区间, 则是删除此时间区间内所有取消的订阅地址. 注意: startDate 与 endDate 的组合 或者 days 参数, 二者取一.
- 时间区间不能超过三个月.
- 如果指定email, 则是在取消订阅列表中删除此地址. 注意: 此时, 时间区间参数失效.
请求示例:
https://api.sendcloud.net/apiv2/unsubscribe/delete?apiUser=***&apiKey=*** &email=test@sendcloud.com
返回值说明
参数 | 说明 |
---|---|
count | 成功删除的邮件地址个数 |
返回值示例:
{
"statusCode":200,
"info":{"count":1},
"message":"请求成功",
"result":true
}