AppPush
WebPush
WhatsApp
Email
SMS
OTP
自定義攔截
最新更新：2023-08-10
如果您遇到了惡意註冊，某些地址或郵箱後續不想再發信，可將域名或具體郵箱地址添加到自定義攔截中。
在此列表中的郵件地址, 會被系統攔截。
你可以對此列表進行查詢，添加、刪除操作。
查詢
URL
https://email.api.engagelab.cc/v1/blocks
https://email.api.engagelab.cc/v1/blocks
此代碼塊在浮窗中顯示
HTTP 請求方法
GET
GET
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | Basic base64(api_user:api_key) |
查詢參數描述
| 參數 | 類型 | 是否必需 | 描述 |
|---|---|---|---|
| start_date | string | * | 開始日期，格式為 yyyy-MM-dd |
| end_date | string | * | 結束日期，格式為 yyyy-MM-dd |
| email_or_domain | string | * | 電子郵件或域名（例如，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/blocks?offset=0&limit=1'
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/blocks?offset=0&limit=1'
此代碼塊在浮窗中顯示
返回值描述
| 參數 | 描述 |
|---|---|
| api_user | 攔截關聯的API_USER |
| email_or_domain | 攔截關聯的電子郵件或域名 |
| create_time | 創建時間 |
| expire_time | 過期時間 |
返回值示例
{
"result": [
{
"block_id": 122,
"api_user": "all",
"email_or_domain": "11@gmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"block_id": 123,
"api_user": "all",
"email_or_domain": "hotmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"block_id": 124,
"api_user": "all",
"email_or_domain": "22@yahoo.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
}
],
"count": 3,
"total": 10
}
{
"result": [
{
"block_id": 122,
"api_user": "all",
"email_or_domain": "11@gmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"block_id": 123,
"api_user": "all",
"email_or_domain": "hotmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"block_id": 124,
"api_user": "all",
"email_or_domain": "22@yahoo.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
}
],
"count": 3,
"total": 10
}
此代碼塊在浮窗中顯示
添加
URL
https://email.api.engagelab.cc/v1/blocks
https://email.api.engagelab.cc/v1/blocks
此代碼塊在浮窗中顯示
HTTP 請求方法
POST
POST
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | Basic base64(api_user:api_key) |
Body 參數描述
| 參數 | 類型 | 是否必需 | 描述 |
|---|---|---|---|
| api_user | string | 否 | 攔截關聯的 API_USER，默認為 all |
| email_or_domain | array | 是 | 電子郵件或域名的數組（例如，["11@gmail.com","hotmail.com","22@yahoo.com"]） |
| expire_time | string | 是 | 過期時間，格式為 yyyy-MM-dd |
請求示例:
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/blocks'
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"api_user": "123456abc","email_or_domain": ["11@gmail.com","hotmail.com","22@yahoo.com"],"expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/blocks'
此代碼塊在浮窗中顯示
返回值描述
| 參數 | 描述 |
|---|---|
| api_user | 攔截關聯的 API_USER |
| email_or_domain | 電子郵件或域名 |
| create_time | 創建時間 |
| expire_time | 過期時間 |
返回值示例
{
"result": [
{
"api_user": "all",
"email_or_domain": "11@gmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"api_user": "all",
"email_or_domain": "hotmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"api_user": "all",
"email_or_domain": "22@yahoo.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
}
]
}
{
"result": [
{
"api_user": "all",
"email_or_domain": "11@gmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"api_user": "all",
"email_or_domain": "hotmail.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
},{
"api_user": "all",
"email_or_domain": "22@yahoo.com",
"create_time": "2021-03-01 17:24:34",
"expire_time": "2021-10-01 00:00:00"
}
]
}
此代碼塊在浮窗中顯示
刪除
URL
https://email.api.engagelab.cc/v1/blocks
https://email.api.engagelab.cc/v1/blocks
此代碼塊在浮窗中顯示
HTTP 請求方式
DELETE
DELETE
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | Basic base64(api_user:api_key) |
Body 參數描述
| 參數 | 類型 | 是否必需 | 描述 |
|---|---|---|---|
| api_user | string | 否 | 攔截關聯的 API_USER |
| email_or_domain | array | 是 | 攔截關聯的域名或郵件地址 |
請求示例：
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}'
'https://email.api.engagelab.cc/v1/blocks'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization: YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"api_user":"123456abc","email_or_domain":["xjmfc@example.com","gmail.com"]}'
'https://email.api.engagelab.cc/v1/blocks'
此代碼塊在浮窗中顯示
返回值說明
| 參數 | 描述 |
|---|---|
| count | 成功刪除的個數 |
返回值示例
{
"count": 1
}
{
"count": 1
}
此代碼塊在浮窗中顯示
