AppPush
WebPush
WhatsApp
Email
SMS
OTP
发送免拦截
最新更新：2023-08-10
EngageLab 会对在垃圾举报、自定义拦截、退信地址、取消订阅里的邮件地址进行拦截。
如果客户不想拦截某个地址或接收域，可以将其加入免拦截。
你可以对此列表进行查询，添加，删除操作。
查询
URL
https://email.api.engagelab.cc/v1/no_interceptions
https://email.api.engagelab.cc/v1/no_interceptions
此代码块在浮窗中显示
HTTP 请求方式
GET
GET
此代码块在浮窗中显示
Header
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
查询参数描述
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| start_date | string | * | 开始日期，格式为 yyyy-MM-dd |
| end_date | string | * | 结束日期，格式为 yyyy-MM-dd |
| email_or_domain | string | * | 免拦截的email地址或域名（例如，11@gmail.com、hotmail.com） |
| api_user | string | 否 | 免拦截关联的 API_USER，默认为 all |
| offset | int | 否 | 查询位置, 取值区间[0-100]，默认为 100 |
| limit | int | 否 | 查询个数，取值区间 [0-100]，默认为 100 |
请求示例:
curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/no_interceptions'
curl -X GET -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
'https://email.api.engagelab.cc/v1/no_interceptions'
此代码块在浮窗中显示
返回值说明
| 参数 | 描述 |
|---|---|
| api_user | 免拦截关联的 API_USER |
| email_or_domain | email地址或接受域域名 |
| create_time | 创建时间 |
返回值示例
{
"result": [
{
"api_user": "all",
"email_or_domain": "wbw@hotmail.com",
"create_time": "2021-07-15 15:32:03"
}
],
"count": 1,
"total": 1
}
{
"result": [
{
"api_user": "all",
"email_or_domain": "wbw@hotmail.com",
"create_time": "2021-07-15 15:32:03"
}
],
"count": 1,
"total": 1
}
此代码块在浮窗中显示
添加
URL
https://email.api.engagelab.cc/v1/no_interceptions
https://email.api.engagelab.cc/v1/no_interceptions
此代码块在浮窗中显示
HTTP 请求方式
POST
POST
此代码块在浮窗中显示
请求头
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
请求体参数描述
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| api_user | string | 否 | 无拦截 API_USER，默认为 all |
| email_or_domain | array | 是 | 免拦截email地址或接收域域名 |
请求示例:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"api_user": "123456abc", "email_or_domain": ["qq.com","22@gmail.com"]}' \
'https://email.api.engagelab.cc/v1/no_interceptions'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"api_user": "123456abc", "email_or_domain": ["qq.com","22@gmail.com"]}' \
'https://email.api.engagelab.cc/v1/no_interceptions'
此代码块在浮窗中显示
返回值描述
| 参数 | 描述 |
|---|---|
| api_user | 免拦截关联的 API_USER |
| email_or_domain | email地址或接收域域名 |
| create_time | 创建时间 |
返回值示例
{
"result": [{
"api_user": "all",
"email_or_domain": "qq.com",
"create_time": "2021-07-19 11:30:00"
},{
"api_user": "all",
"email_or_domain": "22@gmail.com",
"create_time": "2021-07-19 11:30:00"
}
]
}
{
"result": [{
"api_user": "all",
"email_or_domain": "qq.com",
"create_time": "2021-07-19 11:30:00"
},{
"api_user": "all",
"email_or_domain": "22@gmail.com",
"create_time": "2021-07-19 11:30:00"
}
]
}
此代码块在浮窗中显示
删除
URL
https://email.api.engagelab.cc/v1/no_interceptions
https://email.api.engagelab.cc/v1/no_interceptions
此代码块在浮窗中显示
HTTP 请求方式
DELETE
DELETE
此代码块在浮窗中显示
Header
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
请求体参数描述
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| api_user | string | 否 | 免拦截关联的 API_USER |
| email_or_domain | array | 是 | 免拦截email地址或接收域域名 |
请求示例:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"api_user": "123456abc", "email_or_domain": ["qq.com","22@gmail.com"]}' \
'https://email.api.engagelab.cc/v1/no_interceptions'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"api_user": "123456abc", "email_or_domain": ["qq.com","22@gmail.com"]}' \
'https://email.api.engagelab.cc/v1/no_interceptions'
此代码块在浮窗中显示
返回值描述
| 参数 | 描述 |
|---|---|
| count | 成功删除的个数 |
返回值示例
{
"count": 1
}
{
"count": 1
}
此代码块在浮窗中显示
删除无拦截
URL
https://email.api.engagelab.cc/v1/no_interceptions
https://email.api.engagelab.cc/v1/no_interceptions
此代码块在浮窗中显示
HTTP 请求方法
DELETE
DELETE
此代码块在浮窗中显示
请求头
| Header | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
请求体参数描述
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| api_user | string | 否 | 免拦截关联的 API_USER |
| email_or_domain | array | 是 | 免拦截email地址或接收域域名 |
请求示例:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"api_user": "123456abc", "email_or_domain": ["qq.com","22@gmail.com"]}' \
'https://email.api.engagelab.cc/v1/no_interceptions'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ==' \
--data '{"api_user": "123456abc", "email_or_domain": ["qq.com","22@gmail.com"]}' \
'https://email.api.engagelab.cc/v1/no_interceptions'
此代码块在浮窗中显示
返回值描述
| 参数 | 描述 |
|---|---|
| count | 成功删除的数量 |
返回值示例
{
"count": 1
}
{
"count": 1
}
此代码块在浮窗中显示
