การสกัดกั้นแบบกำหนดเอง

หากคุณพบการลงทะเบียนที่เป็นอันตรายหรือที่อยู่อีเมลบางรายการที่คุณไม่ต้องการส่งอีเมลอีกต่อไป คุณสามารถเพิ่มโดเมนหรือที่อยู่อีเมลเฉพาะลงในรายการการสกัดกั้นแบบกำหนดเองได้

ที่อยู่อีเมลในรายการนี้จะถูกระบบสกัดกั้น

คุณสามารถค้นหา เพิ่ม หรือลบรายการในรายการนี้ได้

การค้นหา

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

หมายเหตุ:

วันที่ค้นหาไม่ควรเกินสามเดือน

ตัวอย่างคำขอ:

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
}

โค้ดนี้โชว์เป็นหน้าต่างลอย