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
}
此代碼塊在浮窗中顯示
