カスタムインターセプション
悪意のある登録や、特定のアドレスやメールに対して今後メールを送信したくない場合、ドメインまたは特定のメールアドレスをカスタムインターセプションリストに追加することができます。
このリストに含まれるメールアドレスは、システムによってインターセプトされます。
このリスト内のエントリを照会、追加、または削除することができます。
照会
URL
https://email.api.engagelab.cc/v1/blocks
https://email.api.engagelab.cc/v1/blocks
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| 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 |
注意:
- 照会期間は3ヶ月を超えてはなりません。
リクエスト例:
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic 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:Basic 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
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | はい | Basic base64(api_user:api_key) |
ボディパラメータの説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| 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:Basic 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:Basic 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
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | はい | Basic base64(api_user:api_key) |
ボディパラメータの説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| api_user | string | いいえ | インターセプションに関連付けられたAPI_USER |
| email_or_domain | array | はい | インターセプションに関連付けられたドメインまたはメールアドレス |
リクエスト例:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic 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:Basic 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
}
このコードブロックはフローティングウィンドウ内に表示されます
