ยกเลิกการสมัคร

เมื่อผู้ใช้เลือกที่จะยกเลิกการสมัครรับอีเมล ที่อยู่อีเมลของพวกเขาจะถูกเพิ่มในรายการนี้

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

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

การค้นหา

URL

https://email.api.engagelab.cc/v1/unsubscribes

              
              https://email.api.engagelab.cc/v1/unsubscribes

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

วิธีการร้องขอ HTTP

GET

GET

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

ส่วนหัว

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	ใช่	Basic base64(api_user:api_key)

คำอธิบายพารามิเตอร์การค้นหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
start_date	string	*	วันที่เริ่มต้น (รูปแบบ: yyyy-MM-dd)
end_date	string	*	วันที่สิ้นสุด (รูปแบบ: yyyy-MM-dd)
email	string	*	ที่อยู่อีเมล เช่น `22@gmail.com`
api_user	string	ไม่	ผู้ใช้ API ที่ระบุ ค่าเริ่มต้นคือ `all`
offset	int	ไม่	ตำแหน่งเริ่มต้น [0-] ค่าเริ่มต้นคือ 0
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/unsubscribes?offset=0&limit=30'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'

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

คำอธิบายการตอบกลับ

พารามิเตอร์	คำอธิบาย
email	ที่อยู่อีเมล
api_user	ผู้ใช้ API
type	ประเภทการยกเลิกการสมัคร (0, 1, 2, 3)
unsubscribe_time	เวลาที่เกิดการยกเลิกการสมัคร
expire_time	เวลาหมดอายุของการบล็อกการยกเลิกการสมัคร

ประเภท	คำอธิบาย
0	ฉันไม่ต้องการรับอีเมลประเภทนี้อีกต่อไป
1	นี่ไม่ใช่สิ่งที่ฉันสมัครรับ
2	นี่คือสแปม
3	นี่คืออีเมลหลอกลวง ฉันต้องการรายงาน

ตัวอย่างการตอบกลับ:

{ "result": [ { "email": "524244185@qq.com", "unsubscribe_time": "2021-01-12T17:03:23+08:00", "expire_time": "2023-01-12T17:03:23+08:00", "api_user": "delong_test", "type": 0 } ], "count": 1, "total": 1 }

              
              {
  "result": [
    {
      "email": "524244185@qq.com",
      "unsubscribe_time": "2021-01-12T17:03:23+08:00",
      "expire_time": "2023-01-12T17:03:23+08:00",
      "api_user": "delong_test",
      "type": 0
    }
  ],
  "count": 1,
  "total": 1
}

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

เพิ่ม

URL

https://email.api.engagelab.cc/v1/unsubscribes

              
              https://email.api.engagelab.cc/v1/unsubscribes

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

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: application/json;charset=utf-8

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

วิธีการร้องขอ HTTP

POST

              
              POST

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

ส่วนหัว

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	ใช่	Basic base64(api_user:api_key)

คำอธิบายพารามิเตอร์ในเนื้อหาคำร้องขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
email	string	ใช่	ที่อยู่อีเมลที่จะเพิ่ม
expire_time	string	ใช่	เวลาหมดอายุของการบล็อกการยกเลิกการสมัคร (รูปแบบ: yyyy-MM-dd)

ตัวอย่างการร้องขอ:

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}' 'https://email.api.engagelab.cc/v1/unsubscribes'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
     'https://email.api.engagelab.cc/v1/unsubscribes'

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

คำอธิบายการตอบกลับ

พารามิเตอร์	คำอธิบาย
email	ที่อยู่อีเมล
api_user	API_USER
unsubscribe_time	เวลาที่เกิดการยกเลิกการสมัคร
expire_time	เวลาหมดอายุ

ตัวอย่างการตอบกลับ:

{ "result": { "email": "abc@qq.com", "api_user": "api_user", "unsubscribe_time": "2014-11-19 10:57:24", "expire_time": "2014-11-19 10:57:24" }

              
              {
    "result": {
        "email": "abc@qq.com",
        "api_user": "api_user",
        "unsubscribe_time": "2014-11-19 10:57:24",
        "expire_time": "2014-11-19 10:57:24"
    }

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

ลบ

URL

https://email.api.engagelab.cc/v1/unsubscribes

              
              https://email.api.engagelab.cc/v1/unsubscribes

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

วิธีการร้องขอ HTTP

DELETE

              
              DELETE

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

ส่วนหัว

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	ใช่	Basic base64(api_user:api_key)

คำอธิบายพารามิเตอร์ในเนื้อหาคำร้องขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
email	string	*	ที่อยู่อีเมลที่จะลบ
start_date	string	*	วันที่เริ่มต้น (รูปแบบ: yyyy-MM-dd)
end_date	string	*	วันที่สิ้นสุด (รูปแบบ: yyyy-MM-dd)

ตัวอย่างการร้องขอ:

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}' 'https://email.api.engagelab.cc/v1/unsubscribes'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
     'https://email.api.engagelab.cc/v1/unsubscribes'

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

คำอธิบายการตอบกลับ

พารามิเตอร์	คำอธิบาย
count	จำนวนที่อยู่อีเมลที่ถูกลบ

ตัวอย่างการตอบกลับ:

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-error

HTTP Status: 401

{ "code": 30000, "message": "Authentication failed." }

              
              {
    "code": 30000,
    "message": "Authentication failed."
}

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