AppPush
WebPush
WhatsApp
Email
SMS
OTP
取消订阅
最新更新：2023-08-10
当用户选择退订邮件时, 他的邮件地址就会被添加到此列表中.
在此列表中的邮件地址, 都不会再被发送邮件.
你可以对此列表进行查询, 删除, 添加操作
查询
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
此代码块在浮窗中显示
HTTP 请求方式
GET
GET
此代码块在浮窗中显示
Header
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 基本 base64(api_user:api_key) |
查询参数说明
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| start_date | string | * | 开始日期（格式：yyyy-MM-dd） |
| end_date | string | * | 结束日期（格式：yyyy-MM-dd） |
| string | * | 邮件地址，例如，22@gmail.com |
|
| api_user | string | 否 | 指定的 API 用户，默认为 all |
| offset | int | 否 | 起始位置 [0-]，默认为 0 |
| limit | int | 否 | 数量 [0-100]，默认为 100 |
提示：
- 查询的天数不超过三个月.。
- 使用给定的电子邮件地址进行搜索时，时间区间参数失效。
请求示例：
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
此代码块在浮窗中显示
返回值说明
| 参数 | 描述 |
|---|---|
| 邮件地址 | |
| api_user | API 用户 |
| type | 取消订阅类型 (0, 1, 2, 3) |
| unsubscribe_time | 取消订阅发生的时间 |
| expire_time | 取消订阅拦截的过期时间 |
| 类型 | 描述 |
|---|---|
| 0 | 我不想再收到此类邮件 |
| 1 | 这不是我订阅的 |
| 2 | 这是垃圾邮件 |
| 3 | 这是欺诈邮件，我想举报 |
返回值示例：
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
此代码块在浮窗中显示
添加
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
此代码块在浮窗中显示
Content-Type:
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
此代码块在浮窗中显示
HTTP 请求方法
POST
POST
此代码块在浮窗中显示
Header
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 基本 base64(api_user:api_key) |
请求体参数说明
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| string | 是 | 要添加的邮件地址 | |
| expire_time | string | 是 | 取消订阅拦截的过期时间（格式：yyyy-MM-dd） |
请求示例：
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
此代码块在浮窗中显示
返回值说明
| 参数 | 描述 |
|---|---|
| 邮件地址 | |
| api_user | API_USER |
| unsubscribe_time | 取消订阅时间 |
| expire_time | 过期时间 |
返回值示例：
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
}
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
}
此代码块在浮窗中显示
删除
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
此代码块在浮窗中显示
HTTP 请求方法
DELETE
DELETE
此代码块在浮窗中显示
请求头
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 基本 base64(api_user:api_key) |
请求体参数说明
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| string | * | 要删除的电子邮件地址 | |
| start_date | string | * | 开始日期（格式：yyyy-MM-dd） |
| end_date | string | * | 结束日期（格式：yyyy-MM-dd） |
请求示例：
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
'https://email.api.engagelb.cc/v1/unsubscribes'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
'https://email.api.engagelb.cc/v1/unsubscribes'
此代码块在浮窗中显示
返回值说明
| 参数 | 说明 |
|---|---|
| count | 已删除地址的数量 |
返回值示例：
响应成功
HTTP 状态：200
{
"count": 1
}
{
"count": 1
}
此代码块在浮窗中显示
响应错误
HTTP 状态：401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
此代码块在浮窗中显示
